From e329dd162ab50497eba54ad5cbd9fbf562be1aba Mon Sep 17 00:00:00 2001 From: Hayden <64056131+hay-kot@users.noreply.github.com> Date: Sun, 13 Nov 2022 14:05:53 -0900 Subject: [PATCH] update ENV vars --- docs/docs/quick-start.md | 74 +++++++++++++++++++++------------------- 1 file changed, 39 insertions(+), 35 deletions(-) diff --git a/docs/docs/quick-start.md b/docs/docs/quick-start.md index f43df50..3a5fad3 100644 --- a/docs/docs/quick-start.md +++ b/docs/docs/quick-start.md @@ -37,24 +37,25 @@ 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, if you're using docker do not change this | -| HBOX_WEB_HOST | | host to run the web server on, if you're using docker do not change this | -| HBOX_ALLOW_REGISTRATION | true | allow users to register themselves | -| HBOX_WEB_MAX_UPLOAD_SIZE | 10 | maximum file upload size supported in MB | -| 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 | -| HBOX_MAILER_PORT | 587 | email port to use | -| HBOX_MAILER_USERNAME | | email user to use | -| HBOX_MAILER_PASSWORD | | email password to use | -| HBOX_MAILER_FROM | | email from address to use | -| HBOX_SWAGGER_HOST | 7745 | swagger host to use, if not set swagger will be disabled | -| HBOX_SWAGGER_SCHEMA | http | swagger schema to use, can be one of: http, https | +| 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, if you're using docker do not change this | +| HBOX_WEB_HOST | | host to run the web server on, if you're using docker do not change this | +| HBOX_OPTIONS_ALLOW_REGISTRATION | true | allow users to register themselves | +| HBOX_OPTIONS_AUTO_INCREMENT_ASSET_ID | true | auto increments the asset_id field for new items | +| HBOX_WEB_MAX_UPLOAD_SIZE | 10 | maximum file upload size supported in MB | +| 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 | +| HBOX_MAILER_PORT | 587 | email port to use | +| HBOX_MAILER_USERNAME | | email user to use | +| HBOX_MAILER_PASSWORD | | email password to use | +| HBOX_MAILER_FROM | | email from address to use | +| HBOX_SWAGGER_HOST | 7745 | swagger host to use, if not set swagger will be disabled | +| HBOX_SWAGGER_SCHEMA | http | swagger schema to use, can be one of: http, https | !!! tip "CLI Arguments" If you're deploying without docker you can use command line arguments to configure the application. Run `homebox --help` for more information. @@ -63,23 +64,26 @@ volumes: Usage: api [options] [arguments] OPTIONS - --mode/$HBOX_MODE (default: development) - --web-port/$HBOX_WEB_PORT (default: 7745) - --web-host/$HBOX_WEB_HOST - --web-max-upload-size/$HBOX_WEB_MAX_UPLOAD_SIZE (default: 10) - --storage-data/$HBOX_STORAGE_DATA (default: ./.data) - --storage-sqlite-url/$HBOX_STORAGE_SQLITE_URL (default: ./.data/homebox.db?_fk=1) - --log-level/$HBOX_LOG_LEVEL (default: info) - --log-format/$HBOX_LOG_FORMAT (default: text) - --mailer-host/$HBOX_MAILER_HOST - --mailer-port/$HBOX_MAILER_PORT - --mailer-username/$HBOX_MAILER_USERNAME - --mailer-password/$HBOX_MAILER_PASSWORD - --mailer-from/$HBOX_MAILER_FROM - --swagger-host/$HBOX_SWAGGER_HOST (default: localhost:7745) - --swagger-scheme/$HBOX_SWAGGER_SCHEME (default: http) - --demo/$HBOX_DEMO - --allow-registration/$HBOX_ALLOW_REGISTRATION (default: true) + --mode/$HBOX_MODE (default: development) + --web-port/$HBOX_WEB_PORT (default: 7745) + --web-host/$HBOX_WEB_HOST + --web-max-upload-size/$HBOX_WEB_MAX_UPLOAD_SIZE (default: 10) + --storage-data/$HBOX_STORAGE_DATA (default: ./.data) + --storage-sqlite-url/$HBOX_STORAGE_SQLITE_URL (default: ./.data/homebox.db?_fk=1) + --log-level/$HBOX_LOG_LEVEL (default: info) + --log-format/$HBOX_LOG_FORMAT (default: text) + --mailer-host/$HBOX_MAILER_HOST + --mailer-port/$HBOX_MAILER_PORT + --mailer-username/$HBOX_MAILER_USERNAME + --mailer-password/$HBOX_MAILER_PASSWORD + --mailer-from/$HBOX_MAILER_FROM + --swagger-host/$HBOX_SWAGGER_HOST (default: localhost:7745) + --swagger-scheme/$HBOX_SWAGGER_SCHEME (default: http) + --demo/$HBOX_DEMO + --debug-enabled/$HBOX_DEBUG_ENABLED (default: false) + --debug-port/$HBOX_DEBUG_PORT (default: 4000) + --options-allow-registration/$HBOX_OPTIONS_ALLOW_REGISTRATION (default: true) + --options-auto-increment-asset-id/$HBOX_OPTIONS_AUTO_INCREMENT_ASSET_ID (default: true) --help/-h display this help message ```