Add demo function to site settings

Signed-off-by: Justin Georgi <justin.georgi@gmail.com>
This commit is contained in:
2024-03-30 09:14:27 -07:00
parent b6a214ca07
commit 2150aec480
5 changed files with 41 additions and 13 deletions

17
site_settings.md Normal file
View File

@@ -0,0 +1,17 @@
Configuring aspects of the hosted ALVINN PWA is done through the `conf.yaml` file in the `conf` folder.
Settings are divided into the top level categories: `site`, `external`.
### Site settings
Site settings configure aspects of this specific ALVINN instance.
| name | description | default |
| --- | --- | --- |
| agreeExpire | number of months before users are shown the site agreement dialog again | 3 |
| demo | set to true to enable demo mode by default | false
| regions | array of regions names to enable | [thorax, abdomen, limbs, head] |
| useExternal | set to true to enable use of external detection server by default | false |
### External settings
ALVINN can use an external object detection server instead of the built in models; settings for that external server are configured here.
| name | description | default |
| --- | --- | --- |
| address | ip or url of external server | *none* |
| port | port to access on external server | 9001 |