Skip to content

docs: add auth requirement and self-signed cert warning to quick-start#481

Open
JDis03 wants to merge 1 commit into
NeuralNomadsAI:devfrom
JDis03:docs/quick-start-auth-and-cert-468-470
Open

docs: add auth requirement and self-signed cert warning to quick-start#481
JDis03 wants to merge 1 commit into
NeuralNomadsAI:devfrom
JDis03:docs/quick-start-auth-and-cert-468-470

Conversation

@JDis03
Copy link
Copy Markdown

@JDis03 JDis03 commented May 18, 2026

Summary

Fixes #468 and #470. The quick-start examples crashed on first run without a password, and the browser self-signed certificate warning was not documented anywhere a new user would see it.

Changes

  • Add --password to all npx quick-start examples (main README + server README)
  • Document the three ways to configure auth: --password, env var, auth.json
  • Show auth.json schema so users understand the expected format
  • Add browser warning note to self-signed certificates section with step-by-step instructions for Chrome/Brave and Firefox
  • Mention --https=false --http=true as an alternative for local-only use

Validation

  • Reviewed rendered markdown structure
  • Verified auth.json schema matches AuthFile interface in auth-store.ts

Fixes NeuralNomadsAI#468 and NeuralNomadsAI#470. The quick-start examples crashed on first run
without a password, and the browser self-signed certificate warning
was not documented anywhere a new user would see it.

Changes:
- Add --password to all npx quick-start examples (main README + server README)
- Document the three ways to configure auth: --password, env var, auth.json
- Show auth.json schema so users understand the expected format
- Add browser warning note to self-signed certificates section with
  step-by-step instructions for Chrome/Brave and Firefox
- Mention --https=false --http=true as an alternative for local-only use

Validation:
- Reviewed rendered markdown structure
- Verified auth.json schema matches AuthFile interface in auth-store.ts
@github-actions
Copy link
Copy Markdown

PR builds are available as GitHub Actions artifacts:

https://github.com/NeuralNomadsAI/CodeNomad/actions/runs/26040413596

Artifacts expire in 7 days.
Artifacts:

  • pr-481-000e95e130a5263c8903e8c48490684982a5aa23-tauri-macos
  • pr-481-000e95e130a5263c8903e8c48490684982a5aa23-tauri-linux
  • pr-481-000e95e130a5263c8903e8c48490684982a5aa23-electron-macos
  • pr-481-000e95e130a5263c8903e8c48490684982a5aa23-tauri-windows
  • pr-481-000e95e130a5263c8903e8c48490684982a5aa23-tauri-macos-arm64
  • pr-481-000e95e130a5263c8903e8c48490684982a5aa23-electron-windows
  • pr-481-000e95e130a5263c8903e8c48490684982a5aa23-electron-linux

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs]: Quick-start examples missing required auth setup

1 participant