Skip to content

Commit 29cefab

Browse files
authored
Merge pull request #17 from linuxserver/readme-patch
Readme Clarifications
2 parents 353ae30 + 8aec06f commit 29cefab

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

readme-vars.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ param_volumes:
2121
- { vol_path: "/config", vol_host_path: "<path to data on host>", desc: "config directory volume mapping" }
2222
param_usage_include_env: true
2323
param_env_vars:
24-
- { env_var: "SUPERUSER_EMAIL", env_value: "<SUPERUSER_EMAIL>", desc: "Username for admin account" }
25-
- { env_var: "SUPERUSER_PASSWORD", env_value: "<SUPERUSER_PASSWORD>", desc: "Password for admin account" }
24+
- { env_var: "SUPERUSER_EMAIL", env_value: "<SUPERUSER_EMAIL>", desc: "Email address for `admin` account" }
25+
- { env_var: "SUPERUSER_PASSWORD", env_value: "<SUPERUSER_PASSWORD>", desc: "Password for `admin` account" }
2626
- { env_var: "ALLOWED_HOST", env_value: "<ALLOWED_HOST>", desc: "The hostname you will use to access the app (i.e., netbox.example.com)" }
2727
- { env_var: "BASE_PATH", env_value: "<BASE_PATH>", desc: "The path you will use to access the app (i.e., /netbox, optional, default: none)" }
2828
- { env_var: "DB_NAME", env_value: "<DB_NAME>", desc: "Database name (optional, default: netbox)" }
@@ -48,6 +48,8 @@ param_ports:
4848
# application setup block
4949
app_setup_block_enabled: true
5050
app_setup_block: |
51+
Netbox requires a postgres database.
52+
5153
Access the WebUI at <your-ip>:8000. For more information, check out [NetBox](https://github.com/netbox-community/netbox).
5254
5355
# changelog

0 commit comments

Comments
 (0)