mirrors/homebox
1
0
Fork 1
mirror of https://github.com/hay-kot/homebox.git synced 2025-08-03 08:10:28 +00:00
Code Issues Projects Releases Packages Wiki Activity

update env variables

Browse source
This commit is contained in:
Hayden 2022-09-14 19:07:07 -08:00
parent fa585db4db
commit b672d88e5c
1 changed files with 30 additions and 30 deletions
Download patch file Download diff file Expand all files Collapse all files

14
docs/docs/quick-start.md
View file

@ -36,12 +36,12 @@ volumes:
## Env Variables & Configuration
| Variable | Default | Description |
| ------------------------ | ---------------- | ---------------------------------------------------------------------------------- |
| ----------------------- | ---------------------- | ---------------------------------------------------------------------------------- |
| HBOX_MODE | production | application mode used for runtime behavior can be one of: development, production |
| HBOX_WEB_PORT | 7745 | port to run the web server on, in you're using docker do not change this |
| HBOX_WEB_HOST | | host to run the web server on, in you're using docker do not change this |
| HBOX_DATABASE_DRIVER | sqlite | database driver to use, currently only sqlite is supported |
| HBOX_DATABASE_SQLITE_URL | /data/homebox.db | sqlite database url, in you're using docker do not change this |
| HBOX_STORAGE_DATA | /data/ | path to the data directory, do not change this if you're using docker |
| HBOX_STORAGE_SQLITE_URL | /data/homebox.db?_fk=1 | sqlite database url, in you're using docker do not change this |
| HBOX_LOG_LEVEL | info | log level to use, can be one of: trace, debug, info, warn, error, critical |
| HBOX_LOG_FORMAT | text | log format to use, can be one of: text, json |
| HBOX_MAILER_HOST | | email host to use, if not set no email provider will be used |
@ -62,10 +62,10 @@ volumes:
--mode/$HBOX_MODE <string> (default: development)
--web-port/$HBOX_WEB_PORT <string> (default: 7745)
--web-host/$HBOX_WEB_HOST <string>
--database-driver/$HBOX_DATABASE_DRIVER <string> (default: sqlite3)
--database-sqlite-url/$HBOX_DATABASE_SQLITE_URL <string> (default: file:ent?mode=memory&cache=shared&_fk=1)
--log-level/$HBOX_LOG_LEVEL <string> (default: debug)
--log-file/$HBOX_LOG_FILE <string>
--storage-data/$HBOX_STORAGE_DATA <string> (default: ./homebox-data)
--storage-sqlite-url/$HBOX_STORAGE_SQLITE_URL <string> (default: ./homebox-data/homebox.db?_fk=1)
--log-level/$HBOX_LOG_LEVEL <string> (default: info)
--log-format/$HBOX_LOG_FORMAT <string> (default: text)
--mailer-host/$HBOX_MAILER_HOST <string>
--mailer-port/$HBOX_MAILER_PORT <int>
--mailer-username/$HBOX_MAILER_USERNAME <string>