Merge branch 'master' into remote-auth-conf

Author: mattycourtney

README.md

@@ -79,6 +79,7 @@ services:
       - SUPERUSER_EMAIL=<SUPERUSER_EMAIL>
       - SUPERUSER_PASSWORD=<SUPERUSER_PASSWORD>
       - ALLOWED_HOST=<ALLOWED_HOST>
+      - BASE_PATH=<BASE_PATH>
       - DB_NAME=<DB_NAME>
       - DB_USER=<DB_USER>
       - DB_PASSWORD=<DB_PASSWORD>
@@ -105,6 +106,7 @@ docker run -d \
   -e SUPERUSER_EMAIL=<SUPERUSER_EMAIL> \
   -e SUPERUSER_PASSWORD=<SUPERUSER_PASSWORD> \
   -e ALLOWED_HOST=<ALLOWED_HOST> \
+  -e BASE_PATH=<BASE_PATH> \
   -e DB_NAME=<DB_NAME> \
   -e DB_USER=<DB_USER> \
   -e DB_PASSWORD=<DB_PASSWORD> \
@@ -132,13 +134,14 @@ Container images are configured using parameters passed at runtime (such as thos
 | `-e PGID=1000` | for GroupID - see below for explanation |
 | `-e SUPERUSER_EMAIL=<SUPERUSER_EMAIL>` | Username for admin account |
 | `-e SUPERUSER_PASSWORD=<SUPERUSER_PASSWORD>` | Password for admin account |
-| `-e ALLOWED_HOST=<ALLOWED_HOST>` | The hostname you will use to access the app (i.e., netbox.example.com |
-| `-e DB_NAME=<DB_NAME>` | Databaes name (optional, default: netbox) |
+| `-e ALLOWED_HOST=<ALLOWED_HOST>` | The hostname you will use to access the app (i.e., netbox.example.com) |
+| `-e BASE_PATH=<BASE_PATH>` | The path you will use to access the app (i.e., /netbox, optional, default: none) |
+| `-e DB_NAME=<DB_NAME>` | Database name (optional, default: netbox) |
 | `-e DB_USER=<DB_USER>` | Database user |
 | `-e DB_PASSWORD=<DB_PASSWORD>` | Database password |
-| `-e DB_HOST=<DB_HOST>` | Database post (optional, default: postgres |
+| `-e DB_HOST=<DB_HOST>` | Database host (optional, default: postgres) |
 | `-e DB_PORT=<DB_PORT>` | Database port (optional) |
-| `-e REDIS_HOST=<REDIS_HOST>` | Redis host (optional, default: redis |
+| `-e REDIS_HOST=<REDIS_HOST>` | Redis host (optional, default: redis) |
 | `-e REDIS_PORT=<REDIS_PORT>` | Redis port number (optional, default: 6379) |
 | `-e REDIS_PASSWORD=<REDIS_PASSWORD>` | Redis password (optional, default: none) |
 | `-e TZ=<TZ>` | Timezone (i.e., America/New_York) |
@@ -252,4 +255,5 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64
 
 ## Versions
 
+* **02.01.21:** - Added BASE_PATH environment variable.
 * **23.08.20:** - Initial Release.

readme-vars.yml

@@ -23,13 +23,14 @@ param_usage_include_env: true
 param_env_vars:
   - { env_var: "SUPERUSER_EMAIL", env_value: "<SUPERUSER_EMAIL>", desc: "Username for admin account" }
   - { env_var: "SUPERUSER_PASSWORD", env_value: "<SUPERUSER_PASSWORD>", desc: "Password for admin account" }
-  - { env_var: "ALLOWED_HOST", env_value: "<ALLOWED_HOST>", desc: "The hostname you will use to access the app (i.e., netbox.example.com" }
-  - { env_var: "DB_NAME", env_value: "<DB_NAME>", desc: "Databaes name (optional, default: netbox)" }
+  - { env_var: "ALLOWED_HOST", env_value: "<ALLOWED_HOST>", desc: "The hostname you will use to access the app (i.e., netbox.example.com)" }
+  - { env_var: "BASE_PATH", env_value: "<BASE_PATH>", desc: "The path you will use to access the app (i.e., /netbox, optional, default: none)" }
+  - { env_var: "DB_NAME", env_value: "<DB_NAME>", desc: "Database name (optional, default: netbox)" }
   - { env_var: "DB_USER", env_value: "<DB_USER>", desc: "Database user" }
   - { env_var: "DB_PASSWORD", env_value: "<DB_PASSWORD>", desc: "Database password" }
-  - { env_var: "DB_HOST", env_value: "<DB_HOST>", desc: "Database post (optional, default: postgres" }
+  - { env_var: "DB_HOST", env_value: "<DB_HOST>", desc: "Database host (optional, default: postgres)" }
   - { env_var: "DB_PORT", env_value: "<DB_PORT>", desc: "Database port (optional)" }
-  - { env_var: "REDIS_HOST", env_value: "<REDIS_HOST>", desc: "Redis host (optional, default: redis" }
+  - { env_var: "REDIS_HOST", env_value: "<REDIS_HOST>", desc: "Redis host (optional, default: redis)" }
   - { env_var: "REDIS_PORT", env_value: "<REDIS_PORT>", desc: "Redis port number (optional, default: 6379)" }
   - { env_var: "REDIS_PASSWORD", env_value: "<REDIS_PASSWORD>", desc: "Redis password (optional, default: none)" }
   - { env_var: "REMOTE_AUTH_ENABLED", env_value: "<REMOTE_AUTH_ENABLED>", desc: "Enable remote authentication (optional, default: False" }
@@ -52,4 +53,5 @@ app_setup_block: |
 # changelog
 changelogs:
   - { date: "03.02.21:", desc: "Added remote authentication environment variables." }
-  - { date: "23.08.20:", desc: "Initial Release." }
+  - { date: "02.01.21:", desc: "Added BASE_PATH environment variable." }
+  - { date: "23.08.20:", desc: "Initial Release." }

root/defaults/configuration.py

@@ -83,7 +83,7 @@
 
 # Base URL path if accessing NetBox within a directory. For example, if installed at http://example.com/netbox/, set:
 # BASE_PATH = 'netbox/'
-BASE_PATH = ''
+BASE_PATH = '{{BASE_PATH}}'
 
 # Cache timeout in seconds. Set to 0 to dissable caching. Defaults to 900 (15 minutes)
 CACHE_TIMEOUT = 900

root/etc/cont-init.d/50-config

@@ -4,6 +4,7 @@ mkdir -p /config/scripts
 
 declare -A NETBOX_CONF
 NETBOX_CONF[ALLOWED_HOST]=${ALLOWED_HOST:-netbox.example.com}
+NETBOX_CONF[BASE_PATH]=${BASE_PATH:-}
 NETBOX_CONF[DB_NAME]=${DB_NAME:-netbox}
 NETBOX_CONF[DB_USER]=${DB_USER:-root}
 NETBOX_CONF[DB_PASSWORD]=${DB_PASSWORD:-}