Compare commits
12
Commits
v0.1.0
...
b1e5aaf908
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
b1e5aaf908 | ||
|
|
244fe525dd | ||
|
|
8c88748f50 | ||
|
|
65879e8659 | ||
|
|
d0c0d98307 | ||
|
|
b7b4c31296 | ||
|
|
3b80034f0e | ||
|
|
6b0f28cf74 | ||
|
|
8278d96875 | ||
|
|
45719f284c | ||
|
|
a114a7d3d8 | ||
|
|
32037b1190 |
@@ -2,6 +2,7 @@ name: Release image
|
|||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
|
branches: [main]
|
||||||
tags: ['v*']
|
tags: ['v*']
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
|
|
||||||
@@ -12,31 +13,60 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
|
# driver: docker (not the action's default docker-container driver) so buildx reuses the
|
||||||
|
# host's own dockerd instead of spinning up an isolated builder container — the isolated
|
||||||
|
# one doesn't see the host's /etc/docker/certs.d, which is how the login step below trusts
|
||||||
|
# the registry's self-signed cert (docs/DECISIONS.md D17). We don't need multi-platform
|
||||||
|
# builds, so nothing the docker-container driver offers is actually lost here.
|
||||||
- uses: docker/setup-buildx-action@v3
|
- uses: docker/setup-buildx-action@v3
|
||||||
|
with:
|
||||||
|
driver: docker
|
||||||
|
|
||||||
# secrets.GITEA_TOKEN cannot push to the Gitea container registry — a documented Gitea
|
# secrets.GITEA_TOKEN cannot push to the Gitea container registry — a documented Gitea
|
||||||
# limitation, not a misconfiguration (see CLAUDE.md). REGISTRY_TOKEN is a separate PAT with
|
# limitation, not a misconfiguration (see CLAUDE.md). REGISTRY_TOKEN is a separate PAT with
|
||||||
# package:write, expected to already exist as a repo secret.
|
# package:write, expected to already exist as a repo secret.
|
||||||
|
#
|
||||||
|
# registry.bbergle.com:9537, not the raw 192.168.0.3:3000 Gitea talks HTTP on directly —
|
||||||
|
# Docker refuses any non-localhost registry over plain HTTP by default. This hostname is an
|
||||||
|
# NPMplus proxy host in front of Gitea's registry, terminating TLS with a self-signed cert;
|
||||||
|
# the runner host trusts it via /etc/docker/certs.d/registry.bbergle.com:9537/ca.crt (not
|
||||||
|
# committed here — host-local trust material, docs/DECISIONS.md D17 has the full setup).
|
||||||
- uses: docker/login-action@v3
|
- uses: docker/login-action@v3
|
||||||
with:
|
with:
|
||||||
registry: 192.168.0.3:3000
|
registry: registry.bbergle.com:9537
|
||||||
username: BBergle
|
username: BBergle
|
||||||
password: ${{ secrets.REGISTRY_TOKEN }}
|
password: ${{ secrets.REGISTRY_TOKEN }}
|
||||||
|
|
||||||
- name: Resolve image tag
|
# `latest` should only ever mean "what's actually on main" (or a tagged release) — not
|
||||||
|
# whatever a manual test dispatch off some feature branch happened to build. Learned the
|
||||||
|
# hard way: a manual dispatch off this very branch, while verifying the fix above, silently
|
||||||
|
# overwrote `latest` under the old unconditional-tags logic. Building the full tag list here
|
||||||
|
# in bash (rather than a conditional expression inline in the tags: block below) means there's
|
||||||
|
# never a blank line for build-push-action to choke on when latest isn't included.
|
||||||
|
- name: Resolve image tags
|
||||||
id: tag
|
id: tag
|
||||||
run: |
|
run: |
|
||||||
|
IMG=registry.bbergle.com:9537/bbergle/bike-app
|
||||||
if [ "${{ gitea.ref_type }}" = "tag" ]; then
|
if [ "${{ gitea.ref_type }}" = "tag" ]; then
|
||||||
echo "value=${{ gitea.ref_name }}" >> "$GITHUB_OUTPUT"
|
VALUE="${{ gitea.ref_name }}"
|
||||||
|
UPDATE_LATEST=true
|
||||||
|
elif [ "${{ gitea.ref_name }}" = "main" ] && [ "${{ gitea.event_name }}" = "push" ]; then
|
||||||
|
VALUE="main-$(git rev-parse --short HEAD)"
|
||||||
|
UPDATE_LATEST=true
|
||||||
else
|
else
|
||||||
echo "value=manual-$(date -u +%Y%m%d%H%M%S)" >> "$GITHUB_OUTPUT"
|
VALUE="manual-$(date -u +%Y%m%d%H%M%S)-$(git rev-parse --short HEAD)"
|
||||||
|
UPDATE_LATEST=false
|
||||||
fi
|
fi
|
||||||
|
{
|
||||||
|
echo "tags<<EOF"
|
||||||
|
echo "$IMG:$VALUE"
|
||||||
|
[ "$UPDATE_LATEST" = true ] && echo "$IMG:latest"
|
||||||
|
echo "EOF"
|
||||||
|
} >> "$GITHUB_OUTPUT"
|
||||||
|
|
||||||
- uses: docker/build-push-action@v6
|
- uses: docker/build-push-action@v6
|
||||||
with:
|
with:
|
||||||
context: .
|
context: .
|
||||||
file: Dockerfile
|
file: Dockerfile
|
||||||
push: true
|
push: true
|
||||||
tags: |
|
tags: ${{ steps.tag.outputs.tags }}
|
||||||
192.168.0.3:3000/bbergle/bike-app:latest
|
|
||||||
192.168.0.3:3000/bbergle/bike-app:${{ steps.tag.outputs.value }}
|
|
||||||
|
|||||||
@@ -15,6 +15,12 @@ dependencies = [
|
|||||||
"uuid6>=2024.7.10",
|
"uuid6>=2024.7.10",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
[project.scripts]
|
||||||
|
# Installs into the venv's bin/ next to `alembic` and `uvicorn`, which deploy/entrypoint.sh
|
||||||
|
# already invokes by their installed script names — so `docker exec velodrome velodrome ...` works
|
||||||
|
# against the deployed image with no extra wiring (the Dockerfile puts /app/.venv/bin on PATH).
|
||||||
|
velodrome = "velodrome.cli:main"
|
||||||
|
|
||||||
[project.optional-dependencies]
|
[project.optional-dependencies]
|
||||||
dev = [
|
dev = [
|
||||||
"ruff>=0.7",
|
"ruff>=0.7",
|
||||||
|
|||||||
@@ -0,0 +1,308 @@
|
|||||||
|
"""Tests for the operator CLI (`velodrome create-admin`).
|
||||||
|
|
||||||
|
These drive `cli.run()` directly against the same real SQLite database and real Argon2id hashing
|
||||||
|
every other test uses — no mocks, per CLAUDE.md's test policy. That matters more than usual here:
|
||||||
|
this command is the only way to create the first account on a fresh deployment, it is run exactly
|
||||||
|
once by a human who has no way to debug it, and the failure mode of "it printed success but the
|
||||||
|
password doesn't actually work" is indistinguishable from a broken deployment. So the central test
|
||||||
|
below doesn't assert on a return code — it creates an admin through the CLI and then logs in as
|
||||||
|
that admin over HTTP, proving the hash the CLI wrote is one the login path accepts.
|
||||||
|
|
||||||
|
The other thing under test is what the CLI *refuses* to do: overwrite an existing account, and
|
||||||
|
echo a rejected password back to the terminal (CLAUDE.md invariant #5).
|
||||||
|
"""
|
||||||
|
|
||||||
|
import io
|
||||||
|
import sys
|
||||||
|
import tomllib
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
import httpx
|
||||||
|
import pytest
|
||||||
|
from sqlalchemy import text
|
||||||
|
from sqlalchemy.ext.asyncio import AsyncSession
|
||||||
|
|
||||||
|
from velodrome import cli
|
||||||
|
from velodrome.models import ROLE_ADMIN, ROLE_MEMBER
|
||||||
|
|
||||||
|
_PASSWORD = "correct horse battery staple"
|
||||||
|
_OTHER_PASSWORD = "an entirely different passphrase"
|
||||||
|
|
||||||
|
|
||||||
|
class _FakeTty:
|
||||||
|
"""Stands in for `sys.stdin` attached to a terminal, so `_read_password` takes the prompt
|
||||||
|
branch rather than the pipe branch. `readline` raises rather than returning a value: if the
|
||||||
|
prompt path ever silently starts reading stdin instead of calling getpass, that's a behaviour
|
||||||
|
change this should fail on, not absorb."""
|
||||||
|
|
||||||
|
def isatty(self) -> bool:
|
||||||
|
return True
|
||||||
|
|
||||||
|
def readline(self) -> str:
|
||||||
|
raise AssertionError("the prompt path must not read stdin directly")
|
||||||
|
|
||||||
|
|
||||||
|
def _pipe(password: str, *, newline: str = "\n") -> io.StringIO:
|
||||||
|
"""stdin as a pipe (isatty() is False on StringIO), carrying one line."""
|
||||||
|
return io.StringIO(f"{password}{newline}")
|
||||||
|
|
||||||
|
|
||||||
|
async def test_create_admin_creates_an_account_that_can_actually_log_in(
|
||||||
|
client: httpx.AsyncClient, db_auth: AsyncSession, monkeypatch: pytest.MonkeyPatch
|
||||||
|
) -> None:
|
||||||
|
"""The load-bearing test: bootstrap an admin through the CLI, then log in as them over HTTP.
|
||||||
|
|
||||||
|
This is deliberately an end-to-end assertion rather than "did a row appear with a hash in it".
|
||||||
|
The whole point of the command is to produce working credentials on a deployment where nobody
|
||||||
|
can yet log in to check, so the only assertion worth making is that the credentials work
|
||||||
|
through the same endpoint a real operator would use next.
|
||||||
|
"""
|
||||||
|
monkeypatch.setattr(sys, "stdin", _pipe(_PASSWORD))
|
||||||
|
code = await cli.run(
|
||||||
|
["create-admin", "--email", "boss@example.com", "--name", "Boss", "--password-stdin"]
|
||||||
|
)
|
||||||
|
assert code == 0
|
||||||
|
|
||||||
|
resp = await client.post(
|
||||||
|
"/api/v1/auth/login", json={"email": "boss@example.com", "password": _PASSWORD}
|
||||||
|
)
|
||||||
|
assert resp.status_code == 200, resp.text
|
||||||
|
assert "vd_session" in resp.cookies
|
||||||
|
|
||||||
|
me = await client.get("/api/v1/auth/me")
|
||||||
|
assert me.status_code == 200
|
||||||
|
assert me.json()["email"] == "boss@example.com"
|
||||||
|
assert me.json()["display_name"] == "Boss"
|
||||||
|
|
||||||
|
|
||||||
|
async def test_create_admin_records_the_admin_role(
|
||||||
|
db_auth: AsyncSession, monkeypatch: pytest.MonkeyPatch
|
||||||
|
) -> None:
|
||||||
|
"""The role is the one thing that distinguishes this from registration, and nothing enforces
|
||||||
|
it yet (docs/DECISIONS.md D17) — so nothing else in the suite would notice if it silently
|
||||||
|
wrote `member`. Asserted against the stored column directly, and against ROLE_MEMBER too, so
|
||||||
|
this fails loudly rather than passing vacuously if the default ever changes."""
|
||||||
|
monkeypatch.setattr(sys, "stdin", _pipe(_PASSWORD))
|
||||||
|
assert await cli.run(["create-admin", "--email", "boss@example.com", "--password-stdin"]) == 0
|
||||||
|
|
||||||
|
role = (
|
||||||
|
await db_auth.execute(
|
||||||
|
text("SELECT role FROM users WHERE email = :email"), {"email": "boss@example.com"}
|
||||||
|
)
|
||||||
|
).scalar_one()
|
||||||
|
await db_auth.commit()
|
||||||
|
assert role == ROLE_ADMIN
|
||||||
|
assert role != ROLE_MEMBER
|
||||||
|
|
||||||
|
|
||||||
|
async def test_create_admin_defaults_display_name_to_the_email_local_part(
|
||||||
|
db_auth: AsyncSession, monkeypatch: pytest.MonkeyPatch
|
||||||
|
) -> None:
|
||||||
|
monkeypatch.setattr(sys, "stdin", _pipe(_PASSWORD))
|
||||||
|
assert await cli.run(["create-admin", "--email", "benny@example.com", "--password-stdin"]) == 0
|
||||||
|
|
||||||
|
name = (
|
||||||
|
await db_auth.execute(
|
||||||
|
text("SELECT display_name FROM users WHERE email = :email"),
|
||||||
|
{"email": "benny@example.com"},
|
||||||
|
)
|
||||||
|
).scalar_one()
|
||||||
|
await db_auth.commit()
|
||||||
|
assert name == "benny"
|
||||||
|
|
||||||
|
|
||||||
|
async def test_create_admin_refuses_an_existing_email_without_touching_the_account(
|
||||||
|
client: httpx.AsyncClient, db_auth: AsyncSession, monkeypatch: pytest.MonkeyPatch
|
||||||
|
) -> None:
|
||||||
|
"""Re-running the bootstrap command must not become an undocumented password reset.
|
||||||
|
|
||||||
|
"Refused" is asserted three ways, because exit code 1 alone would also be satisfied by a
|
||||||
|
command that failed *after* corrupting the row: the original password must still work, the new
|
||||||
|
one must not, and the display name must be unchanged.
|
||||||
|
"""
|
||||||
|
monkeypatch.setattr(sys, "stdin", _pipe(_PASSWORD))
|
||||||
|
assert (
|
||||||
|
await cli.run(
|
||||||
|
["create-admin", "--email", "boss@example.com", "--name", "Boss", "--password-stdin"]
|
||||||
|
)
|
||||||
|
== 0
|
||||||
|
)
|
||||||
|
|
||||||
|
monkeypatch.setattr(sys, "stdin", _pipe(_OTHER_PASSWORD))
|
||||||
|
second = await cli.run(
|
||||||
|
["create-admin", "--email", "boss@example.com", "--name", "Impostor", "--password-stdin"]
|
||||||
|
)
|
||||||
|
assert second == 1
|
||||||
|
|
||||||
|
still_works = await client.post(
|
||||||
|
"/api/v1/auth/login", json={"email": "boss@example.com", "password": _PASSWORD}
|
||||||
|
)
|
||||||
|
assert still_works.status_code == 200, "the original password must survive a refused re-run"
|
||||||
|
|
||||||
|
rejected = await client.post(
|
||||||
|
"/api/v1/auth/login", json={"email": "boss@example.com", "password": _OTHER_PASSWORD}
|
||||||
|
)
|
||||||
|
assert rejected.status_code == 401, "the refused run's password must never become valid"
|
||||||
|
|
||||||
|
name = (
|
||||||
|
await db_auth.execute(
|
||||||
|
text("SELECT display_name FROM users WHERE email = :email"),
|
||||||
|
{"email": "boss@example.com"},
|
||||||
|
)
|
||||||
|
).scalar_one()
|
||||||
|
await db_auth.commit()
|
||||||
|
assert name == "Boss"
|
||||||
|
|
||||||
|
|
||||||
|
async def test_create_admin_error_message_never_echoes_the_password(
|
||||||
|
monkeypatch: pytest.MonkeyPatch, capsys: pytest.CaptureFixture[str]
|
||||||
|
) -> None:
|
||||||
|
"""CLAUDE.md invariant #5, in the one place it's easy to breach by accident.
|
||||||
|
|
||||||
|
Pydantic's default rendering of a ValidationError embeds the offending value — for a
|
||||||
|
too-short password that means printing the password itself to the operator's terminal, and
|
||||||
|
into whatever captured that output (a CI log, a `script` session, a scrollback buffer shared
|
||||||
|
in a bug report). `_validate` strips it deliberately; this proves it stays stripped.
|
||||||
|
"""
|
||||||
|
secret = "short"
|
||||||
|
monkeypatch.setattr(sys, "stdin", _pipe(secret))
|
||||||
|
code = await cli.run(["create-admin", "--email", "boss@example.com", "--password-stdin"])
|
||||||
|
assert code == 1
|
||||||
|
|
||||||
|
captured = capsys.readouterr()
|
||||||
|
assert secret not in captured.out
|
||||||
|
assert secret not in captured.err
|
||||||
|
# ...while still being a useful message: it must name the offending field and the rule.
|
||||||
|
assert "password" in captured.err
|
||||||
|
assert "at least 8" in captured.err
|
||||||
|
|
||||||
|
|
||||||
|
async def test_create_admin_rejects_a_malformed_email(
|
||||||
|
monkeypatch: pytest.MonkeyPatch, capsys: pytest.CaptureFixture[str]
|
||||||
|
) -> None:
|
||||||
|
monkeypatch.setattr(sys, "stdin", _pipe(_PASSWORD))
|
||||||
|
code = await cli.run(["create-admin", "--email", "not-an-email", "--password-stdin"])
|
||||||
|
assert code == 1
|
||||||
|
assert "email" in capsys.readouterr().err
|
||||||
|
|
||||||
|
|
||||||
|
async def test_password_stdin_rejects_an_empty_line(
|
||||||
|
monkeypatch: pytest.MonkeyPatch, capsys: pytest.CaptureFixture[str]
|
||||||
|
) -> None:
|
||||||
|
"""An empty pipe is nearly always `$PASSWORD` being unset in the operator's shell. Failing
|
||||||
|
loudly beats creating an account whose password is the empty string."""
|
||||||
|
monkeypatch.setattr(sys, "stdin", io.StringIO(""))
|
||||||
|
code = await cli.run(["create-admin", "--email", "boss@example.com", "--password-stdin"])
|
||||||
|
assert code == 1
|
||||||
|
assert "empty" in capsys.readouterr().err
|
||||||
|
|
||||||
|
|
||||||
|
async def test_password_stdin_preserves_a_trailing_space(
|
||||||
|
client: httpx.AsyncClient, monkeypatch: pytest.MonkeyPatch
|
||||||
|
) -> None:
|
||||||
|
"""Only the line ending is stripped, not surrounding whitespace — a password with a trailing
|
||||||
|
space is legitimate, and trimming it would create an account whose password can never be typed
|
||||||
|
back in. Proven through a real login rather than by inspecting the hash."""
|
||||||
|
padded = f"{_PASSWORD} "
|
||||||
|
monkeypatch.setattr(sys, "stdin", _pipe(padded, newline="\r\n"))
|
||||||
|
assert await cli.run(["create-admin", "--email", "boss@example.com", "--password-stdin"]) == 0
|
||||||
|
|
||||||
|
resp = await client.post(
|
||||||
|
"/api/v1/auth/login", json={"email": "boss@example.com", "password": padded}
|
||||||
|
)
|
||||||
|
assert resp.status_code == 200, "the trailing space must be part of the stored password"
|
||||||
|
|
||||||
|
trimmed = await client.post(
|
||||||
|
"/api/v1/auth/login", json={"email": "boss@example.com", "password": _PASSWORD}
|
||||||
|
)
|
||||||
|
assert trimmed.status_code == 401
|
||||||
|
|
||||||
|
|
||||||
|
async def test_without_a_tty_or_password_stdin_it_explains_how_to_run_it(
|
||||||
|
monkeypatch: pytest.MonkeyPatch, capsys: pytest.CaptureFixture[str]
|
||||||
|
) -> None:
|
||||||
|
"""The most likely first-run mistake is `docker exec` without `-t`. getpass would otherwise
|
||||||
|
fail with a bare OSError, so the command catches it first and prints both working forms."""
|
||||||
|
monkeypatch.setattr(sys, "stdin", io.StringIO(""))
|
||||||
|
code = await cli.run(["create-admin", "--email", "boss@example.com"])
|
||||||
|
assert code == 1
|
||||||
|
|
||||||
|
err = capsys.readouterr().err
|
||||||
|
assert "docker exec -it" in err
|
||||||
|
assert "--password-stdin" in err
|
||||||
|
|
||||||
|
|
||||||
|
async def test_prompt_path_requires_the_confirmation_to_match(
|
||||||
|
monkeypatch: pytest.MonkeyPatch, capsys: pytest.CaptureFixture[str]
|
||||||
|
) -> None:
|
||||||
|
"""A typo in a password nobody can see, on the one account that can't be recovered by another
|
||||||
|
admin, is worth a second prompt."""
|
||||||
|
monkeypatch.setattr(sys, "stdin", _FakeTty())
|
||||||
|
answers = iter([_PASSWORD, _OTHER_PASSWORD])
|
||||||
|
monkeypatch.setattr(cli.getpass, "getpass", lambda prompt="": next(answers))
|
||||||
|
|
||||||
|
code = await cli.run(["create-admin", "--email", "boss@example.com"])
|
||||||
|
assert code == 1
|
||||||
|
assert "did not match" in capsys.readouterr().err
|
||||||
|
|
||||||
|
|
||||||
|
async def test_prompt_path_creates_the_account_when_both_entries_match(
|
||||||
|
client: httpx.AsyncClient, monkeypatch: pytest.MonkeyPatch
|
||||||
|
) -> None:
|
||||||
|
"""The interactive path is the one the docs tell operators to use, so it gets the same
|
||||||
|
end-to-end login proof as the piped path."""
|
||||||
|
monkeypatch.setattr(sys, "stdin", _FakeTty())
|
||||||
|
answers = iter([_PASSWORD, _PASSWORD])
|
||||||
|
monkeypatch.setattr(cli.getpass, "getpass", lambda prompt="": next(answers))
|
||||||
|
|
||||||
|
assert await cli.run(["create-admin", "--email", "boss@example.com"]) == 0
|
||||||
|
|
||||||
|
resp = await client.post(
|
||||||
|
"/api/v1/auth/login", json={"email": "boss@example.com", "password": _PASSWORD}
|
||||||
|
)
|
||||||
|
assert resp.status_code == 200
|
||||||
|
|
||||||
|
|
||||||
|
async def test_success_output_never_contains_the_password(
|
||||||
|
monkeypatch: pytest.MonkeyPatch, capsys: pytest.CaptureFixture[str]
|
||||||
|
) -> None:
|
||||||
|
"""The failure path is covered above; the success path prints more, so it gets its own check.
|
||||||
|
The realistic leak here is a well-meaning "created with password: ..." confirmation line."""
|
||||||
|
monkeypatch.setattr(sys, "stdin", _pipe(_PASSWORD))
|
||||||
|
assert await cli.run(["create-admin", "--email", "boss@example.com", "--password-stdin"]) == 0
|
||||||
|
|
||||||
|
captured = capsys.readouterr()
|
||||||
|
assert _PASSWORD not in captured.out
|
||||||
|
assert _PASSWORD not in captured.err
|
||||||
|
assert "boss@example.com" in captured.out
|
||||||
|
assert ROLE_ADMIN in captured.out
|
||||||
|
|
||||||
|
|
||||||
|
async def test_a_missing_required_option_exits_two_not_one(
|
||||||
|
capsys: pytest.CaptureFixture[str],
|
||||||
|
) -> None:
|
||||||
|
"""argparse's usage errors exit 2; a refusal from the command itself exits 1. A script driving
|
||||||
|
this should be able to tell "you called it wrong" from "it ran and declined"."""
|
||||||
|
with pytest.raises(SystemExit) as exc:
|
||||||
|
await cli.run(["create-admin"])
|
||||||
|
assert exc.value.code == 2
|
||||||
|
capsys.readouterr()
|
||||||
|
|
||||||
|
|
||||||
|
async def test_no_subcommand_is_a_usage_error(capsys: pytest.CaptureFixture[str]) -> None:
|
||||||
|
with pytest.raises(SystemExit) as exc:
|
||||||
|
await cli.run([])
|
||||||
|
assert exc.value.code == 2
|
||||||
|
capsys.readouterr()
|
||||||
|
|
||||||
|
|
||||||
|
def test_the_console_script_is_registered_under_the_name_the_docs_use() -> None:
|
||||||
|
"""deploy/README.md and the CLI's own error messages tell operators to run
|
||||||
|
`docker exec -it velodrome velodrome create-admin`. That only works because pyproject declares
|
||||||
|
the console script, which nothing else in the test suite would exercise — an editable install
|
||||||
|
imports `velodrome.cli` fine whether or not the entry point exists. Asserted against the
|
||||||
|
manifest so renaming the module or the function fails here rather than on a deployment.
|
||||||
|
"""
|
||||||
|
pyproject = Path(__file__).resolve().parents[1] / "pyproject.toml"
|
||||||
|
manifest = tomllib.loads(pyproject.read_text(encoding="utf-8"))
|
||||||
|
assert manifest["project"]["scripts"]["velodrome"] == "velodrome.cli:main"
|
||||||
@@ -23,7 +23,7 @@ from velodrome.auth.security import (
|
|||||||
)
|
)
|
||||||
from velodrome.config import get_settings
|
from velodrome.config import get_settings
|
||||||
from velodrome.db import auth_session
|
from velodrome.db import auth_session
|
||||||
from velodrome.models import Invite, Session, User
|
from velodrome.models import ROLE_ADMIN, Invite, Session, User
|
||||||
|
|
||||||
|
|
||||||
class AuthError(Exception):
|
class AuthError(Exception):
|
||||||
@@ -51,6 +51,14 @@ class AuthenticatedSession:
|
|||||||
user_id: UUID
|
user_id: UUID
|
||||||
email: str
|
email: str
|
||||||
display_name: str
|
display_name: str
|
||||||
|
# Carried here so the role a user actually has is available wherever identity is — an
|
||||||
|
# authorization check on the first admin-only endpoint (realistically invite management) is
|
||||||
|
# then a comparison against a value already in hand, not another query bolted on later. This
|
||||||
|
# is data plumbing, not an authorization mechanism: nothing reads it yet, deliberately, since
|
||||||
|
# there is no admin-only endpoint to protect (docs/DECISIONS.md D18). It is not a secret and
|
||||||
|
# is not in any response model — `schemas.auth.UserOut` deliberately doesn't declare it, so
|
||||||
|
# adding it here changes no HTTP response and no OpenAPI contract.
|
||||||
|
role: str
|
||||||
|
|
||||||
|
|
||||||
async def register(
|
async def register(
|
||||||
@@ -103,7 +111,58 @@ async def register(
|
|||||||
invite.used_count += 1
|
invite.used_count += 1
|
||||||
|
|
||||||
return AuthenticatedSession(
|
return AuthenticatedSession(
|
||||||
user_id=user.id, email=user.email, display_name=user.display_name
|
user_id=user.id,
|
||||||
|
email=user.email,
|
||||||
|
display_name=user.display_name,
|
||||||
|
role=user.role,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
async def create_admin(*, email: str, password: str, display_name: str) -> AuthenticatedSession:
|
||||||
|
"""Create a user with the admin role, with no invite. Operator path only — see velodrome.cli.
|
||||||
|
|
||||||
|
This is the one deliberate hole in "open signup does not exist": a fresh deployment has no
|
||||||
|
users and therefore nobody who can issue the first invite, so the first account has to come
|
||||||
|
from outside the HTTP API. It lives here rather than in cli.py because this is where
|
||||||
|
`auth_session` belongs (see db.py's docstring — nothing outside this module imports it), and
|
||||||
|
because the lookup below is exactly the pattern that module documents as safe: an exact match
|
||||||
|
on a unique key, never a scan.
|
||||||
|
|
||||||
|
It is not reachable over HTTP and never will be — nothing in `api/` calls it. Reaching it
|
||||||
|
requires the ability to run a process inside the container, which is already the ability to
|
||||||
|
read and rewrite the SQLite file directly, so it grants an operator-turned-attacker nothing
|
||||||
|
they did not already have.
|
||||||
|
|
||||||
|
Refuses outright if the email is taken, rather than updating the row — see docs/DECISIONS.md
|
||||||
|
D18. Creating an account and resetting an existing account's password are different operations
|
||||||
|
with different blast radii, and an operator re-running a bootstrap command they last ran
|
||||||
|
months ago means the first, never the second. The check-then-insert is safe against a
|
||||||
|
concurrent `register()` for the same email the same way invite redemption is: db.py issues
|
||||||
|
`BEGIN IMMEDIATE`, so the two transactions serialize instead of interleaving, with the unique
|
||||||
|
index on `users.email` as the backstop underneath that.
|
||||||
|
"""
|
||||||
|
async with auth_session() as db:
|
||||||
|
async with db.begin():
|
||||||
|
existing = (
|
||||||
|
await db.execute(select(User).where(User.email == email))
|
||||||
|
).scalar_one_or_none()
|
||||||
|
if existing is not None:
|
||||||
|
raise EmailAlreadyRegistered("an account with this email already exists")
|
||||||
|
|
||||||
|
user = User(
|
||||||
|
email=email,
|
||||||
|
display_name=display_name,
|
||||||
|
password_hash=hash_password(password),
|
||||||
|
role=ROLE_ADMIN,
|
||||||
|
)
|
||||||
|
db.add(user)
|
||||||
|
await db.flush() # populate user.id before we reference it below
|
||||||
|
|
||||||
|
return AuthenticatedSession(
|
||||||
|
user_id=user.id,
|
||||||
|
email=user.email,
|
||||||
|
display_name=user.display_name,
|
||||||
|
role=user.role,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@@ -140,7 +199,10 @@ async def login(
|
|||||||
db.add(session_row)
|
db.add(session_row)
|
||||||
|
|
||||||
return raw_token, AuthenticatedSession(
|
return raw_token, AuthenticatedSession(
|
||||||
user_id=user.id, email=user.email, display_name=user.display_name
|
user_id=user.id,
|
||||||
|
email=user.email,
|
||||||
|
display_name=user.display_name,
|
||||||
|
role=user.role,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@@ -184,7 +246,10 @@ async def validate_session(raw_token: str) -> AuthenticatedSession:
|
|||||||
)
|
)
|
||||||
|
|
||||||
return AuthenticatedSession(
|
return AuthenticatedSession(
|
||||||
user_id=user.id, email=user.email, display_name=user.display_name
|
user_id=user.id,
|
||||||
|
email=user.email,
|
||||||
|
display_name=user.display_name,
|
||||||
|
role=user.role,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,181 @@
|
|||||||
|
"""Operator CLI — `velodrome <command>`.
|
||||||
|
|
||||||
|
Installed as a console script (`[project.scripts]` in pyproject.toml) into the same venv as
|
||||||
|
`alembic` and `uvicorn`, which `deploy/entrypoint.sh` already invokes by their installed names, so
|
||||||
|
the deployed container has this on PATH with no extra wiring:
|
||||||
|
|
||||||
|
docker exec -it velodrome velodrome create-admin --email you@example.com
|
||||||
|
|
||||||
|
It exists because there is otherwise **no way to create the first user**. Registration requires a
|
||||||
|
valid invite (docs/PLAN.md "Auth": open signup does not exist as a setting), invites are created by
|
||||||
|
an existing admin, and a fresh database has neither — so a new deployment is unusable without a
|
||||||
|
path in from outside the HTTP API. docs/PLAN.md always called for this command; it was simply
|
||||||
|
never built during Phase 0. See docs/DECISIONS.md D18 for the three decisions recorded here: why
|
||||||
|
it refuses to touch an existing account, why it is *not* restricted to the very first user, and
|
||||||
|
why `role="admin"` is recorded but not yet enforced anywhere.
|
||||||
|
|
||||||
|
argparse rather than Typer/Click: one command with three options does not justify a runtime
|
||||||
|
dependency the deployed image would have to carry, and the stdlib covers this case completely.
|
||||||
|
|
||||||
|
There is deliberately **no `--password` flag** — see `_read_password`.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import argparse
|
||||||
|
import asyncio
|
||||||
|
import getpass
|
||||||
|
import sys
|
||||||
|
from collections.abc import Sequence
|
||||||
|
|
||||||
|
from pydantic import BaseModel, EmailStr, ValidationError
|
||||||
|
|
||||||
|
from velodrome.auth import service
|
||||||
|
from velodrome.config import get_settings
|
||||||
|
from velodrome.schemas.auth import DisplayName, Password
|
||||||
|
|
||||||
|
|
||||||
|
class CliError(Exception):
|
||||||
|
"""An operator-facing failure: printed as `error: <message>`, exit code 1.
|
||||||
|
|
||||||
|
Distinct from argparse's own usage errors, which exit 2 — so a script driving this can tell
|
||||||
|
"you called it wrong" apart from "it ran and refused".
|
||||||
|
"""
|
||||||
|
|
||||||
|
|
||||||
|
class _CreateAdminInput(BaseModel):
|
||||||
|
"""The same constraints the HTTP register endpoint applies, reused rather than restated — a
|
||||||
|
CLI-created account must not be able to hold a password the API would have rejected.
|
||||||
|
"""
|
||||||
|
|
||||||
|
email: EmailStr
|
||||||
|
password: Password
|
||||||
|
display_name: DisplayName
|
||||||
|
|
||||||
|
|
||||||
|
def _validate(*, email: str, password: str, display_name: str) -> _CreateAdminInput:
|
||||||
|
try:
|
||||||
|
return _CreateAdminInput(email=email, password=password, display_name=display_name)
|
||||||
|
except ValidationError as exc:
|
||||||
|
# Deliberately not `str(exc)`: pydantic's rendered message embeds the offending value
|
||||||
|
# ("... [type=string_too_short, input_value='hunter2', input_type=str]"), which for the
|
||||||
|
# password field prints the password to the operator's terminal and into whatever
|
||||||
|
# captures that output. CLAUDE.md invariant #5 — only `loc` and `msg` are safe to show.
|
||||||
|
details = "; ".join(
|
||||||
|
f"{'.'.join(str(part) for part in err['loc'])}: {err['msg']}"
|
||||||
|
for err in exc.errors(include_url=False, include_input=False)
|
||||||
|
)
|
||||||
|
raise CliError(f"invalid input — {details}") from exc
|
||||||
|
|
||||||
|
|
||||||
|
def _read_password(*, from_stdin: bool) -> str:
|
||||||
|
"""Prompt for a password, or read one line from stdin.
|
||||||
|
|
||||||
|
No `--password` flag exists on purpose: an argument lands in the operator's shell history, in
|
||||||
|
`ps` output for as long as the process runs, and — because the realistic invocation here is
|
||||||
|
`docker exec` — in the Docker daemon's own record of the exec'd command. A TTY prompt and a
|
||||||
|
pipe are the two forms that avoid all three, and they're the same two forms `docker login`
|
||||||
|
offers for exactly this reason.
|
||||||
|
"""
|
||||||
|
if from_stdin:
|
||||||
|
line = sys.stdin.readline()
|
||||||
|
# Strip only the line ending, not surrounding whitespace — a trailing space in a password
|
||||||
|
# is legitimate, and silently trimming it would create a password that can never be typed
|
||||||
|
# back in correctly.
|
||||||
|
password = line.rstrip("\r\n")
|
||||||
|
if not password:
|
||||||
|
raise CliError("--password-stdin was given but the first line of stdin was empty")
|
||||||
|
return password
|
||||||
|
|
||||||
|
if not sys.stdin.isatty():
|
||||||
|
raise CliError(
|
||||||
|
"no terminal available to prompt on. Either allocate one (note the -t):\n"
|
||||||
|
" docker exec -it velodrome velodrome create-admin --email you@example.com\n"
|
||||||
|
"or pipe the password in:\n"
|
||||||
|
" printf '%s' \"$PASSWORD\" | docker exec -i velodrome \\\n"
|
||||||
|
" velodrome create-admin --email you@example.com --password-stdin"
|
||||||
|
)
|
||||||
|
|
||||||
|
password = getpass.getpass("Password: ")
|
||||||
|
if password != getpass.getpass("Confirm password: "):
|
||||||
|
raise CliError("passwords did not match")
|
||||||
|
return password
|
||||||
|
|
||||||
|
|
||||||
|
async def _create_admin(args: argparse.Namespace) -> int:
|
||||||
|
email: str = args.email
|
||||||
|
# The local part is a reasonable default for a name nobody but the operator will see until
|
||||||
|
# they change it in the UI; it keeps the common invocation to a single flag.
|
||||||
|
display_name: str = args.name if args.name is not None else email.partition("@")[0]
|
||||||
|
|
||||||
|
password = _read_password(from_stdin=args.password_stdin)
|
||||||
|
validated = _validate(email=email, password=password, display_name=display_name)
|
||||||
|
|
||||||
|
try:
|
||||||
|
created = await service.create_admin(
|
||||||
|
email=str(validated.email),
|
||||||
|
password=validated.password,
|
||||||
|
display_name=validated.display_name,
|
||||||
|
)
|
||||||
|
except service.EmailAlreadyRegistered as exc:
|
||||||
|
raise CliError(
|
||||||
|
f"an account already exists for {email} — refusing to modify it. This command only "
|
||||||
|
"ever creates a new account; it will not reset an existing one's password (see "
|
||||||
|
"docs/DECISIONS.md D18). To add a different admin, re-run with another --email."
|
||||||
|
) from exc
|
||||||
|
|
||||||
|
print("Created admin user:")
|
||||||
|
print(f" id {created.user_id}")
|
||||||
|
print(f" email {created.email}")
|
||||||
|
print(f" display name {created.display_name}")
|
||||||
|
print(f" role {created.role}")
|
||||||
|
print()
|
||||||
|
print(f"Log in at {get_settings().public_url}")
|
||||||
|
print(
|
||||||
|
"Note: the admin role is recorded on the account but nothing enforces it yet — no "
|
||||||
|
"admin-only endpoint exists (docs/DECISIONS.md D18)."
|
||||||
|
)
|
||||||
|
return 0
|
||||||
|
|
||||||
|
|
||||||
|
def _build_parser() -> argparse.ArgumentParser:
|
||||||
|
parser = argparse.ArgumentParser(
|
||||||
|
prog="velodrome",
|
||||||
|
description="Velodrome operator commands. Run inside the container, e.g. "
|
||||||
|
"`docker exec -it velodrome velodrome create-admin --email you@example.com`.",
|
||||||
|
)
|
||||||
|
subcommands = parser.add_subparsers(dest="command", required=True)
|
||||||
|
|
||||||
|
create_admin = subcommands.add_parser(
|
||||||
|
"create-admin",
|
||||||
|
help="create a user with the admin role, bypassing the invite requirement",
|
||||||
|
description="Create a user with the admin role, bypassing the invite requirement. This is "
|
||||||
|
"how the first account on a fresh deployment is made — registration needs an invite, and "
|
||||||
|
"a fresh database has none. Refuses to modify an account that already exists.",
|
||||||
|
)
|
||||||
|
create_admin.add_argument("--email", required=True, help="the account's email address")
|
||||||
|
create_admin.add_argument(
|
||||||
|
"--name",
|
||||||
|
default=None,
|
||||||
|
help="display name (default: the part of the email address before the @)",
|
||||||
|
)
|
||||||
|
create_admin.add_argument(
|
||||||
|
"--password-stdin",
|
||||||
|
action="store_true",
|
||||||
|
help="read the password from the first line of stdin instead of prompting for it",
|
||||||
|
)
|
||||||
|
return parser
|
||||||
|
|
||||||
|
|
||||||
|
async def run(argv: Sequence[str] | None = None) -> int:
|
||||||
|
"""The async entrypoint. `main` wraps this in `asyncio.run`; tests call it directly."""
|
||||||
|
args = _build_parser().parse_args(argv)
|
||||||
|
try:
|
||||||
|
if args.command == "create-admin":
|
||||||
|
return await _create_admin(args)
|
||||||
|
except CliError as exc:
|
||||||
|
print(f"error: {exc}", file=sys.stderr)
|
||||||
|
return 1
|
||||||
|
raise AssertionError(f"unhandled command {args.command!r}") # pragma: no cover
|
||||||
|
|
||||||
|
|
||||||
|
def main(argv: Sequence[str] | None = None) -> int:
|
||||||
|
return asyncio.run(run(argv))
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
from velodrome.models.base import Base
|
from velodrome.models.base import Base
|
||||||
from velodrome.models.identity import ApiToken, Invite, Session, User
|
from velodrome.models.identity import ROLE_ADMIN, ROLE_MEMBER, ApiToken, Invite, Session, User
|
||||||
|
|
||||||
__all__ = ["ApiToken", "Base", "Invite", "Session", "User"]
|
__all__ = ["ROLE_ADMIN", "ROLE_MEMBER", "ApiToken", "Base", "Invite", "Session", "User"]
|
||||||
|
|||||||
@@ -24,6 +24,16 @@ def _now_utc() -> datetime:
|
|||||||
return datetime.now(UTC)
|
return datetime.now(UTC)
|
||||||
|
|
||||||
|
|
||||||
|
# The only two values `users.role` and `invites.role` are ever set to. Named constants so the set
|
||||||
|
# is discoverable from one place: `velodrome.cli`'s create-admin writes ROLE_ADMIN, and
|
||||||
|
# registration copies whatever role the redeemed invite carries. Nothing *enforces* a role yet —
|
||||||
|
# no admin-only endpoint exists (docs/DECISIONS.md D18) — and the column stays a plain string
|
||||||
|
# rather than a DB-level enum or CHECK constraint so adding a third role later is an application
|
||||||
|
# change, not a migration.
|
||||||
|
ROLE_MEMBER = "member"
|
||||||
|
ROLE_ADMIN = "admin"
|
||||||
|
|
||||||
|
|
||||||
class User(Base):
|
class User(Base):
|
||||||
__tablename__ = "users"
|
__tablename__ = "users"
|
||||||
|
|
||||||
@@ -31,7 +41,7 @@ class User(Base):
|
|||||||
email: Mapped[str] = mapped_column(String(320), unique=True, nullable=False)
|
email: Mapped[str] = mapped_column(String(320), unique=True, nullable=False)
|
||||||
display_name: Mapped[str] = mapped_column(String(200), nullable=False)
|
display_name: Mapped[str] = mapped_column(String(200), nullable=False)
|
||||||
password_hash: Mapped[str] = mapped_column(Text, nullable=False)
|
password_hash: Mapped[str] = mapped_column(Text, nullable=False)
|
||||||
role: Mapped[str] = mapped_column(String(20), nullable=False, default="member")
|
role: Mapped[str] = mapped_column(String(20), nullable=False, default=ROLE_MEMBER)
|
||||||
timezone: Mapped[str] = mapped_column(String(64), nullable=False, default="UTC")
|
timezone: Mapped[str] = mapped_column(String(64), nullable=False, default="UTC")
|
||||||
# Display-only, per CLAUDE.md invariant #3 — storage is always SI, this never touches a query.
|
# Display-only, per CLAUDE.md invariant #3 — storage is always SI, this never touches a query.
|
||||||
unit_system: Mapped[str] = mapped_column(String(10), nullable=False, default="imperial")
|
unit_system: Mapped[str] = mapped_column(String(10), nullable=False, default="imperial")
|
||||||
@@ -53,7 +63,7 @@ class Invite(Base):
|
|||||||
Uuid(as_uuid=True), ForeignKey("users.id"), nullable=False
|
Uuid(as_uuid=True), ForeignKey("users.id"), nullable=False
|
||||||
)
|
)
|
||||||
email: Mapped[str | None] = mapped_column(String(320), nullable=True)
|
email: Mapped[str | None] = mapped_column(String(320), nullable=True)
|
||||||
role: Mapped[str] = mapped_column(String(20), nullable=False, default="member")
|
role: Mapped[str] = mapped_column(String(20), nullable=False, default=ROLE_MEMBER)
|
||||||
expires_at: Mapped[datetime] = mapped_column(nullable=False)
|
expires_at: Mapped[datetime] = mapped_column(nullable=False)
|
||||||
max_uses: Mapped[int] = mapped_column(nullable=False, default=1)
|
max_uses: Mapped[int] = mapped_column(nullable=False, default=1)
|
||||||
used_count: Mapped[int] = mapped_column(nullable=False, default=0)
|
used_count: Mapped[int] = mapped_column(nullable=False, default=0)
|
||||||
|
|||||||
@@ -6,15 +6,23 @@ simply not being listed here is what keeps password_hash/token_hash out of every
|
|||||||
adding a new field, ask whether it belongs in a response before adding it, not after.
|
adding a new field, ask whether it belongs in a response before adding it, not after.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
from typing import Annotated
|
||||||
from uuid import UUID
|
from uuid import UUID
|
||||||
|
|
||||||
from pydantic import BaseModel, EmailStr, Field
|
from pydantic import BaseModel, EmailStr, Field
|
||||||
|
|
||||||
|
# Named aliases rather than inline constraints, because these two rules are also applied outside
|
||||||
|
# the HTTP layer: `velodrome.cli` validates `create-admin`'s input against exactly the same ones,
|
||||||
|
# so an account created from the CLI can't hold a password the register endpoint would have
|
||||||
|
# rejected. Defined once here so the two can't drift apart.
|
||||||
|
Password = Annotated[str, Field(min_length=8, max_length=200)]
|
||||||
|
DisplayName = Annotated[str, Field(min_length=1, max_length=200)]
|
||||||
|
|
||||||
|
|
||||||
class RegisterRequest(BaseModel):
|
class RegisterRequest(BaseModel):
|
||||||
email: EmailStr
|
email: EmailStr
|
||||||
password: str = Field(min_length=8, max_length=200)
|
password: Password
|
||||||
display_name: str = Field(min_length=1, max_length=200)
|
display_name: DisplayName
|
||||||
invite_code: str = Field(min_length=1, max_length=200)
|
invite_code: str = Field(min_length=1, max_length=200)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
+95
-8
@@ -43,6 +43,65 @@ front of port 8080 — this container only ever serves plain HTTP itself.
|
|||||||
|
|
||||||
`GET http://<host>:8080/api/v1/healthz` should return `{"status": "ok"}` once it's up.
|
`GET http://<host>:8080/api/v1/healthz` should return `{"status": "ok"}` once it's up.
|
||||||
|
|
||||||
|
## Create the first admin user
|
||||||
|
|
||||||
|
**A fresh deployment has no users and you cannot sign up for one.** Registration requires an invite
|
||||||
|
code, invites are issued by an existing admin, and a new database has neither — so the first account
|
||||||
|
is created from inside the container (`docs/DECISIONS.md` D18 for why it's a CLI and not a
|
||||||
|
first-run web page):
|
||||||
|
|
||||||
|
```sh
|
||||||
|
docker exec -it velodrome velodrome create-admin --email you@example.com
|
||||||
|
```
|
||||||
|
|
||||||
|
That prompts for the password twice and prints the new account's id, email and role. Then log in at
|
||||||
|
`VELODROME_PUBLIC_URL`. Note the **`-t`** — without a TTY there's nothing to prompt on; the command
|
||||||
|
says so rather than hanging. Add `--name "Your Name"` to set a display name (it defaults to the part
|
||||||
|
of the email before the `@`); it's editable in the UI later either way.
|
||||||
|
|
||||||
|
For a non-interactive run (a provisioning script), pipe the password in instead — note `-i` rather
|
||||||
|
than `-it`:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
printf '%s' "$ADMIN_PASSWORD" | docker exec -i velodrome \
|
||||||
|
velodrome create-admin --email you@example.com --password-stdin
|
||||||
|
```
|
||||||
|
|
||||||
|
There is deliberately no `--password` flag: an argument would land in your shell history, in `ps`
|
||||||
|
output, and in the Docker daemon's record of the exec'd command.
|
||||||
|
|
||||||
|
Re-run it with a different `--email` to add another admin. Re-running it with an email that already
|
||||||
|
exists **refuses and changes nothing** — it is not a password-reset tool, and there isn't one yet
|
||||||
|
(D18). Minimum password length is 8 characters, the same rule the register endpoint applies.
|
||||||
|
|
||||||
|
Nothing enforces the admin role yet — no admin-only endpoint exists — so today this differs from an
|
||||||
|
invited account only in the role recorded on it. Invite management in a later phase is what starts
|
||||||
|
reading it.
|
||||||
|
|
||||||
|
## Verify login actually works, not just that the API responds
|
||||||
|
|
||||||
|
`GET /api/v1/healthz` proves the process is up. It does **not** prove a real login works, because
|
||||||
|
the session cookie is set with `Secure` in production (`apps/api/velodrome/api/v1/auth.py`) —
|
||||||
|
browsers silently refuse to store a `Secure` cookie unless the request was actually served over
|
||||||
|
HTTPS. Test through a plain-HTTP address (an IP, a bare port, skipping the reverse proxy) and
|
||||||
|
`/auth/login` still returns 200 with a valid response body; the cookie is just quietly dropped, so
|
||||||
|
the very next request looks unauthenticated. From a browser this looks exactly like "I logged in
|
||||||
|
and it bounced me straight back to the login screen," with nothing that looks like an error. This
|
||||||
|
happened on the very first real deployment.
|
||||||
|
|
||||||
|
`scripts/smoke-test.sh` exists so this is caught by running a command, not by refreshing a browser
|
||||||
|
tab:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
scripts/smoke-test.sh https://bike.bbergle.com you@example.com yourpassword
|
||||||
|
```
|
||||||
|
|
||||||
|
It logs in, confirms a session cookie was actually stored (not just sent), then makes an
|
||||||
|
authenticated follow-up request and confirms it succeeds and returns the right account. Run it
|
||||||
|
after every real deploy, against the actual public URL your users will use — testing against a
|
||||||
|
plain-HTTP IP will (correctly) tell you nothing about whether login works for anyone using the real
|
||||||
|
domain.
|
||||||
|
|
||||||
## Environment variables
|
## Environment variables
|
||||||
|
|
||||||
All read by `apps/api/velodrome/config.py` (prefix `VELODROME_`) — the app and Alembic both read
|
All read by `apps/api/velodrome/config.py` (prefix `VELODROME_`) — the app and Alembic both read
|
||||||
@@ -63,6 +122,13 @@ the same values, there's no separate migration-time config anymore (docs/DECISIO
|
|||||||
|---|---|
|
|---|---|
|
||||||
| `/data` | The SQLite database file. Will also hold the content-addressed blob store once Phase 1 builds ingestion. This is the only thing that needs backing up. |
|
| `/data` | The SQLite database file. Will also hold the content-addressed blob store once Phase 1 builds ingestion. This is the only thing that needs backing up. |
|
||||||
|
|
||||||
|
The container runs as a fixed non-root user (uid/gid `999`), not root and not Unraid's usual
|
||||||
|
`nobody:users` (99:100). If `/data`'s host directory doesn't already exist, Docker/Unraid creates
|
||||||
|
it owned by `nobody:users` with no write access for other users — the container starts, but
|
||||||
|
uvicorn fails immediately with `sqlite3.OperationalError: unable to open database file`, since it
|
||||||
|
can't create the SQLite file inside a directory it can't write to. Fix once, before first start:
|
||||||
|
`chown -R 999:999 <host path>` (e.g. `/mnt/user/appdata/velodrome` on Unraid).
|
||||||
|
|
||||||
## Unraid
|
## Unraid
|
||||||
|
|
||||||
Import `unraid-template.xml` from the Docker tab's "Add Container" template picker — it exposes
|
Import `unraid-template.xml` from the Docker tab's "Add Container" template picker — it exposes
|
||||||
@@ -73,14 +139,35 @@ stays editable by hand afterward regardless of what the template pre-fills.
|
|||||||
## Publishing the image
|
## Publishing the image
|
||||||
|
|
||||||
`.gitea/workflows/release.yml` builds this Dockerfile and pushes it to the Gitea container
|
`.gitea/workflows/release.yml` builds this Dockerfile and pushes it to the Gitea container
|
||||||
registry (`192.168.0.3:3000/bbergle/bike-app`) on a `v*` tag push, or on manual
|
registry at `registry.bbergle.com:9537/bbergle/bike-app` on every push to `main` (tagged
|
||||||
`workflow_dispatch`. It does **not** SSH into the host and recreate the running container —
|
`main-<short-sha>`, and `latest`), on a `v*` tag push (tagged with the tag name, and `latest`), or
|
||||||
rolling out a new image on Unraid (pulling it and clicking "Apply" on the container, or via
|
on manual `workflow_dispatch` (tagged `manual-<timestamp>-<short-sha>` only — a manual dispatch
|
||||||
Unraid's own update-checking) is left as a manual/Unraid-side step, not something CI does
|
never moves `latest`, so testing a feature branch can't clobber what's actually deployable). Not
|
||||||
unattended.
|
`192.168.0.3:3000` (Gitea's own plain-HTTP address) directly — Docker
|
||||||
|
refuses any non-localhost registry over plain HTTP by default, so `registry.bbergle.com:9537` is
|
||||||
|
an NPMplus proxy host in front of Gitea's registry that terminates TLS with a self-signed cert.
|
||||||
|
See `docs/DECISIONS.md` D17 for the full setup (cert, NPMplus proxy host, `certs.d` trust, and the
|
||||||
|
buildx driver change this required) — none of it is committed here, since it's host-local trust
|
||||||
|
material and NPMplus config, not something this repo can or should own.
|
||||||
|
|
||||||
|
It does **not** SSH into the host and recreate the running container — rolling out a new image on
|
||||||
|
Unraid (pulling it and clicking "Apply" on the container, or via Unraid's own update-checking) is
|
||||||
|
left as a manual/Unraid-side step, not something CI does unattended.
|
||||||
|
|
||||||
|
Unraid's own "check for updates" is **not a reliable signal for this container specifically** — see
|
||||||
|
`docs/DECISIONS.md` D19. Because Gitea Actions builds on this same host's `dockerd`, every CI run
|
||||||
|
keeps the local `:latest` tag fresh regardless of whether the *running container* was ever
|
||||||
|
recreated from it, so the checker can say "up to date" while the running container is genuinely
|
||||||
|
stale. Don't wait for that badge; recreate deliberately after a merge you know should ship.
|
||||||
|
|
||||||
## What's not here yet
|
## What's not here yet
|
||||||
|
|
||||||
Backups (`docs/PLAN.md` calls for a systemd timer running `restic` against `/data`, independent of
|
- Backups (`docs/PLAN.md` calls for a systemd timer running `restic` against `/data`, independent
|
||||||
CI) and the `import_inbox` USB-watch bind mount are both Phase 1+ concerns — nothing in the schema
|
of CI) and the `import_inbox` USB-watch bind mount — both Phase 1+ concerns, nothing in the
|
||||||
uses them yet.
|
schema uses them yet.
|
||||||
|
- An auto-updater for the running container (attempted with Watchtower, deferred — D19).
|
||||||
|
- Persisting the host-local trust material from D17/D19 (`/etc/hosts`, `certs.d`, the CA bundle
|
||||||
|
entry) across a reboot — currently lost on restart, deliberately left that way pending a
|
||||||
|
decision about editing `/boot/config/go` (D19).
|
||||||
|
- Migrating Gitea + its Actions runners off this Unraid host onto a dedicated VM — the root cause
|
||||||
|
behind several of the fixes above, raised as a real future decision, not started (D19).
|
||||||
|
|||||||
@@ -10,15 +10,15 @@
|
|||||||
-->
|
-->
|
||||||
<Container version="2">
|
<Container version="2">
|
||||||
<Name>velodrome</Name>
|
<Name>velodrome</Name>
|
||||||
<Repository>192.168.0.3:3000/bbergle/bike-app:latest</Repository>
|
<Repository>registry.bbergle.com:9537/bbergle/bike-app:latest</Repository>
|
||||||
<Registry>http://192.168.0.3:3000/BBergle/-/packages/container/bike-app</Registry>
|
<Registry>http://192.168.0.3:3000/BBergle/-/packages/container/bike-app</Registry>
|
||||||
<Network>bridge</Network>
|
<Network>bridge</Network>
|
||||||
<Privileged>false</Privileged>
|
<Privileged>false</Privileged>
|
||||||
<Support>https://192.168.0.3:3000/BBergle/bike-app/issues</Support>
|
<Support>https://192.168.0.3:3000/BBergle/bike-app/issues</Support>
|
||||||
<Project>http://192.168.0.3:3000/BBergle/bike-app</Project>
|
<Project>http://192.168.0.3:3000/BBergle/bike-app</Project>
|
||||||
<Overview>Self-hosted cycling app: Bryton Rider 650 ride sync, mileage tracking, spare-parts inventory, and maintenance reminders. One container: Caddy + the FastAPI app + a SQLite database file on the Data path below. See docs/PLAN.md and docs/DECISIONS.md (D15/D16) in the repo for the design.</Overview>
|
<Overview>Self-hosted cycling app: Bryton Rider 650 ride sync, mileage tracking, spare-parts inventory, and maintenance reminders. One container: Caddy + the FastAPI app + a SQLite database file on the Data path below. See docs/PLAN.md and docs/DECISIONS.md (D15/D16/D17) in the repo for the design.</Overview>
|
||||||
<Category>Productivity:</Category>
|
<Category>Productivity:</Category>
|
||||||
<WebUI>http://[IP]:[PORT:8080]/</WebUI>
|
<WebUI>http://[IP]:[PORT:8090]/</WebUI>
|
||||||
<Icon/>
|
<Icon/>
|
||||||
<ExtraParams/>
|
<ExtraParams/>
|
||||||
<PostArgs/>
|
<PostArgs/>
|
||||||
@@ -27,7 +27,7 @@
|
|||||||
<DonateText/>
|
<DonateText/>
|
||||||
<DonateLink/>
|
<DonateLink/>
|
||||||
<Description>Self-hosted cycling app: Bryton ride sync, mileage tracking, spare-parts inventory, maintenance reminders.</Description>
|
<Description>Self-hosted cycling app: Bryton ride sync, mileage tracking, spare-parts inventory, maintenance reminders.</Description>
|
||||||
<Config Name="Web UI Port" Target="8080" Default="8080" Mode="tcp" Description="Container's HTTP port. Put a reverse proxy with TLS in front of this — the container itself only ever serves plain HTTP (docs/PLAN.md 'Service topology')." Type="Port" Display="always" Required="true" Mask="false">8080</Config>
|
<Config Name="Web UI Port" Target="8080" Default="8090" Mode="tcp" Description="Host port mapped to the container's internal 8080. Defaulted off 8080 since that's already taken by qBittorrent on this host — check for a free port before changing it. Put a reverse proxy with TLS in front of this — the container itself only ever serves plain HTTP (docs/PLAN.md 'Service topology')." Type="Port" Display="always" Required="true" Mask="false">8090</Config>
|
||||||
<Config Name="Data" Target="/data" Default="/mnt/user/appdata/velodrome" Mode="rw" Description="The SQLite database file (and, in a later phase, the raw-file blob store) live here. This is the only thing worth backing up." Type="Path" Display="always" Required="true" Mask="false">/mnt/user/appdata/velodrome</Config>
|
<Config Name="Data" Target="/data" Default="/mnt/user/appdata/velodrome" Mode="rw" Description="The SQLite database file (and, in a later phase, the raw-file blob store) live here. This is the only thing worth backing up." Type="Path" Display="always" Required="true" Mask="false">/mnt/user/appdata/velodrome</Config>
|
||||||
<Config Name="VELODROME_PUBLIC_URL" Target="VELODROME_PUBLIC_URL" Default="" Mode="" Description="The externally-visible URL this instance is reachable at, e.g. https://bikes.example.com. Must match exactly what's in the browser's address bar — it's checked against the Origin header on cookie-authenticated requests to stop cross-site request forgery." Type="Variable" Display="always" Required="true" Mask="false"></Config>
|
<Config Name="VELODROME_PUBLIC_URL" Target="VELODROME_PUBLIC_URL" Default="" Mode="" Description="The externally-visible URL this instance is reachable at, e.g. https://bikes.example.com. Must match exactly what's in the browser's address bar — it's checked against the Origin header on cookie-authenticated requests to stop cross-site request forgery." Type="Variable" Display="always" Required="true" Mask="false"></Config>
|
||||||
<Config Name="VELODROME_SECRET_KEY" Target="VELODROME_SECRET_KEY" Default="" Mode="" Description="A random secret, 32+ bytes. Generate one with: openssl rand -hex 32. The image ships an insecure development placeholder — always override this before exposing the container to anything." Type="Variable" Display="always" Required="true" Mask="true"></Config>
|
<Config Name="VELODROME_SECRET_KEY" Target="VELODROME_SECRET_KEY" Default="" Mode="" Description="A random secret, 32+ bytes. Generate one with: openssl rand -hex 32. The image ships an insecure development placeholder — always override this before exposing the container to anything." Type="Variable" Display="always" Required="true" Mask="true"></Config>
|
||||||
|
|||||||
@@ -233,10 +233,192 @@ image out is a manual/Unraid-side action (pull + Apply, or Unraid's own update c
|
|||||||
something CI does unattended — consistent with treating "affects a shared, already-running system"
|
something CI does unattended — consistent with treating "affects a shared, already-running system"
|
||||||
as something a human triggers, not automation.
|
as something a human triggers, not automation.
|
||||||
|
|
||||||
|
### D17 — Registry TLS: self-signed cert behind NPMplus, not `insecure-registries`, not a real domain
|
||||||
|
|
||||||
|
**Problem:** `release.yml`'s first real run failed — `docker/login-action` against
|
||||||
|
`192.168.0.3:3000` (Gitea's plain-HTTP address) hit `server gave HTTP response to HTTPS client`.
|
||||||
|
Docker refuses TLS-less registries by default; this was never a workflow misconfiguration, it's
|
||||||
|
expected Docker behaviour for any non-localhost registry.
|
||||||
|
|
||||||
|
**Rejected: `insecure-registries` in `daemon.json`.** The obvious fix. Rejected after actually
|
||||||
|
reading `/etc/rc.d/rc.docker` on the Unraid host rather than assuming: applying a `daemon.json`
|
||||||
|
change requires a full `dockerd` restart, and (with `Live Restore` disabled on this host) both
|
||||||
|
Unraid's own restart path *and* a raw `kill` of `dockerd` stop every one of the ~40 other
|
||||||
|
containers running on the box first, as part of the restart/shutdown sequence — Plex, Home
|
||||||
|
Assistant, Vaultwarden, everything. Correct fix for the narrow problem, unacceptable blast radius
|
||||||
|
for this specific host.
|
||||||
|
|
||||||
|
**Rejected: a real Let's Encrypt cert on a new `bbergle.com` subdomain routed publicly.** The
|
||||||
|
user's other NPMplus-fronted subdomains resolve through Cloudflare's proxy (orange-cloud), not
|
||||||
|
directly to the home IP. A Cloudflare-proxied hostname would have terminated TLS at Cloudflare's
|
||||||
|
edge with Cloudflare's own cert, never reaching our self-signed cert or NPMplus's own TLS
|
||||||
|
config at all — the entire trust chain would depend on Cloudflare's origin SSL mode, and likely on
|
||||||
|
firewall rules restricting port 443 to Cloudflare's IP ranges, neither of which this problem
|
||||||
|
needed to involve.
|
||||||
|
|
||||||
|
**Chosen:** a small, fully self-contained fix, scoped to touch nothing already working:
|
||||||
|
- A 10-year self-signed cert for `registry.bbergle.com` (SAN-only, no real domain dependency).
|
||||||
|
- An NPMplus proxy host (`registry.bbergle.com` -> `192.168.0.3:3000` over plain HTTP internally)
|
||||||
|
terminating TLS with that cert, on NPMplus's existing HTTPS port (`9537` on this host — found by
|
||||||
|
reading `docker port NPMplus` rather than assuming 443, which is a *different* nginx process on
|
||||||
|
this box entirely).
|
||||||
|
- `/etc/hosts` on the Unraid host mapping `registry.bbergle.com` -> `192.168.0.103` (itself) —
|
||||||
|
chosen over a real DNS record specifically because the only client that ever needs to resolve
|
||||||
|
this hostname is the Unraid host's own `dockerd` (Gitea Actions runs in DooD mode against that
|
||||||
|
same host's Docker socket). This sidesteps Cloudflare, the router's NAT/hairpin behaviour, and
|
||||||
|
any port-forwarding question entirely — verified separately that hairpin NAT works by default on
|
||||||
|
this user's UniFi gateway, but it turned out to be unnecessary for this fix regardless.
|
||||||
|
- `/etc/docker/certs.d/registry.bbergle.com:9537/ca.crt` on the Unraid host, trusting that cert for
|
||||||
|
that host:port specifically. Confirmed (Docker's own docs) that `certs.d` is read per-connection,
|
||||||
|
not baked in at daemon start — no `dockerd` restart, no impact on any other container.
|
||||||
|
- `docker/setup-buildx-action@v3` pinned to `driver: docker` in `release.yml` instead of its
|
||||||
|
default `docker-container` driver — the default runs BuildKit in an isolated builder container
|
||||||
|
that does not see the host's `/etc/docker/certs.d`, which would have silently defeated the whole
|
||||||
|
point of the trust setup above. We don't build multi-platform images, so nothing the
|
||||||
|
`docker-container` driver offers is actually needed here.
|
||||||
|
|
||||||
|
**Not persisted across a reboot, deliberately, for now:** neither the `/etc/hosts` line nor the
|
||||||
|
`certs.d` file are wired into `/boot/config/go` — both live under `/`, which Unraid rebuilds fresh
|
||||||
|
from `/boot` on every boot. Raised explicitly rather than assumed: the user was (rightly) wary of
|
||||||
|
hand-editing anything under `/boot` after an earlier, unrelated discussion of what a broken `go`
|
||||||
|
script could do to boot. Persisting this is a five-minute follow-up (append two lines to `go`) once
|
||||||
|
they're ready to make that call deliberately, not bundled into this fix.
|
||||||
|
|
||||||
|
**What's unaffected:** Gitea's own web UI, git remote, and API — all still plain
|
||||||
|
`http://192.168.0.3:3000`, exactly as CLAUDE.md documents. NPMplus's existing public proxy hosts
|
||||||
|
and certs (`vaultwarden.bbergle.com` etc.) — untouched, new proxy host only. No other container on
|
||||||
|
the Unraid host was restarted, reconfigured, or otherwise touched to make this work.
|
||||||
|
|
||||||
|
### D18 — Admin bootstrap is a CLI command, not an HTTP endpoint or a first-run mode
|
||||||
|
|
||||||
|
**Chosen:** `velodrome create-admin`, a console script (`[project.scripts]` in
|
||||||
|
`apps/api/pyproject.toml` → `velodrome.cli:main`) installed into the same venv as `alembic` and
|
||||||
|
`uvicorn`, so the deployed image already has it on PATH:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
docker exec -it velodrome velodrome create-admin --email you@example.com
|
||||||
|
```
|
||||||
|
|
||||||
|
**Why this exists at all:** registration requires a valid invite code (`docs/PLAN.md` "Auth" — open
|
||||||
|
signup does not exist, not even as a setting), invites can only be created by an existing admin,
|
||||||
|
and a freshly migrated database has neither. A new deployment was therefore unusable: there was no
|
||||||
|
way to create the first account. `docs/PLAN.md` always called for this command; it was simply never
|
||||||
|
built during Phase 0, and the gap only became visible once D16 made a real deployment possible.
|
||||||
|
|
||||||
|
**Why a CLI rather than the alternatives:**
|
||||||
|
- *A bootstrap HTTP endpoint that works only while the users table is empty* — rejected. It puts an
|
||||||
|
unauthenticated account-creating route on the public internet permanently, whose safety depends
|
||||||
|
entirely on a row count staying zero. The window is real (between first start and first login),
|
||||||
|
it's the exact window where the deployment is least watched, and the failure is silent: whoever
|
||||||
|
wins the race owns the instance.
|
||||||
|
- *An env var like `VELODROME_INITIAL_ADMIN_PASSWORD`* — rejected. A password in an env var is
|
||||||
|
visible in `docker inspect`, in the Unraid template's saved config on disk, and in the container's
|
||||||
|
own `/proc/1/environ` for the process's whole life. D16 deliberately moved configuration into
|
||||||
|
Unraid's UI, which would mean the bootstrap password sitting in that UI indefinitely.
|
||||||
|
- *Seeding a default account in a migration* — rejected outright. It would mean a known-credential
|
||||||
|
account existing on every deployment, and it contradicts the reason migrations are schema-only.
|
||||||
|
|
||||||
|
**Why it refuses an email that already exists, rather than updating it:** creating an account and
|
||||||
|
resetting an existing account's password are different operations with different blast radii, and
|
||||||
|
the realistic scenario — an operator re-running a command they last ran months ago, from shell
|
||||||
|
history — means the first, never the second. Silently accepting it would make this an undocumented
|
||||||
|
password-reset tool that any container-exec grants, and would make the command's behaviour depend
|
||||||
|
on state the operator can't see. It exits 1 and says what it refused. A genuine password reset is a
|
||||||
|
separate future command that should have to say so in its name.
|
||||||
|
|
||||||
|
**Why it is *not* restricted to "only when there are zero users":** that restriction sounds safer
|
||||||
|
and isn't. It buys nothing — the command already requires the ability to run a process inside the
|
||||||
|
container, which is already the ability to read and rewrite the SQLite file directly, so a
|
||||||
|
restriction only constrains the legitimate operator, never an attacker who is by definition already
|
||||||
|
past it. Meanwhile it removes the two cases that actually happen: a second admin for a family
|
||||||
|
member, and recovering an instance whose only admin account was lost. The invite system remains the
|
||||||
|
normal path for adding users; this stays the operator's escape hatch.
|
||||||
|
|
||||||
|
**Why `role="admin"` is recorded but nothing enforces it yet:** there is no admin-only endpoint to
|
||||||
|
protect. Invite management — the first thing that genuinely needs the distinction — is Phase 1.
|
||||||
|
Writing the column now means the first account is correctly marked when that check does arrive,
|
||||||
|
rather than needing a data fix-up later; writing an *enforcement* mechanism now would be guessing at
|
||||||
|
the shape of a check with no caller. `ROLE_ADMIN`/`ROLE_MEMBER` are named constants in
|
||||||
|
`models/identity.py`, and the column stays a plain string rather than a DB enum or CHECK constraint
|
||||||
|
so a third role later is an application change, not a migration. `AuthenticatedSession.role` carries
|
||||||
|
the value for that future check; it is deliberately absent from `schemas.auth.UserOut`, so this
|
||||||
|
changes no HTTP response and no OpenAPI contract.
|
||||||
|
|
||||||
|
**Why there is no `--password` flag:** an argument lands in shell history, in `ps` output for the
|
||||||
|
process's lifetime, and — because the realistic invocation is `docker exec` — in the Docker daemon's
|
||||||
|
record of the exec'd command. A TTY prompt (with confirmation) and `--password-stdin` are the two
|
||||||
|
forms that avoid all three, which is the same pair `docker login` offers for the same reason.
|
||||||
|
Pydantic's `ValidationError` rendering is also deliberately not printed verbatim: it embeds the
|
||||||
|
offending value, which for a too-short password prints the password to the terminal. Only `loc` and
|
||||||
|
`msg` are shown (CLAUDE.md invariant #5); `tests/test_cli.py` asserts this on both the failure and
|
||||||
|
success paths.
|
||||||
|
|
||||||
|
**argparse, not Typer/Click:** one command with three options doesn't justify a runtime dependency
|
||||||
|
the deployed image has to carry.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### D19 — Auto-update: attempted, deferred; Unraid's own update checker needed a separate fix
|
||||||
|
|
||||||
|
**The immediate bug:** Unraid's Docker "check for updates" reported `not available` for `velodrome`
|
||||||
|
after D17's registry move. Root cause, found by reading the actual PHP source
|
||||||
|
(`dynamix.docker.manager`'s `DockerClient.php`): it queries the registry's manifest API directly
|
||||||
|
over `curl` from PHP, which is a completely different trust path from `dockerd`'s own — it doesn't
|
||||||
|
read Docker's `/etc/docker/certs.d` at all, only the OS-wide CA bundle. **Fixed** by also adding the
|
||||||
|
D17 self-signed cert to `/usr/local/share/ca-certificates/` and running `update-ca-certificates` on
|
||||||
|
the Unraid host — a third, independent place this cert now needs to be trusted (alongside
|
||||||
|
`certs.d` and the `/etc/hosts` entry from D17), and like those two, not yet persisted across a
|
||||||
|
reboot (`/boot/config/go` again — same deliberate non-decision as D17).
|
||||||
|
|
||||||
|
**A second, structural problem this exposed, not fixed:** even with the checker itself working,
|
||||||
|
"up to date" on this host doesn't reliably mean the *running container* matches the registry.
|
||||||
|
Gitea Actions builds directly on this same host's `dockerd` (DooD), which means every CI build also
|
||||||
|
leaves its own result sitting in the **local image cache** tagged `:latest` — so the local-vs-remote
|
||||||
|
digest comparison Unraid's checker does is comparing the registry against a tag that CI keeps fresh
|
||||||
|
on its own, independent of whether the `velodrome` *container* was ever recreated from it. Confirmed
|
||||||
|
directly: the checker reported "up to date" while the running container's actual manifest digest
|
||||||
|
(read via `docker inspect`) provably differed from the registry's current `Docker-Content-Digest`.
|
||||||
|
This is a consequence of building CI on the same host as the app runs, not a bug to patch around —
|
||||||
|
see the Gitea-to-VM item below.
|
||||||
|
|
||||||
|
**Attempted: Watchtower**, label-scoped (`WATCHTOWER_LABEL_ENABLE=true` + a
|
||||||
|
`com.centurylinklabs.watchtower.enable=true` label on `velodrome` only, specifically so it can never
|
||||||
|
touch any of the ~40 other containers on this host) with the CA bundle mounted in for the same
|
||||||
|
registry-trust reason as above. **Failed on the first attempt** — `containrrr/watchtower`'s
|
||||||
|
published image talks a Docker API version (1.25) too old for this host's `dockerd`, a stale-image
|
||||||
|
problem, not a design problem. Not yet retried with a maintained fork. The `velodrome` container
|
||||||
|
does carry the watch-enable label already (added when it was recreated to pick up D18's CLI), so
|
||||||
|
turning this on later is "run the right watchtower image," not "redesign anything."
|
||||||
|
|
||||||
|
**Why not have CI redeploy the container directly** (it already has host `dockerd` access via DooD):
|
||||||
|
considered and explicitly rejected, again — see D16/D17's reasoning, which this doesn't change.
|
||||||
|
Turning every merge to `main` into an unattended production change on a personal server is a bigger
|
||||||
|
step than "install an auto-updater," and wasn't asked for.
|
||||||
|
|
||||||
|
**Until this is finished:** redeploying after a merge is `docker pull` + recreate, same as any
|
||||||
|
manual deploy — `deploy/README.md`'s "Publishing the image" section.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Deliberately deferred
|
## Deliberately deferred
|
||||||
|
|
||||||
|
- **Finish the Watchtower auto-updater** (D19) — retry with a maintained image; `velodrome` is
|
||||||
|
already labeled for it.
|
||||||
|
- **Migrate Gitea + its Actions runners to a dedicated VM**, off the Unraid host the app itself
|
||||||
|
runs on. Raised explicitly (not yet started) after D17/D19 both turned out to be fighting the
|
||||||
|
same root cause from different angles: CI sharing a `dockerd` with ~40 unrelated production
|
||||||
|
containers means every registry-trust fix and every update-check quirk this session hit was more
|
||||||
|
contained, and more repeatable to reason about, than it should have needed to be. A dedicated VM
|
||||||
|
removes that coupling entirely — CI's own Docker config becomes free to change without any
|
||||||
|
blast-radius conversation about Plex or Vaultwarden ever again. Real migration work (new VM,
|
||||||
|
moving Gitea's and both runners' appdata, re-pointing `192.168.0.3`, updating every reference to
|
||||||
|
it across this repo and this session's own tooling), not a quick fix — a deliberate choice to do
|
||||||
|
later, not an oversight now.
|
||||||
|
- **Persist the D17/D19 host-local trust files across a reboot** (`/etc/hosts`, `certs.d`, the CA
|
||||||
|
bundle addition) via `/boot/config/go`. Left un-persisted through both decisions specifically
|
||||||
|
because editing anything under `/boot` was raised as a real concern mid-session — worth revisiting
|
||||||
|
together once, for all three at once, rather than as three separate asks.
|
||||||
|
|
||||||
- **Routing** (Valhalla/Photon/Overpass) — Phase 5, optional. Several GB of RAM for something
|
- **Routing** (Valhalla/Photon/Overpass) — Phase 5, optional. Several GB of RAM for something
|
||||||
Komoot already does well.
|
Komoot already does well.
|
||||||
- **Local LLM ride summaries** (Ollama) — Phase 4, behind a compose profile.
|
- **Local LLM ride summaries** (Ollama) — Phase 4, behind a compose profile.
|
||||||
|
|||||||
+32
-9
@@ -529,13 +529,31 @@ These are the payoff for self-hosting — things Strava structurally cannot do.
|
|||||||
|
|
||||||
Estimates assume one developer working evenings and weekends.
|
Estimates assume one developer working evenings and weekends.
|
||||||
|
|
||||||
**Phase 0 — Scaffolding (2 weeks).** Monorepo, `uv`/`ruff`/`mypy --strict`, FastAPI skeleton with
|
**Phase 0 — Scaffolding.** ✅ **Done, with two deliberate deviations from this original description —
|
||||||
`/healthz` and OpenAPI, Alembic baseline (users/invites/sessions **with RLS policies from the first
|
both recorded in `docs/DECISIONS.md`, not silent drift.** Monorepo, `uv`/`ruff`/`mypy --strict`,
|
||||||
migration**), SvelteKit static SPA shell with login, manifest + service worker + precache passing
|
FastAPI skeleton with `/healthz` and OpenAPI, Alembic baseline (users/invites/sessions), SvelteKit
|
||||||
Lighthouse installability, VAPID keypair, Caddy, compose, Gitea Actions green, image in the registry,
|
static SPA shell with login, manifest + service worker, Caddy, Gitea Actions green, image in the
|
||||||
deployed.
|
registry, deployed to a real Unraid host behind real HTTPS.
|
||||||
*Done when:* you log in at the real URL, add it to your iPhone home screen, it launches standalone —
|
|
||||||
and a push to `main` rebuilds and redeploys it.
|
- **SQLite, not Postgres+RLS.** D15 reversed D4 mid-Phase-0, after the RLS version was already
|
||||||
|
shipped and merged. Isolation is now enforced entirely at the repository layer (`db.py`'s
|
||||||
|
`Scope`), not database RLS. See D15 for the full cost/benefit record.
|
||||||
|
- **CI builds and pushes on every push to `main`, but does not auto-redeploy the running
|
||||||
|
container.** D16/D17 made this deliberate: the runner shares this Unraid host's own `dockerd`
|
||||||
|
(DooD), and an unattended redeploy of a container on a personal server with no human gate was
|
||||||
|
judged the wrong default. A push to `main` gets you a new image in the registry within minutes;
|
||||||
|
getting it onto the running container is still a manual step (`deploy/README.md`). An
|
||||||
|
auto-updater (Watchtower or similar) was attempted and deferred — see "Deliberately deferred"
|
||||||
|
in `docs/DECISIONS.md`.
|
||||||
|
- **VAPID/push notifications were never started.** Correctly so — per this doc's own PWA-decision
|
||||||
|
table, that's gated behind standalone-mode detection and belongs to a later phase, not Phase 0.
|
||||||
|
|
||||||
|
*Done when — status:* Logging in at the real URL (`https://bike.bbergle.com`) and seeing an
|
||||||
|
authenticated view of your own account is **verified**, including the session actually persisting
|
||||||
|
(`scripts/smoke-test.sh`, added after a real Secure-cookie-over-HTTP bug on the first deploy — see
|
||||||
|
that script's header comment). **Not yet tried:** adding it to an iPhone home screen and confirming
|
||||||
|
a standalone launch — nobody has actually done this yet, so it isn't checked off, even though the
|
||||||
|
manifest and service worker are in place.
|
||||||
|
|
||||||
**Phase 1 — Zero-touch ride history (6–8 weeks).** Ingestion core (all three dedupe layers, course
|
**Phase 1 — Zero-touch ride history (6–8 weeks).** Ingestion core (all three dedupe layers, course
|
||||||
discrimination, quarantine); **the Bryton cloud poller as the primary path**, polling every 15 min with
|
discrimination, quarantine); **the Bryton cloud poller as the primary path**, polling every 15 min with
|
||||||
@@ -654,8 +672,13 @@ because if the project stalls right after it, it has still succeeded.
|
|||||||
activity reaches Bryton's cloud with the phone switched off. Then plug it in over USB and `ls -R` the
|
activity reaches Bryton's cloud with the phone switched off. Then plug it in over USB and `ls -R` the
|
||||||
mounted volume to confirm the actual `.fit` path.
|
mounted volume to confirm the actual `.fit` path.
|
||||||
|
|
||||||
**Phase 0:** `curl https://host/healthz` returns 200; push to `main` produces a new registry image and
|
**Phase 0 — done, verified for real, not just assumed from CI going green:** `curl https://host/healthz`
|
||||||
a redeployed container; `docker compose logs` shows migrations applied.
|
returns 200; a push to `main` produces a new registry image (`docs/DECISIONS.md` D17's release
|
||||||
|
workflow) — redeploying the running container from it is a manual step (D16/D17), not automatic;
|
||||||
|
`docker exec velodrome velodrome create-admin` bootstraps the first user (D18); logging in at the
|
||||||
|
real HTTPS URL and staying logged in on the next request is checked by `scripts/smoke-test.sh`, not
|
||||||
|
eyeballed in a browser, after that exact failure mode (a `Secure` cookie silently dropped when
|
||||||
|
tested over plain HTTP) actually happened on the first deploy.
|
||||||
|
|
||||||
**Phase 1 — ingestion:**
|
**Phase 1 — ingestion:**
|
||||||
- Upload a real Rider 650 `.fit` → activity appears with correct distance, elevation, and map track.
|
- Upload a real Rider 650 `.fit` → activity appears with correct distance, elevation, and map track.
|
||||||
|
|||||||
Executable
+77
@@ -0,0 +1,77 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
# Post-deploy smoke test: proves a login -> authenticated request round trip actually works
|
||||||
|
# against a REAL deployed instance, over the network, the way a browser sees it.
|
||||||
|
#
|
||||||
|
# Exists because pytest (real SQLite, no mocks — see CLAUDE.md) proves the API logic is
|
||||||
|
# correct in isolation, but can't catch topology-specific failures. Concretely: a session
|
||||||
|
# cookie is set with `Secure` in production (velodrome/api/v1/auth.py), which browsers
|
||||||
|
# silently refuse to store unless the request was actually served over HTTPS. Hit the app via
|
||||||
|
# a plain-HTTP address (an IP, a port, skipping the reverse proxy) and `/auth/login` still
|
||||||
|
# returns 200 with valid credentials, and the cookie header is still sent — it's just quietly
|
||||||
|
# dropped, so the very next request looks unauthenticated. From a browser this looks exactly
|
||||||
|
# like "I logged in and it bounced me straight back to the login screen," with no error
|
||||||
|
# anywhere. Caught for real the first time this got deployed; this script exists so it's
|
||||||
|
# caught by running a command, not by refreshing a browser tab.
|
||||||
|
#
|
||||||
|
# Usage:
|
||||||
|
# scripts/smoke-test.sh <base_url> <email> <password>
|
||||||
|
# scripts/smoke-test.sh https://bike.bbergle.com you@example.com yourpassword
|
||||||
|
#
|
||||||
|
# Doesn't create the account — bootstrap one first with
|
||||||
|
# `docker exec -it velodrome velodrome create-admin --email you@example.com`, then reuse
|
||||||
|
# those credentials here (or keep a small dedicated account around just for this).
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
BASE_URL="${1:?usage: smoke-test.sh <base_url> <email> <password>}"
|
||||||
|
EMAIL="${2:?usage: smoke-test.sh <base_url> <email> <password>}"
|
||||||
|
PASSWORD="${3:?usage: smoke-test.sh <base_url> <email> <password>}"
|
||||||
|
BASE_URL="${BASE_URL%/}"
|
||||||
|
|
||||||
|
COOKIEJAR="$(mktemp)"
|
||||||
|
LOGIN_BODY="$(mktemp)"
|
||||||
|
ME_BODY="$(mktemp)"
|
||||||
|
trap 'rm -f "$COOKIEJAR" "$LOGIN_BODY" "$ME_BODY"' EXIT
|
||||||
|
|
||||||
|
echo "-> logging in as $EMAIL at $BASE_URL"
|
||||||
|
LOGIN_STATUS=$(curl -s -o "$LOGIN_BODY" -w '%{http_code}' \
|
||||||
|
-c "$COOKIEJAR" \
|
||||||
|
-X POST "$BASE_URL/api/v1/auth/login" \
|
||||||
|
-H 'Content-Type: application/json' \
|
||||||
|
-d "{\"email\":\"$EMAIL\",\"password\":\"$PASSWORD\"}")
|
||||||
|
|
||||||
|
if [ "$LOGIN_STATUS" != "200" ]; then
|
||||||
|
echo "FAIL: login returned $LOGIN_STATUS, expected 200"
|
||||||
|
cat "$LOGIN_BODY"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
echo " login: 200 OK"
|
||||||
|
|
||||||
|
if ! grep -q "_session" "$COOKIEJAR" 2>/dev/null; then
|
||||||
|
echo "FAIL: login succeeded but no session cookie was actually stored by the client."
|
||||||
|
echo " Almost certainly a Secure-cookie-over-HTTP mismatch — see the comment at the"
|
||||||
|
echo " top of this script. Are you testing via HTTPS through the real reverse proxy,"
|
||||||
|
echo " or a plain-HTTP address (an IP, a bare port)?"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
echo " session cookie: stored"
|
||||||
|
|
||||||
|
echo "-> confirming the session actually authenticates a follow-up request"
|
||||||
|
ME_STATUS=$(curl -s -o "$ME_BODY" -w '%{http_code}' -b "$COOKIEJAR" "$BASE_URL/api/v1/auth/me")
|
||||||
|
|
||||||
|
if [ "$ME_STATUS" != "200" ]; then
|
||||||
|
echo "FAIL: /auth/me returned $ME_STATUS after a successful login — the session isn't"
|
||||||
|
echo " persisting. This is exactly the 'logs in, bounces back to the login screen'"
|
||||||
|
echo " symptom a browser would show."
|
||||||
|
cat "$ME_BODY"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
ME_EMAIL=$(python3 -c "import json,sys; print(json.load(open(sys.argv[1]))['email'])" "$ME_BODY" 2>/dev/null || echo "?")
|
||||||
|
|
||||||
|
if [ "$ME_EMAIL" != "$EMAIL" ]; then
|
||||||
|
echo "FAIL: /auth/me returned a different account ($ME_EMAIL) than the one that logged in ($EMAIL)."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo " /auth/me: 200 OK, confirmed as $ME_EMAIL"
|
||||||
|
echo "PASS: login -> authenticated request round trip works end to end at $BASE_URL"
|
||||||
Reference in New Issue
Block a user