Skip to content

Commit a2330b1

Browse files
mgustineliclaudekevin-dimichel
authored
docs(docker): remove obsolete FIFTYONE_DATABASE_ADMIN=true install step (#591)
* docs(docker): remove obsolete FIFTYONE_DATABASE_ADMIN=true install step The "set FIFTYONE_DATABASE_ADMIN=true on first install" procedure is obsolete as of v2.9+ (fiftyone core commit 44acde9a53, June 2024): a fresh database now initializes to the connecting client's version, so the admin gate never fires on a fresh install. Aligns Docker with Helm's existing v2.9 treatment; leaves the migration/upgrade safeguard section intact. Refs: AS-578 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * docs(docker): update TOC anchor for renamed "Database admin mode" heading Fixes markdownlint MD051/link-fragments after renaming the Step 4 heading. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * Update docker/README.md Co-authored-by: Kevin DiMichel <56850465+kevin-dimichel@users.noreply.github.com> Signed-off-by: Murilo Gustineli <52141042+mgustineli@users.noreply.github.com> * Update docker/README.md Co-authored-by: Kevin DiMichel <56850465+kevin-dimichel@users.noreply.github.com> Signed-off-by: Murilo Gustineli <52141042+mgustineli@users.noreply.github.com> * docs(docker): fix markdown lint and regenerate TOC Apply markdownlint-fix (collapse double blank line) and markdown-toc (drop stale "Official Docker Images" TOC entry for the removed heading) so the pre-commit CI check passes. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * resolved suggestions --------- Signed-off-by: Murilo Gustineli <52141042+mgustineli@users.noreply.github.com> Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Co-authored-by: Kevin DiMichel <56850465+kevin-dimichel@users.noreply.github.com>
1 parent ce91d91 commit a2330b1

1 file changed

Lines changed: 12 additions & 6 deletions

File tree

docker/README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ regarding FiftyOne Enterprise.
4444
- [3. Create a `compose.override.yaml` to override configuration](#3-create-a-composeoverrideyaml-to-override-configuration)
4545
- [:package: Official Docker Images](#package-official-docker-images)
4646
- [:rocket: Step 5: Initial Deployment](#rocket-step-5-initial-deployment)
47-
- [1. Enable Database Admin mode](#1-enable-database-admin-mode)
47+
- [1. Database admin mode](#1-database-admin-mode)
4848
- [2. Launch the application](#2-launch-the-application)
4949
- [:globe_with_meridians: Step 6: Configure SSL & Reverse Proxy (Nginx / Load Balancer)](#globe_with_meridians-step-6-configure-ssl--reverse-proxy-nginx--load-balancer)
5050
- [:compass: Routing Overview (Path-Based Proxy)](#compass-routing-overview-path-based-proxy)
@@ -223,11 +223,16 @@ print(Fernet.generate_key().decode())
223223

224224
### 3. Create a `compose.override.yaml` to override configuration
225225

226+
Create an overrides file (`compose.override.yaml`) and add overrides there.
227+
Avoid changing the `yaml` files in this directory and instead use overrides.
228+
229+
For example, adding a variable to the `fiftyone-app` service would look like:
230+
226231
```yaml
227232
services:
228233
fiftyone-app:
229234
environment:
230-
FIFTYONE_DATABASE_ADMIN: true # Only for first install
235+
EXAMPLE_VARIABLE: example-value
231236
```
232237
233238
### :package: Official Docker Images
@@ -265,9 +270,12 @@ services:
265270

266271
## :rocket: Step 5: Initial Deployment
267272

268-
### 1. Enable Database Admin mode
273+
### 1. Database admin mode
269274

270-
In `compose.override.yaml`, make sure:
275+
A fresh install does **not** require database admin mode (as of v2.9+) — a new
276+
database automatically initializes to the connecting client's version, so no
277+
migration is needed. Keep `FIFTYONE_DATABASE_ADMIN: false` (the default) in
278+
`compose.override.yaml`:
271279

272280
```yaml
273281
services:
@@ -276,8 +284,6 @@ services:
276284
FIFTYONE_DATABASE_ADMIN: false
277285
```
278286

279-
> This allows the application to create and migrate the database schema.
280-
281287
### 2. Launch the application
282288

283289
FiftyOne Enterprise is deployed with **Dedicated Plugins** and

0 commit comments

Comments
 (0)