Skip to content

docs: improve README #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
webbrain-one wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: improve README #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@


<div align="center">
<h1>🤝 Contrack</h1>
<p><b>People Relationship Manager for Proactive Networking</b></p>
Expand Down Expand Up @@ -243,7 +245,7 @@ Full documentation lives in the [`docs/`](docs/) directory:
| `PORT` | Express listening port | `3210` |
| `HOST` | Bind interface (`0.0.0.0` to expose on LAN) | `127.0.0.1` |
| `AUTH_REQUIRED` | `true` = require sign-in with an account | `false` |
| `API_TOKEN` | Machine credential for scripts/MCP (`Bearer`); also gates | — (off) |
| `API_TOKEN` | Machine credential for scripts/MCP (`Bearer`); also gates API access | — (off) |
| `DATA_DIR` | Root for runtime data (DB, uploads, backups, model cache) | project root |
| `MAPBOX_API_KEY` | Mapbox geocoding (optional, higher accuracy) | — |
| `BACKUP_INTERVAL_HOURS` | Hours between automatic DB snapshots (`0` disables) | `24` |
Expand Down