Skip to content

Commit 39481fd

Browse files
committed
docs(config): clarify that credentials.json is only written in auto-generation mode
1 parent ad79c65 commit 39481fd

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

pkgs/bay/config.yaml.example

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,17 +52,21 @@ cargo:
5252
security:
5353
# API Key authentication
5454
#
55-
# Bay supports two modes for API key configuration:
55+
# Bay supports three modes for API key configuration:
5656
#
5757
# 1. Auto-generation (default, recommended):
5858
# On first boot, Bay will:
5959
# - Auto-generate a key (sk-bay-...) and store its hash in the DB
6060
# - Write credentials.json for companion services (e.g., AstrBot)
6161
# Subsequent restarts will reuse the existing key from DB.
6262
#
63-
# 2. Environment variable override:
63+
# 2. Config file: set `api_key` below to a fixed key.
64+
# Seeds the key to DB on startup. credentials.json is NOT written
65+
# (you already know the key — configure companion services manually).
66+
#
67+
# 3. Environment variable override:
6468
# Set BAY_API_KEY=sk-bay-your-key to inject a specific key.
65-
# This seeds the key to DB on startup.
69+
# Seeds the key to DB on startup. credentials.json is NOT written.
6670

6771
# Allow anonymous access (no authentication required)
6872
# Development: true (default) - allows unauthenticated requests

0 commit comments

Comments
 (0)