Skip to content

Commit e0ee251

Browse files
committed
docs(readme): change env vars and dotenvx setup
1 parent 52072ce commit e0ee251

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@ First-run initialization (Actual Server):
3434
- Add the following to `.env.local` (mounted as `/app/.env` in the API container):
3535

3636
```
37-
ADMIN_PW=ChangeMe_very_strong!
37+
ADMIN_USER=admin
38+
ADMIN_PASSWORD=Password123!
3839
JWT_SECRET=replace-with-64b-random
3940
JWT_REFRESH_SECRET=replace-with-64b-random
4041
@@ -67,7 +68,8 @@ docker compose -f docker-compose.dev.yml up -d actual-server
6768
2. Set env vars locally and run the API:
6869

6970
```bash
70-
export ADMIN_PW=ChangeMe_very_strong!
71+
export ADMIN_USER=admin
72+
export ADMIN_PASSWORD=Password123!
7173
export JWT_SECRET=replace-with-64b-random
7274
export JWT_REFRESH_SECRET=replace-with-64b-random
7375
export ACTUAL_SERVER_URL=http://localhost:5006
@@ -93,12 +95,16 @@ This project uses **dotenvx** to manage encrypted environment files. In producti
9395

9496
```bash
9597
# Initialize dotenvx (generates .env.keys)
96-
dotenvx new
98+
echo "ADMIN_USER=admin" > .env
99+
dotenvx encrypt
100+
dotenvx decrypt
97101

98102
# Encrypt your production .env
99-
dotenvx set ADMIN_PW "your-production-password"
103+
dotenvx set ADMIN_PASSWORD "your-production-password"
100104
dotenvx set JWT_SECRET "your-production-jwt-secret"
101105
# ... repeat for other required vars
106+
107+
dotenvx encrypt
102108
```
103109

104110
2. Securely store the private key:
@@ -126,7 +132,7 @@ See the [docker-compose.yml](docker-compose.yml) for how it's wired up in contai
126132

127133
## Environment Variables
128134
- `ADMIN_USER`: admin username (default `admin`)
129-
- `ADMIN_PW`: required; admin password (validated for complexity)
135+
- `ADMIN_PASSWORD`: required; admin password (validated for complexity)
130136
- `SESSION_SECRET`: required in production (random in dev if omitted)
131137
- `JWT_SECRET`: required; HMAC secret for access tokens
132138
- `JWT_REFRESH_SECRET`: required; HMAC secret for refresh tokens

0 commit comments

Comments
 (0)