e129378014
Document safer defaults and deployment guidance for network-accessible Odysseus installs. The guidance emphasizes keeping auth enabled, disabling localhost bypass outside development, using secure cookies for HTTPS/reverse-proxy deployments, and exposing only the authenticated Odysseus entrypoint through a trusted proxy or private access layer. Also clarify that bundled services, databases, vector stores, notification services, and raw model/provider APIs should remain internal-only. This is documentation and config-example only. It does not change runtime behavior.
41 lines
2.5 KiB
Markdown
41 lines
2.5 KiB
Markdown
# Security Policy
|
|
|
|
Odysseus is a self-hosted AI workspace with privileged local capabilities. Please do not run it as a public, unauthenticated service.
|
|
|
|
## Supported Versions
|
|
|
|
Security fixes are handled on the default branch until formal releases are cut.
|
|
|
|
## Deployment Guidance
|
|
|
|
- Keep `AUTH_ENABLED=true` for any network-accessible deployment.
|
|
- Keep `LOCALHOST_BYPASS=false` outside local development.
|
|
- Set `SECURE_COOKIES=true` when Odysseus is served through HTTPS by a trusted reverse proxy or private access gateway.
|
|
- Use HTTPS when exposing the app beyond localhost.
|
|
- Put the authenticated Odysseus web/API entrypoint behind a trusted reverse proxy or private access layer such as Cloudflare Access, Tailscale, or a VPN.
|
|
- Keep ChromaDB, SearXNG, ntfy, Ollama, vLLM, llama.cpp, databases, and raw model/provider APIs internal-only.
|
|
- Protect `.env`, `data/`, `logs/`, uploads, generated media, backups, auth/session files, database files, API keys, and model/provider tokens.
|
|
- Disable open signup unless you intentionally want new accounts.
|
|
- Keep demo/test users non-admin, and remove them entirely on serious deployments.
|
|
- Give admin accounts strong passwords and enable 2FA where possible.
|
|
- Leave high-risk agent tools restricted to admins: shell, Python, file read/write, email send/read, MCP, app API, task/skill/memory management, settings, tokens, and model serving.
|
|
- Rotate API keys, webhook secrets, and Odysseus API tokens if they appear in logs, screenshots, demos, or shared chats.
|
|
- Treat shell, model-serving, MCP, email, calendar, and vault features as privileged admin functionality.
|
|
- Common internal-only ports are Odysseus `7000`, SearXNG `8080`, ntfy `8091`, ChromaDB `8100`, Ollama `11434`, and local model/provider APIs such as `8000-8020`.
|
|
|
|
## Publishing A Fork
|
|
|
|
Before pushing a public fork, run:
|
|
|
|
```bash
|
|
git status --short
|
|
git check-ignore -v .env data/auth.json data/app.db logs/compound.log odysseus.db
|
|
git grep -n -I -E "(sk-[A-Za-z0-9_-]{20,}|xox[baprs]-|AIza[0-9A-Za-z_-]{20,}|Bearer [A-Za-z0-9._~+/-]{20,})" -- . ':!static/lib/**' ':!package-lock.json'
|
|
```
|
|
|
|
Only `.env.example`, docs, source, tests, and static assets should be committed. Never commit live `.env` values, `data/` contents, local databases, uploaded files, generated media, logs, backups, auth/session files, API keys, model/provider tokens, password hashes, or personal documents.
|
|
|
|
## Reporting
|
|
|
|
Please report vulnerabilities privately via GitHub security advisories if available, or by opening a minimal issue that does not disclose exploit details.
|