CI & Build / Python lint (push) Successful in 3s
CI & Build / Plugin hooks (push) Successful in 12s
CI & Build / TypeScript typecheck (push) Successful in 56s
CI & Build / integration (push) Successful in 1m4s
CI & Build / Python tests (push) Successful in 1m55s
CI & Build / Build & push image (push) Successful in 44s
Step 2 of the Scribe -> Grimoire rename. - src/scribe -> src/grimoire, and every import, patch target, module path, hypercorn entry point and `python -m grimoire.restore` with it; pyproject, uv.lock and the frontend package are named grimoire. - Image git.fabledsword.com/bvandeusen/fabledgrimoire; CI's Postgres service runs as grimoire / grimoire_test. - Compose files default the DB user, database and (prod) volume to grimoire, each overridable from .env, so an install created as Scribe keeps its data by setting POSTGRES_USER, POSTGRES_DB and PGDATA_VOLUME. - Backups are written as grimoire-<ts>.tar with format grimoire-backup-tar. Archives named scribe-* with the scribe-backup-tar manifest still restore and are still counted at the destination (folder and S3), with tests. - Exports, the MCP auth realm, the ASGI scope key and the persistent logger carry the new name. Kept on purpose: the secret-sealing key label stays "scribe.secrets.v1", because every stored secret was derived under it. Plugin identity (plugin name, hooks, env vars, .scribe marker, skills) is step 3. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
101 lines
4.9 KiB
Python
101 lines
4.9 KiB
Python
import os
|
|
|
|
|
|
def _read_secret(env_var: str, secret_file_var: str, default: str) -> str:
|
|
"""Read a config value from env var, or from a Docker secrets file."""
|
|
value = os.environ.get(env_var)
|
|
if value:
|
|
return value
|
|
secret_file = os.environ.get(secret_file_var)
|
|
if secret_file:
|
|
try:
|
|
with open(secret_file) as f:
|
|
return f.read().strip()
|
|
except FileNotFoundError:
|
|
pass
|
|
return default
|
|
|
|
|
|
class Config:
|
|
DATABASE_URL: str = _read_secret(
|
|
"DATABASE_URL",
|
|
"DATABASE_URL_FILE",
|
|
"postgresql+asyncpg://grimoire:grimoire@localhost:5432/grimoire",
|
|
)
|
|
SECRET_KEY: str = _read_secret("SECRET_KEY", "SECRET_KEY_FILE", "dev-secret-change-me")
|
|
SECURE_COOKIES: bool = os.environ.get("SECURE_COOKIES", "").lower() in ("1", "true", "yes")
|
|
LOG_LEVEL: str = os.environ.get("LOG_LEVEL", "INFO")
|
|
LOG_RETENTION_DAYS: int = int(os.environ.get("LOG_RETENTION_DAYS", "90"))
|
|
|
|
# SMTP defaults (overridden by DB settings when configured via admin UI)
|
|
SMTP_HOST: str = os.environ.get("SMTP_HOST", "")
|
|
SMTP_PORT: int = int(os.environ.get("SMTP_PORT", "587"))
|
|
SMTP_USERNAME: str = os.environ.get("SMTP_USERNAME", "")
|
|
SMTP_PASSWORD: str = _read_secret("SMTP_PASSWORD", "SMTP_PASSWORD_FILE", "")
|
|
SMTP_FROM_ADDRESS: str = os.environ.get("SMTP_FROM_ADDRESS", "")
|
|
SMTP_FROM_NAME: str = os.environ.get("SMTP_FROM_NAME", "Fabled Grimoire")
|
|
SMTP_USE_TLS: bool = os.environ.get("SMTP_USE_TLS", "true").lower() in ("1", "true", "yes")
|
|
BASE_URL: str = os.environ.get("BASE_URL", "http://localhost:5000").rstrip("/")
|
|
TRUST_PROXY_HEADERS: bool = os.environ.get("TRUST_PROXY_HEADERS", "").lower() in ("1", "true", "yes")
|
|
|
|
# Git URL of the repo that ships this Grimoire plugin. There is one correct
|
|
# value per deployment (the repo serving the plugin), so it's a config
|
|
# default — not something each user types. Surfaced in Settings → MCP Access
|
|
# as the default install-command marketplace; an admin can still override it
|
|
# per-instance via the Plugin marketplace setting.
|
|
PLUGIN_MARKETPLACE_URL: str = os.environ.get(
|
|
"PLUGIN_MARKETPLACE_URL",
|
|
"https://git.fabledsword.com/bvandeusen/FabledScribe.git",
|
|
)
|
|
|
|
# OIDC / OAuth2 SSO (e.g. Authentik)
|
|
OIDC_ISSUER: str = os.environ.get("OIDC_ISSUER", "")
|
|
OIDC_CLIENT_ID: str = os.environ.get("OIDC_CLIENT_ID", "")
|
|
OIDC_CLIENT_SECRET: str = _read_secret("OIDC_CLIENT_SECRET", "OIDC_CLIENT_SECRET_FILE", "")
|
|
OIDC_SCOPES: str = os.environ.get("OIDC_SCOPES", "openid profile email")
|
|
LOCAL_AUTH_ENABLED: bool = os.environ.get("LOCAL_AUTH_ENABLED", "true").lower() not in ("0", "false", "no")
|
|
|
|
# SearXNG web search (external instance). Currently only surfaced via
|
|
# /api/settings/search for the Integrations tab's status indicator —
|
|
# the MCP layer doesn't proxy web search (Claude has its own).
|
|
SEARXNG_URL: str = os.environ.get("SEARXNG_URL", "")
|
|
|
|
# Git forge integration — optional read access to a git forge so
|
|
# snippet bodies can be fetched/verified server-side. Connections are
|
|
# per-user keyring rows (Settings → Git forges); these env values
|
|
# survive as an implicit keyring entry for ADMIN users' projects only, so
|
|
# a deployment can keep the operator's token in a Docker secret instead
|
|
# of the database. A stored row for the same host wins over the env entry.
|
|
FORGE_KIND: str = os.environ.get("FORGE_KIND", "")
|
|
FORGE_BASE_URL: str = os.environ.get("FORGE_BASE_URL", "").rstrip("/")
|
|
FORGE_TOKEN: str = _read_secret("FORGE_TOKEN", "FORGE_TOKEN_FILE", "")
|
|
FORGE_WEBHOOK_SECRET: str = _read_secret(
|
|
"FORGE_WEBHOOK_SECRET", "FORGE_WEBHOOK_SECRET_FILE", ""
|
|
)
|
|
|
|
@classmethod
|
|
def oidc_enabled(cls) -> bool:
|
|
return bool(cls.OIDC_ISSUER and cls.OIDC_CLIENT_ID and cls.OIDC_CLIENT_SECRET)
|
|
|
|
@classmethod
|
|
def searxng_enabled(cls) -> bool:
|
|
return bool(cls.SEARXNG_URL)
|
|
|
|
@classmethod
|
|
def validate(cls) -> None:
|
|
"""Validate critical config values at startup. Raises ValueError on misconfiguration."""
|
|
errors: list[str] = []
|
|
if cls.LOG_RETENTION_DAYS < 1:
|
|
errors.append(f"LOG_RETENTION_DAYS={cls.LOG_RETENTION_DAYS} must be >= 1")
|
|
if not (1 <= cls.SMTP_PORT <= 65535):
|
|
errors.append(f"SMTP_PORT={cls.SMTP_PORT} must be between 1 and 65535")
|
|
if cls.oidc_enabled() and not cls.BASE_URL.startswith(("http://", "https://")):
|
|
errors.append(f"BASE_URL='{cls.BASE_URL}' must start with http:// or https:// when OIDC is enabled")
|
|
if cls.SECRET_KEY == "dev-secret-change-me" and cls.SECURE_COOKIES:
|
|
errors.append(
|
|
"SECRET_KEY is set to the insecure default but SECURE_COOKIES=true indicates "
|
|
"a production deployment. Set SECRET_KEY or SECRET_KEY_FILE before starting."
|
|
)
|
|
if errors:
|
|
raise ValueError("Configuration errors:\n" + "\n".join(f" - {e}" for e in errors))
|