You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(docker): promote install script to Option 1, reorder install paths
Self-hosters skimming DOCKER_README.md hit the first install option they
see, so burying the one-command install script at Option 3 was leaving
the easiest path on the table. This PR reorders the Installation section
to lead with the script and demote the manual paths:
- Option 1: Quickstart install script (recommended) — lead with the
one-shot bash <(curl ...) command; follow with the review-first flow
for audit-minded users.
- Option 2: Docker Compose (manual) — unchanged content, relabeled
"manual" so the contrast with the script is explicit. Adds an explicit
"generate a secret and paste it over the placeholder" step that
mirrors what the install script does for you.
- Option 3: Docker Run (bring your own PostgreSQL) — unchanged.
Also adds a one-line intro under the Installation heading noting that
all three paths converge on the setup wizard, and updates the table of
contents anchors to match the new headings.
No code changes. Full test suite still green locally
(backend 181 suites / 3507 tests, frontend 105 files / 2103 tests,
backend e2e 15 suites / 107 tests, both tsc clean).
-[Option 3: Docker Run (bring your own PostgreSQL)](#option-3-docker-run-bring-your-own-postgresql)
37
37
-[Verifying the image signature](#verifying-the-image-signature)
38
38
-[Custom port](#custom-port)
39
39
-[Image tags](#image-tags)
@@ -60,25 +60,49 @@ Works with 300+ models across OpenAI, Anthropic, Google Gemini, DeepSeek, xAI, M
60
60
61
61
## Installation
62
62
63
-
### Option 1: Docker Compose (recommended)
63
+
Three paths, ordered from fastest to most hands-on. All three end in the same place: a running stack that walks you through the **setup wizard** at [http://localhost:3001](http://localhost:3001) to create your admin account.
64
64
65
-
Runs Manifest with a PostgreSQL database. One command.
One command. The script downloads `docker/docker-compose.yml`, generates a fresh `BETTER_AUTH_SECRET` and injects it into the compose file, brings up the stack, and waits for the healthcheck to go green.
Flags: `--dir <path>` (install into a custom directory, defaults to `./manifest`), `--dry-run` (print what would happen without touching anything), `--yes` (skip the confirmation prompt).
82
+
83
+
### Option 2: Docker Compose (manual)
84
+
85
+
Same underlying flow as the install script, but you drive it yourself so you can edit the compose file before booting the stack.
2.Generate a secret and paste it over the `BETTER_AUTH_SECRET` placeholder in `docker-compose.yml`:
74
94
75
95
```bash
76
-
docker compose up -d
96
+
openssl rand -hex 32
77
97
```
78
98
79
-
3.Open [http://localhost:3001](http://localhost:3001). The **setup wizard** walks you through creating the first admin account — pick your own email and password (min 8 chars). No hardcoded credentials.
99
+
3.Start it:
80
100
81
-
4. Connect a provider on the Routing page and you're set.
101
+
```bash
102
+
docker compose up -d
103
+
```
104
+
105
+
4. Open [http://localhost:3001](http://localhost:3001) and complete the setup wizard.
82
106
83
107
To stop:
84
108
@@ -87,7 +111,7 @@ docker compose down # keeps data
87
111
docker compose down -v # deletes everything
88
112
```
89
113
90
-
### Option 2: Docker Run (bring your own PostgreSQL)
114
+
### Option 3: Docker Run (bring your own PostgreSQL)
91
115
92
116
If you already have PostgreSQL running, pick the command for your shell.
93
117
@@ -140,27 +164,7 @@ docker run -d ^
140
164
141
165
</details>
142
166
143
-
`AUTO_MIGRATE=true` runs TypeORM migrations on first boot. Then visit http://localhost:3001 and complete the setup wizard to create your admin account.
144
-
145
-
### Option 3: One-command install script
146
-
147
-
Downloads the compose file, generates a `BETTER_AUTH_SECRET`, writes it into the compose file (replacing the placeholder), and brings up the stack. Prompts before making changes; supports `--dry-run`.
Flags: `--dir <path>` (install into a custom directory, defaults to `./manifest`), `--dry-run` (print what would happen without touching anything), `--yes` (skip the confirmation prompt).
167
+
`AUTO_MIGRATE=true` runs TypeORM migrations on first boot. Then visit [http://localhost:3001](http://localhost:3001) and complete the setup wizard to create your admin account.
0 commit comments