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
Copy file name to clipboardExpand all lines: README.md
+11-3Lines changed: 11 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -129,7 +129,7 @@ Below are examples of real-time hazard detection by the system:
129
129
130
130
## Quick Start (Recommended)
131
131
132
-
Before running the application, prepare your stream configuration file `config/configuration.json`(see below for an example), and complete the following quick start and environment variable setup steps.
132
+
Before running the application, complete the following quick start and environment variable setup steps. Preparing a JSON stream configuration file `config/configuration.json`is optional and generally not recommended; the default Database Mode centrally manages streams. If you need file-based multi-stream config for advanced use cases, see the optional example below.
133
133
134
134
```json
135
135
[
@@ -266,6 +266,8 @@ Before running the application, prepare your stream configuration file `config/c
266
266
267
267
8.**Start the Main Program (Two Modes)**
268
268
269
+
Choose one mode only; do not run Database Mode and JSON Mode at the same time.
270
+
269
271
***Database Mode (Default)**
270
272
`main.py` will poll the `stream_configs` table and dynamically start/restart/stop stream subprocesses.
271
273
@@ -275,8 +277,8 @@ Before running the application, prepare your stream configuration file `config/c
275
277
python main.py --poll 5
276
278
```
277
279
278
-
***JSON Mode (File-based Multi-stream Config)**
279
-
Use `--config` to specify the JSON file path; the main program will start a subprocess for each stream config in the array.
280
+
***JSON Mode (File-based Multi-stream Config) — Optional, advanced; not recommended for most users**
281
+
Use `--config` to specify the JSON file path; the main program will start a subprocess for each stream config in the array. This mode is mutually exclusive with Database Mode.
280
282
281
283
```bash
282
284
python main.py --config config/configuration.json
@@ -291,6 +293,12 @@ Before running the application, prepare your stream configuration file `config/c
291
293
292
294
> Before using, please open the Web Settings and configure API endpoints first (e.g., DETECT_API_URL, STREAMING_API_URL, DB_MANAGEMENT_API_URL, FCM_API_URL) to match your environment; then proceed with login and operations.
0 commit comments