diff --git a/docs/en/configure/index.md b/docs/en/configure/index.md index b3147d6b..f1878b09 100644 --- a/docs/en/configure/index.md +++ b/docs/en/configure/index.md @@ -16,11 +16,11 @@ aside: false | HBOX_OPTIONS_AUTO_INCREMENT_ASSET_ID | true | auto-increments the asset_id field for new items | | HBOX_OPTIONS_CURRENCY_CONFIG | | json configuration file containing additional currencie | | HBOX_OPTIONS_ALLOW_ANALYTICS | false | Allows the homebox team to view extremely basic information about the system that your running on. This helps make decisions regarding builds and other general decisions. | -| HBOX_WEB_MAX_UPLOAD | 10 | maximum file upload size supported in MB | +| HBOX_WEB_MAX_UPLOAD_SIZE | 10 | maximum file upload size supported in MB | | HBOX_WEB_READ_TIMEOUT | 10s | Read timeout of HTTP sever | | HBOX_WEB_WRITE_TIMEOUT | 10s | Write timeout of HTTP server | | HBOX_WEB_IDLE_TIMEOUT | 30s | Idle timeout of HTTP server | -| HBOX_STORAGE_CONN_STRING | file://./ | path to the data directory, do not change this if you're using docker | +| HBOX_STORAGE_CONN_STRING | file:///./ | path to the data directory, do not change this if you're using docker | | HBOX_STORAGE_PREFIX_PATH | .data | prefix path for the storage, if not set the storage will be used as is | | 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` | @@ -29,20 +29,18 @@ aside: false | 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` | | HBOX_DATABASE_DRIVER | sqlite3 | sets the correct database type (`sqlite3` or `postgres`) | -| HBOX_DATABASE_SQLITE_PATH | ./.data/homebox.db?_pragma=busy_timeout=999&_pragma=journal_mode=WAL&_fk=1 | sets the directory path for Sqlite | +| HBOX_DATABASE_SQLITE_PATH | ./.data/homebox.db?_pragma=busy_timeout=999&_pragma=journal_mode=WAL&_fk=1&_time_format=sqlite | sets the directory path for Sqlite | | HBOX_DATABASE_HOST | | sets the hostname for a postgres database | | HBOX_DATABASE_PORT | | sets the port for a postgres database | | HBOX_DATABASE_USERNAME | | sets the username for a postgres connection (optional if using cert auth) | | HBOX_DATABASE_PASSWORD | | sets the password for a postgres connection (optional if using cert auth) | | HBOX_DATABASE_DATABASE | | sets the database for a postgres connection | -| HBOX_DATABASE_SSL_MODE | | sets the sslmode for a postgres connection | +| HBOX_DATABASE_SSL_MODE | prefer | sets the sslmode for a postgres connection | | HBOX_DATABASE_SSL_CERT | | sets the sslcert for a postgres connection (should be a path) | | HBOX_DATABASE_SSL_KEY | | sets the sslkey for a postgres connection (should be a path) | -| HBOX_DATABASE_SSL_ROOTCERT | | sets the sslrootcert for a postgres connection (should be a path) | -| HBOX_OPTIONS_CHECK_GITHUB_RELEASE | true | check for new github releases | +| HBOX_DATABASE_SSL_ROOT_CERT | | sets the sslrootcert for a postgres connection (should be a path) | +| HBOX_OPTIONS_GITHUB_RELEASE_CHECK | true | check for new github releases | | HBOX_LABEL_MAKER_WIDTH | 526 | width for generated labels in pixels | | HBOX_LABEL_MAKER_HEIGHT | 200 | height for generated labels in pixels | | HBOX_LABEL_MAKER_PADDING | 32 | space between elements on label | @@ -160,8 +158,8 @@ OPTIONS --mode/$HBOX_MODE (default: development) --web-port/$HBOX_WEB_PORT (default: 7745) --web-host/$HBOX_WEB_HOST ---web-max-file-upload/$HBOX_WEB_MAX_FILE_UPLOAD (default: 10) ---storage-conn-string/$HBOX_STORAGE_CONN_STRING (default: file://./) +--web-max-upload-size/$HBOX_WEB_MAX_UPLOAD_SIZE (default: 10) +--storage-conn-string/$HBOX_STORAGE_CONN_STRING (default: file:///./) --storage-prefix-path/$HBOX_STORAGE_PREFIX_PATH (default: .data) --log-level/$HBOX_LOG_LEVEL (default: info) --log-format/$HBOX_LOG_FORMAT (default: text) @@ -170,31 +168,29 @@ OPTIONS --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) --database-driver/$HBOX_DATABASE_DRIVER (default: sqlite3) ---database-sqlite-path/$HBOX_DATABASE_SQLITE_PATH (default: ./.data/homebox.db?_pragma=busy_timeout=999&_pragma=journal_mode=WAL&_fk=1) +--database-sqlite-path/$HBOX_DATABASE_SQLITE_PATH (default: ./.data/homebox.db?_pragma=busy_timeout=999&_pragma=journal_mode=WAL&_fk=1&_time_format=sqlite) --database-host/$HBOX_DATABASE_HOST --database-port/$HBOX_DATABASE_PORT --database-username/$HBOX_DATABASE_USERNAME --database-password/$HBOX_DATABASE_PASSWORD --database-database/$HBOX_DATABASE_DATABASE ---database-ssl-mode/$HBOX_DATABASE_SSL_MODE +--database-ssl-mode/$HBOX_DATABASE_SSL_MODE (default: prefer) --options-allow-registration/$HBOX_OPTIONS_ALLOW_REGISTRATION (default: true) --options-auto-increment-asset-id/$HBOX_OPTIONS_AUTO_INCREMENT_ASSET_ID (default: true) --options-currency-config/$HBOX_OPTIONS_CURRENCY_CONFIG ---options-check-github-release/$HBOX_OPTIONS_CHECK_GITHUB_RELEASE (default: true) +--options-github-release-check/$HBOX_OPTIONS_GITHUB_RELEASE_CHECK (default: true) --options-allow-analytics/$HBOX_OPTIONS_ALLOW_ANALYTICS (default: false) --label-maker-width/$HBOX_LABEL_MAKER_WIDTH (default: 526) --label-maker-height/$HBOX_LABEL_MAKER_HEIGHT (default: 200) --label-maker-padding/$HBOX_LABEL_MAKER_PADDING (default: 32) ---label-maker-margin/$HBOX_LABEL_MAKER_MARGIN (default: 32) +--label-maker-margin/$HBOX_LABEL_MAKER_MARGIN (default: 32) --label-maker-font-size/$HBOX_LABEL_MAKER_FONT_SIZE (default: 32.0) --label-maker-print-command/$HBOX_LABEL_MAKER_PRINT_COMMAND ---label-maker-additional-information/$HBOX_LABEL_MAKER_DYNAMIC_LENGTH (default: true) +--label-maker-dynamic-length/$HBOX_LABEL_MAKER_DYNAMIC_LENGTH (default: true) --label-maker-additional-information/$HBOX_LABEL_MAKER_ADDITIONAL_INFORMATION --thumbnail-enabled/$HBOX_THUMBNAIL_ENABLED (default: true) --thumbnail-width/$HBOX_THUMBNAIL_WIDTH (default: 500)