diff --git a/docs/en/configure/index.md b/docs/en/configure/index.md index 4c6ff4db..08ac52f4 100644 --- a/docs/en/configure/index.md +++ b/docs/en/configure/index.md @@ -204,70 +204,79 @@ If you're deploying without docker you can use command line arguments to configu for more information. ```sh -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-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) ---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 ---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&_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 (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-github-release-check/$HBOX_OPTIONS_GITHUB_RELEASE_CHECK (default: true) ---options-allow-analytics/$HBOX_OPTIONS_ALLOW_ANALYTICS (default: false) ---options-allow-local-login/$HBOX_OPTIONS_ALLOW_LOCAL_LOGIN (default: true) ---options-trust-proxy/$HBOX_OPTIONS_TRUST_PROXY (default: false) ---options-hostname/$HBOX_OPTIONS_HOSTNAME ---oidc-enabled/$HBOX_OIDC_ENABLED (default: false) ---oidc-issuer-url/$HBOX_OIDC_ISSUER_URL ---oidc-client-id/$HBOX_OIDC_CLIENT_ID ---oidc-client-secret/$HBOX_OIDC_CLIENT_SECRET ---oidc-scope/$HBOX_OIDC_SCOPE (default: openid profile email) ---oidc-allowed-groups/$HBOX_OIDC_ALLOWED_GROUPS ---oidc-auto-redirect/$HBOX_OIDC_AUTO_REDIRECT (default: false) ---oidc-verify-email/$HBOX_OIDC_VERIFY_EMAIL (default: false) ---oidc-group-claim/$HBOX_OIDC_GROUP_CLAIM (default: groups) ---oidc-email-claim/$HBOX_OIDC_EMAIL_CLAIM (default: email) ---oidc-name-claim/$HBOX_OIDC_NAME_CLAIM (default: name) ---oidc-email-verified-claim/$HBOX_OIDC_EMAIL_VERIFIED_CLAIM (default: email_verified) ---oidc-button-text/$HBOX_OIDC_BUTTON_TEXT (default: Sign in with OIDC) ---oidc-state-expiry/$HBOX_OIDC_STATE_EXPIRY (default: 10m) ---oidc-request-timeout/$HBOX_OIDC_REQUEST_TIMEOUT (default: 30s) ---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-font-size/$HBOX_LABEL_MAKER_FONT_SIZE (default: 32.0) ---label-maker-print-command/$HBOX_LABEL_MAKER_PRINT_COMMAND ---label-maker-dynamic-length/$HBOX_LABEL_MAKER_DYNAMIC_LENGTH (default: true) ---label-maker-additional-information/$HBOX_LABEL_MAKER_ADDITIONAL_INFORMATION ---label-maker-regular-font-path/$HBOX_LABEL_MAKER_REGULAR_FONT_PATH ---label-maker-bold-font-path/$HBOX_LABEL_MAKER_BOLD_FONT_PATH ---thumbnail-enabled/$HBOX_THUMBNAIL_ENABLED (default: true) ---thumbnail-width/$HBOX_THUMBNAIL_WIDTH (default: 500) ---thumbnail-height/$HBOX_THUMBNAIL_HEIGHT (default: 500) ---help/-h display this help message +Options: + --barcode-token-barcodespider + --database-database + --database-driver (default: sqlite3) + --database-host + --database-password + --database-port + --database-pub-sub-conn-string (default: mem://{{ .Topic }}) + --database-sqlite-path (default: ./.data/homebox.db?_pragma=busy_timeout=999&_pragma=journal_mode=WAL&_fk=1&_time_format=sqlite) + --database-ssl-cert + --database-ssl-key + --database-ssl-mode (default: require) + --database-ssl-root-cert + --database-username + --debug-enabled (default: false) + --debug-port (default: 4000) + --demo + -h, --help display this help message + --label-maker-additional-information + --label-maker-bold-font-path + --label-maker-dynamic-length (default: true) + --label-maker-font-size (default: 32.0) + --label-maker-height (default: 200) + --label-maker-label-service-timeout + --label-maker-label-service-url + --label-maker-margin (default: 32) + --label-maker-padding (default: 32) + --label-maker-print-command + --label-maker-regular-font-path + --label-maker-width (default: 526) + --log-format (default: text) + --log-level (default: info) + --mailer-from + --mailer-host + --mailer-password + --mailer-port + --mailer-username + --mode (default: development) + --oidc-allowed-groups + --oidc-auto-redirect (default: false) + --oidc-button-text (default: Sign in with OIDC) + --oidc-client-id + --oidc-client-secret + --oidc-email-claim (default: email) + --oidc-email-verified-claim (default: email_verified) + --oidc-enabled (default: false) + --oidc-group-claim (default: groups) + --oidc-issuer-url + --oidc-name-claim (default: name) + --oidc-request-timeout (default: 30s) + --oidc-scope (default: openid profile email) + --oidc-state-expiry (default: 10m) + --oidc-verify-email (default: false) + --options-allow-analytics (default: false) + --options-allow-local-login (default: true) + --options-allow-registration (default: true) + --options-auto-increment-asset-id (default: true) + --options-currency-config + --options-github-release-check (default: true) + --options-hostname + --options-trust-proxy (default: false) + --storage-conn-string (default: file:///./) + --storage-prefix-path (default: .data) + --thumbnail-enabled (default: true) + --thumbnail-height (default: 500) + --thumbnail-width (default: 500) + -v, --version display version + --web-host + --web-idle-timeout (default: 30s) + --web-max-upload-size (default: 10) + --web-port (default: 7745) + --web-read-timeout (default: 10s) + --web-write-timeout (default: 10s) ``` :::