mirror of
https://github.com/Routstr/routstr-core.git
synced 2026-08-11 19:57:32 +00:00
docs: reflect the optional, auto-generated secret key
The secret-key docs still said ROUTSTR_SECRET_KEY was required and that the node would not start without it. Update the README, .env.example, and the provider docs (configuration, quickstart, deployment) to the current behaviour: the key is optional; when unset the node generates one beside the database, so it persists on the same volume as the data, and prints a one-time back-it-up notice; set it explicitly to manage the key yourself. Switch the generation and reset snippets to `uv run python`, and add the containerised reset variant. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
co-authored by
Claude Opus 4.8
parent
7106dfe330
commit
d4657dca5a
+6
-3
@@ -5,9 +5,12 @@ UPSTREAM_API_KEY=your-upstream-api-key
|
||||
# Tinfoil (confidential inference enclaves, EHBP)
|
||||
# TINFOIL_API_KEY=your-tinfoil-api-key
|
||||
|
||||
# Secret key used to encrypt secrets at rest (REQUIRED). The node refuses to
|
||||
# start without it. Generate one with:
|
||||
# python -c "from cryptography.fernet import Fernet; print(Fernet.generate_key().decode())"
|
||||
# Secret key used to encrypt node secrets at rest (optional). If unset, the node
|
||||
# generates one on first start, writes it to routstr_secret.key (override the path
|
||||
# with ROUTSTR_SECRET_KEY_FILE), and prints it once — back that file up, because
|
||||
# losing the key makes previously encrypted secrets unreadable. Set it explicitly
|
||||
# to manage the key yourself (recommended in production). Generate one with:
|
||||
# uv run python -c "from cryptography.fernet import Fernet; print(Fernet.generate_key().decode())"
|
||||
ROUTSTR_SECRET_KEY=
|
||||
|
||||
# The admin password and the Nostr identity (nsec) are NOT set here. The admin
|
||||
|
||||
Reference in New Issue
Block a user