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
Edit `docker-compose.local.yml` with your credentials.
31
31
32
-
**Production tracking (ShotGrid):** To run without a ShotGrid seat, set **`PRODTRACK_PROVIDER=mock`** in `docker-compose.local.yml`. The mock provider uses read-only SQLite with pre-seeded data. To use real ShotGrid, set `PRODTRACK_PROVIDER=shotgrid` (or leave it unset) and add `SHOTGRID_URL`, `SHOTGRID_SCRIPT_NAME`, and `SHOTGRID_API_KEY`. See [Mock setup](#mock-production-tracking-setup) below for how to refresh or customize the mock data.
32
+
**Production tracking (ShotGrid):** To run without a ShotGrid seat, set **`PRODTRACK_PROVIDER=mock`** in `docker-compose.local.yml`. Set **`MOCK_PRODTRACK_DB_PATH=src/dna/prodtrack_providers/mock_data/mock.db`** to make the active mock DB explicit and easy to change later. The mock provider uses read-only SQLite with pre-seeded data. To use real ShotGrid, set `PRODTRACK_PROVIDER=shotgrid` (or leave it unset) and add `SHOTGRID_URL`, `SHOTGRID_SCRIPT_NAME`, and `SHOTGRID_API_KEY`. See [Mock setup](#mock-production-tracking-setup) below for how to refresh or customize the mock data.
33
33
34
34
**LLM provider:** Set `LLM_PROVIDER` to choose which backend LLM integration to use.
35
35
@@ -140,6 +140,7 @@ The React app will be available at `http://localhost:5173`.
140
140
|`SHOTGRID_API_KEY`| Yes\*| - | ShotGrid API key (required when using ShotGrid) |
141
141
|`SHOTGRID_SCRIPT_NAME`| Yes\*| - | ShotGrid script name (required when using ShotGrid) |
142
142
|`PRODTRACK_PROVIDER`| No |`shotgrid`|`shotgrid` or `mock`; set to `mock` to use the read-only mock DB without ShotGrid |
143
+
|`MOCK_PRODTRACK_DB_PATH`| No | bundled `mock.db`| Path to the SQLite DB used when `PRODTRACK_PROVIDER=mock`|
143
144
|`MONGODB_URL`| No |`mongodb://mongo:27017`| MongoDB connection string |
144
145
|`STORAGE_PROVIDER`| No |`mongodb`| Storage provider type |
145
146
|`VEXA_API_KEY`| Yes | - | API key for Vexa transcription service |
@@ -257,12 +258,13 @@ The DNA API serves as the central hub:
257
258
258
259
## Mock Production Tracking Setup
259
260
260
-
When you set **`PRODTRACK_PROVIDER=mock`**, the backend uses a read-only mock provider backed by SQLite (`backend/src/dna/prodtrack_providers/mock_data/mock.db`). The app runs normally with this data so you can develop and test the UI without a ShotGrid seat.
261
+
When you set **`PRODTRACK_PROVIDER=mock`**, the backend uses a read-only mock provider backed by SQLite. By default, set **`MOCK_PRODTRACK_DB_PATH=src/dna/prodtrack_providers/mock_data/mock.db`** in `docker-compose.local.yml` so the active DB is explicit and easy to change. The app runs normally with this data so you can develop and test the UI without a ShotGrid seat.
261
262
262
263
### Using the mock provider
263
264
264
-
- In `docker-compose.local.yml`, set **`PRODTRACK_PROVIDER=mock`**. You do not need to set any ShotGrid variables when using the mock.
265
+
- In `docker-compose.local.yml`, set **`PRODTRACK_PROVIDER=mock`** and **`MOCK_PRODTRACK_DB_PATH=src/dna/prodtrack_providers/mock_data/mock.db`**.
265
266
- The mock provider is used only when explicitly set; there is no automatic fallback if ShotGrid credentials are missing.
267
+
- To switch the backend to a bootstrapped local DB, change `MOCK_PRODTRACK_DB_PATH` to `/app/.local/mock.db`.
266
268
267
269
### Refreshing or customizing mock data from ShotGrid
268
270
@@ -283,10 +285,34 @@ docker-compose -f docker-compose.yml -f docker-compose.local.yml run --rm api \
283
285
--api-key 'YOUR_API_KEY'
284
286
```
285
287
286
-
- This overwrites `mock_data/mock.db` with entities (projects, users, shots, assets, tasks, versions, playlists, notes) from the given ShotGrid project.
288
+
- To bootstrap sample review data, first start Mongo, then run `bootstrap_dataset`.
289
+
- By default, `bootstrap_dataset` writes to `backend/.local/mock.db`, so it does not modify the checked-in mock DB.
290
+
- If you want the backend to use that bootstrapped DB, set `MOCK_PRODTRACK_DB_PATH=/app/.local/mock.db` in `docker-compose.local.yml`.
291
+
-`seed-mock-db` overwrites `mock_data/mock.db` with entities (projects, users, shots, assets, tasks, versions, playlists, notes) from the given ShotGrid project.
287
292
- Use `--skip-thumbnails` to skip downloading version thumbnails (faster seed; thumbnails will not work after signed URLs expire).
288
293
- Without `--skip-thumbnails`, thumbnails are downloaded to `mock_data/thumbnails/` and served by the API at `/api/mock-thumbnails/{version_id}` so they keep working after ShotGrid signed URLs expire.
# Then start the full backend stack so the API comes up with the seeded data
313
+
make start-local
314
+
```
315
+
290
316
The mock provider is **read-only**: it does not write to ShotGrid or to the SQLite file at runtime. Writes such as publishing notes will raise an error when using the mock provider.
0 commit comments