Skip to content

Commit 3911bb0

Browse files
committed
docs: document NEXT_SERVER_ACTIONS_ENCRYPTION_KEY requirement
Signed-off-by: Andrew Leng <[email protected]>
1 parent 03c892a commit 3911bb0

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,12 +54,24 @@ Create an `.env` file with the following:
5454
DATABASE_URL=connection-url
5555
```
5656

57+
If you are running Umami v3 or newer you must also set the encryption key required by Next.js Server Actions:
58+
59+
```bash
60+
NEXT_SERVER_ACTIONS_ENCRYPTION_KEY=your-64-character-hex-string
61+
```
62+
5763
The connection URL format:
5864

5965
```bash
6066
postgresql://username:mypassword@localhost:5432/mydb
6167
```
6268

69+
You can generate a secure 64-character hex encryption key (32 random bytes) with:
70+
71+
```bash
72+
openssl rand -hex 32
73+
```
74+
6375
### Build the Application
6476

6577
```bash

docker-compose.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ services:
88
DATABASE_URL: postgresql://umami:umami@db:5432/umami
99
DATABASE_TYPE: postgresql
1010
APP_SECRET: replace-me-with-a-random-string
11+
NEXT_SERVER_ACTIONS_ENCRYPTION_KEY: replace-me-with-a-64-character-hex-string
1112
depends_on:
1213
db:
1314
condition: service_healthy

0 commit comments

Comments
 (0)