Skip to content

Commit 7b0c11d

Browse files
authored
Merge pull request #549 from voxel51/v-nayjack/docs-deployment-guide-updates
docs(docker): update deployment guide based on customer deployment feedback
2 parents 1bc866e + 9b48bda commit 7b0c11d

1 file changed

Lines changed: 15 additions & 4 deletions

File tree

docker/README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -144,14 +144,20 @@ and dataset sizes.
144144
145145
1. Set `LOCAL_LICENSE_FILE_DIR` in your `.env`
146146
2. Place the license file there and rename it to `license`
147+
3. Ensure the license directory is volume-mounted into the containers
148+
(e.g., `/opt/data/licenses/`)
149+
4. Set read permissions on the license file: `chmod 644 license`
147150

148151
```bash
149-
. .env
152+
# Set this to match the LOCAL_LICENSE_FILE_DIR value in your .env file
153+
LOCAL_LICENSE_FILE_DIR="/path/to/your/licenses"
150154
mkdir -p "${LOCAL_LICENSE_FILE_DIR}"
151155
mv license.key "${LOCAL_LICENSE_FILE_DIR}/license"
156+
chmod 644 "${LOCAL_LICENSE_FILE_DIR}/license"
152157
```
153158

154-
> [!TIP] When rotating the license, to ensure that the new license values are
159+
> [!TIP]
160+
> When rotating the license, to ensure that the new license values are
155161
> picked up immediately, you may need to restart the `teams-cas` and `teams-api`
156162
> services.
157163
@@ -237,7 +243,11 @@ services:
237243
```
238244

239245
> [!NOTE]
240-
> Always include a version tag when overriding images (e.g., `:v2.17.1`).
246+
> Default images and versions for all services are defined in
247+
> `common-services.yaml`. To override an image or version,
248+
> set the value in `compose.override.yaml`. For example, instead of using
249+
> the `fiftyone-app` image, you may instead the `fiftyone-app-gpt` image.
250+
> Always include a version tag when overriding images (e.g., `:vX.Y.Z`).
241251
> Omitting the tag will result in a **not found** error.
242252

243253
## :rocket: Step 4: Initial Deployment
@@ -250,7 +260,7 @@ In `compose.override.yaml`, make sure:
250260
services:
251261
fiftyone-app:
252262
environment:
253-
FIFTYONE_DATABASE_ADMIN: true
263+
FIFTYONE_DATABASE_ADMIN: false
254264
```
255265

256266
> This allows the application to create and migrate the database schema.
@@ -267,6 +277,7 @@ docker compose commands
267277

268278
```shell
269279
docker compose \
280+
-f compose.yaml \
270281
-f compose.delegated-operators.yaml \
271282
-f compose.override.yaml \
272283
up -d

0 commit comments

Comments
 (0)