diff --git a/readme-vars.yml b/readme-vars.yml index 7943d04..4ebd797 100644 --- a/readme-vars.yml +++ b/readme-vars.yml @@ -25,11 +25,11 @@ param_volumes: param_usage_include_env: true param_env_vars: - { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London"} - - { env_var: "APP_URL", env_value: "", desc: "for specifying the IP:port or URL your application will be accessed on (ie. `http://192.168.1.1:6875` or `https://bookstack.mydomain.com`"} - - { env_var: "DB_HOST", env_value: "", desc: "for specifying the database host" } - - { env_var: "DB_PORT", env_value: "", desc: "for specifying the database port if not default 3306" } - - { env_var: "DB_USER", env_value: "", desc: "for specifying the database user" } - - { env_var: "DB_PASS", env_value: "", desc: "for specifying the database password (minimum 4 characters & non-alphanumeric passwords must be properly escaped.)" } + - { env_var: "APP_URL", env_value: "yourbaseurl", desc: "for specifying the IP:port or URL your application will be accessed on (ie. `http://192.168.1.1:6875` or `https://bookstack.mydomain.com`"} + - { env_var: "DB_HOST", env_value: "yourdbhost", desc: "for specifying the database host" } + - { env_var: "DB_PORT", env_value: "yourdbport", desc: "for specifying the database port if not default 3306" } + - { env_var: "DB_USER", env_value: "yourdbuser", desc: "for specifying the database user" } + - { env_var: "DB_PASS", env_value: "yourdbpass", desc: "for specifying the database password (minimum 4 characters & non-alphanumeric passwords must be properly escaped.)" } - { env_var: "DB_DATABASE", env_value: "bookstackapp", desc: "for specifying the database to be used" } param_usage_include_ports: true @@ -38,7 +38,7 @@ param_ports: opt_param_usage_include_env: true opt_param_env_vars: - - { env_var: "QUEUE_CONNECTION", env_value: "", desc: "Set to `database` to enable async actions like sending email or triggering webhooks." } + - { env_var: "QUEUE_CONNECTION", env_value: "", desc: "Set to `database` to enable async actions like sending email or triggering webhooks. See [documentation](https://www.bookstackapp.com/docs/admin/email-webhooks/#async-action-handling)." } custom_compose: | ---