Skip to content

SUPPORT.md

Latest commit

 

History

History
101 lines (71 loc) · 3.95 KB

SUPPORT.md

File metadata and controls

101 lines (71 loc) · 3.95 KB

Nora Start Paths

Use this page to pick the fastest open-source route for your situation.

1. Self-serve install and launch

Start here if you want to self-host Nora and bring it online on your own infrastructure.

Best fit:

  • you want the cleanest trust path
  • you are comfortable operating Docker / Compose
  • you want to bring account creation, provider setup, and first agent deployment online yourself

2. Bugs and product issues

Use GitHub Issues when something appears broken in the product or docs.

Best fit:

  • reproducible bugs
  • documentation errors
  • install failures with concrete logs or steps to reproduce

3. Public site, login, and signup

Use the default public browser entry when you want to see the reference deployment or create an operator account quickly.

Best fit:

  • you want the default public browser entry
  • you want to check the login or signup flow
  • you want a quick public reference deployment before self-hosting

4. Discussions and implementation questions

Use GitHub Discussions for setup questions, design discussion, product direction, and implementation tradeoffs around the OSS product.

Best fit:

  • setup guidance
  • onboarding questions
  • deployment review
  • architecture discussion
  • runtime or product-direction questions

5. Licensing, self-hosting, and PaaS mode

Use the public OSS and licensing page when you need the short version of what Apache 2.0 allows or when you want to run Nora in PaaS mode for your own business.

Best fit:

  • you want to confirm commercial usage rights
  • you want to run Nora as your own hosted product or internal platform
  • you need the difference between selfhosted and paas
  • you want the public repo and public site entry points in one place

6. Security vulnerabilities

Use the private reporting path in SECURITY.md if you believe you found a vulnerability.

Best fit:

  • security bugs with real impact
  • unsafe defaults or exposure paths
  • credential handling issues
  • auth, session, tenant-isolation, or sandbox escape concerns

What to include when asking for help

To reduce back-and-forth, include:

  • your deployment mode: self-hosted, public browser entry, or self-run PaaS mode
  • OS and environment details
  • whether you used setup.sh, setup.ps1, or manual setup
  • whether Nora is running in local mode, public-domain proxy mode, or public-domain TLS mode
  • whether you are using PLATFORM_MODE=selfhosted or PLATFORM_MODE=paas
  • the step that failed or slowed you down
  • relevant logs or screenshots

Security note

Do not post secrets, API keys, .env files, or private credentials in Issues or Discussions. If the problem may be a vulnerability, use SECURITY.md instead of a public thread.

If you are unsure where to start: