Skip to content

docs: describe access with and without Tailscale - #6

Merged
meltforce merged 1 commit into
mainfrom
claude/pensive-franklin-hx4mmw
Nov 13, 2026
Merged

meltforce merged 1 commit into
mainfrom
claude/pensive-franklin-hx4mmw

Conversation

@meltforce

Copy link
Copy Markdown
Owner

The README still described Tailscale as the only way in and dated from before the LLM keys moved into the database.

Acceptance criteria

  1. The quick-start config.yaml starts a container that serves http://localhost:8080 (sets tailscale.enabled: false; the default is true, which makes tsnet wait for a login).
  2. No README or compose.example.yml text tells the user to put LLM API keys into config.yaml; they go into Settings → LLM.
  3. The README describes the four combinations of Tailscale on/off and auth: present/absent, password and OIDC setup (first admin, redirect URI, account policy), sessions/sign-out and personal access tokens.
  4. Karakeep setup, /submit, RSS and MCP no longer name Tailscale as the only identity; the environment variables for secrets are stated correctly (VIMMARY_POSTGRES_PASSWORD, VIMMARY_OIDC_CLIENT_SECRET take precedence).

Test per criterion

Documentation only, no test. Each statement was checked against the code:

  1. internal/config/config.go Load (default Tailscale.Enabled: true), cmd/vimmary/main.go openListener.
  2. grep -rn "mistral_api_key\|claude_api_key" --include=*.go — only the settings table and the Settings handler, no ResolveSecret.
  3. internal/server/account_handlers.go (identity, tailnetFallback, mcpIdentity), internal/service/accounts.go (IsAdmin, Resolve, policies), cmd/vimmary/command.go (auth create-user, auth create-token), meltkit pkg/auth v0.4.0 (/auth/oidc/callback, base_url rules).
  4. meltkit pkg/secrets.Resolver.ResolveSecret (environment first), internal/server/server.go (/submit redirects to /login).

Test output

No code changed; not run.

Production changes

None


Generated by Claude Code

The README still described Tailscale as the only way in and predated the
move of the LLM keys into the database:

- The quick-start config left tailscale.enabled at its default (true), so
  the container waited for a Tailscale login instead of serving port 8080.
- It put mistral_api_key and claude_api_key into secrets:, which nothing
  reads any more; the keys are entered in Settings > LLM.
- It said secrets are not read from the environment, but
  VIMMARY_POSTGRES_PASSWORD and VIMMARY_OIDC_CLIENT_SECRET take precedence.
- Karakeep setup, /submit and MCP named Tailscale as the only identity.

New section "Access and login": the four combinations of tsnet and an auth:
block, password and OIDC setup, the first admin, account policy, sessions,
sign-out and personal access tokens. The quick start now says plainly that
it runs without access control. compose.example.yml's header pointed at
secrets.claude_api_key as well.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01SeJSujmvufZJQEtybU47wJ
@meltforce
meltforce enabled auto-merge (squash) November 13, 2026 16:36
@github-actions

Copy link
Copy Markdown

Review: approve

Commit af36af6

This PR only changes the README and one comment line in compose.example.yml. The README now says the quick start serves plain HTTP on localhost:8080 (it sets tailscale.enabled: false). It tells the user to enter LLM API keys under Settings → LLM, not in config.yaml. It adds an "Access and login" section covering the four Tailscale on/off and auth: present/absent combinations, password and OIDC setup, sessions and sign-out, and personal access tokens. It also corrects the Karakeep, /submit, RSS and MCP text so they no longer name Tailscale as the only way in. I spot-checked the compose service name and port against the README and they match. No code, migration, config or check changes are involved. The PR says no tests were run, which is honest for a docs-only change, so I did not treat the missing tests as a blocker. Nothing is needed in the homelab repo.

@meltforce
meltforce merged commit 2454530 into main Nov 13, 2026
4 of 6 checks passed
@meltforce
meltforce deleted the claude/pensive-franklin-hx4mmw branch November 13, 2026 16:39
@github-actions

Copy link
Copy Markdown

live: 2454530 is deployed to production (run).

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.

2 participants