Skip to content

docs: fix accuracy findings in deployment, usage, auth-flow (v0.9.0 audit) - #247

Merged
ajianaz merged 1 commit into
developfrom
docs/accuracy-ops
Sep 2, 2026
Merged

docs: fix accuracy findings in deployment, usage, auth-flow (v0.9.0 audit)#247
ajianaz merged 1 commit into
developfrom
docs/accuracy-ops

Conversation

@ajianaz

@ajianaz ajianaz commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

What

Second chunk of the v0.9.0 docs accuracy audit (first chunk: #243).

docs/deployment.md

  • .env examples: $(openssl rand -hex ...) replaced with literal placeholders + generate instructions (Compose does not evaluate command substitution); both keys standardized on hex 32
  • chmod 777 datachmod 755 + chown guidance for the container's titen user (UID from Dockerfile)
  • Caddyfile: header_up sub-directives moved inside the reverse_proxy block (they were invalid outside it)
  • systemd example: secrets moved to a root-only EnvironmentFile= (unit files are world-readable); TITEN_ENCRYPTION_KEY added (checklist marks it mandatory)
  • Health checks standardized to /api/health; compose deployments verify via the web proxy on :3000 (API is not host-exposed), native/systemd on :7845
  • All container references match docker-compose.yml (titentiten-api)
  • Backup/restore commands aligned with the ./data bind mount (was targeting a named volume titen_titen-data that compose does not create)
  • Media storage clarified: local storage works out of the box (/data/media); S3 is optional

docs/usage.md

  • Stray curl VIDEO example removed from the "Via CLI" section (the CLI has no video flags; the "Via API" section already documents VIDEO)
  • TITEN_URL annotated: it is the CLI's API base URL (titen-core config ENV_URL), distinct from APP_URL (public site URL) — the scan's "inconsistency" is actually two different vars
  • MCP tools table rebuilt from crates/titen-mcp/src/main.rs tools_list(): 29 tools (was: heading said 14, table listed 13, several names stale — get_account, get_post_analytics do not exist)

docs/auth-flow.md

  • Authorize URL now documents all 8 scopes requested by the app (matches settings.rs authorize_url construction)

docs/architecture.md

Why

Completes the documentation accuracy findings from the v0.9.0 cora scan. Deployment docs that reference a volume compose never creates, invalid Caddyfile syntax, and world-readable secrets in systemd units would actively mislead self-hosters.

Testing

  • awk 'NR>=138' crates/titen-mcp/src/main.rs | grep -cE '"name": "[a-z_]+"' → 29
  • grep -n "scope=" crates/titen-api/src/routes/settings.rs → 8-scope authorize URL
  • grep -n "container_name\|expose:" docker-compose.ymltiten-web/titen-api, API expose: 7845 (not host-published)
  • grep -n "TITEN_LOCAL_STORAGE_DIR" crates/titen-core/src/storage.rs → LocalStorage is a full backend; USER titen in Dockerfile → chmod/chown guidance
  • grep -n "ENV_URL" crates/titen-core/src/config.rsTITEN_URL is the CLI var
  • grep -rn "video" crates/titen-cli/src/commands/post.rs → no video support in CLI
  • Docs-only change: no build required

…udit)

deployment.md: .env examples use literal values (Compose does not evaluate
$(...)), keys standardized on hex 32; chmod 777 -> 755 + chown guidance for
the container user; Caddyfile header_up moved inside reverse_proxy block;
systemd example uses EnvironmentFile for secrets and includes
TITEN_ENCRYPTION_KEY; health checks use /api/health (compose deployments go
through the web proxy on :3000); container refs match docker-compose.yml
(titen-api); backup/restore aligned with the ./data bind mount; local media
storage clarified (S3 optional, not required).

usage.md: stray curl VIDEO example removed from the CLI section (CLI has no
video flags; API section already covers it); TITEN_URL annotated (CLI API
base URL, distinct from APP_URL); MCP tools table rebuilt from
crates/titen-mcp/src/main.rs: 29 tools verified, stale names fixed.

auth-flow.md: authorize URL documents all 8 requested scopes (matches
settings.rs authorize_url construction).

architecture.md: MCP tool count 14 -> 29 (verified against tools_list()).
@github-actions

github-actions Bot commented Sep 2, 2026

Copy link
Copy Markdown

🔍 Cora AI Code Review

No issues found. Code looks good!


Review powered by cora-code · BYOK · MIT

@ajianaz
ajianaz merged commit 361f82c into develop Sep 2, 2026
12 checks passed
@ajianaz
ajianaz deleted the docs/accuracy-ops branch September 2, 2026 06:55
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.

1 participant