diff --git a/lsio/netbox/docker-compose.yaml b/lsio/netbox/docker-compose.yaml index 1a09e9c..bf8bc9c 100644 --- a/lsio/netbox/docker-compose.yaml +++ b/lsio/netbox/docker-compose.yaml @@ -16,44 +16,48 @@ services: - PUID=${PUID:-1024} # for UserID - PGID=${PGID:-100} - # Username for admin account + # Specify a timezone to use for example Europe/Amsterdam + - TZ=${TZ:-Europe/Amsterdam} + # Email address for `admin` account - SUPERUSER_EMAIL= - # Password for admin account + # Password for `admin` account - SUPERUSER_PASSWORD= # The hostname you will use to access the app (i.e., netbox.example.com) - ALLOWED_HOST= - # The path you will use to access the app (i.e., /netbox, optional, default: none) - - BASE_PATH= - # Database name (optional, default: netbox) + # Database name (default: netbox) - DB_NAME= # Database user - DB_USER= # Database password - DB_PASSWORD= - # Database host (optional, default: postgres) + # Database host (default: postgres) - DB_HOST= - # Database port (optional) + # Database port (defaul: 5432) - DB_PORT= - # Redis host (optional, default: redis) + # Redis host (default: redis) - REDIS_HOST= - # Redis port number (optional, default: 6379) + # Redis port number (default: 6379) - REDIS_PORT= - # Redis password (optional, default: none) + # Redis password (default: none) - REDIS_PASSWORD= - # Enable remote authentication (optional, default: False - - REMOTE_AUTH_ENABLED= - # Python path to the custom Django authentication backend to use for external user authentication (optional, default: netbox.authentication.RemoteUserBackend - - REMOTE_AUTH_BACKEND= - # Name of the HTTP header which informs NetBox of the currently authenticated user. (optional, default: HTTP_REMOTE_USER - - REMOTE_AUTH_HEADER= - # If true, NetBox will automatically create local accounts for users authenticated via a remote service (optional, default: False - - REMOTE_AUTH_AUTO_CREATE_USER= - # The list of groups to assign a new user account when created using remote authentication (optional, default: [] - - REMOTE_AUTH_DEFAULT_GROUPS= - # A mapping of permissions to assign a new user account when created using remote authentication (optional, default: {} - - REMOTE_AUTH_DEFAULT_PERMISSIONS= - # Specify a timezone to use for example Europe/Amsterdam - - TZ=${TZ:-Europe/Amsterdam} + # Redis database ID for tasks (default: 0) + - REDIS_DB_TASK= + # Redis database ID for caching (default: 1) + - REDIS_DB_CACHE= + # The path you will use to access the app (i.e., /netbox, optional, default: none) + - BASE_PATH= # optional + # Enable remote authentication (optional, default: False) + - REMOTE_AUTH_ENABLED= # optional + # Python path to the custom Django authentication backend to use for external user authentication (optional, default: netbox.authentication.RemoteUserBackend) + - REMOTE_AUTH_BACKEND= # optional + # Name of the HTTP header which informs NetBox of the currently authenticated user. (optional, default: HTTP_REMOTE_USER) + - REMOTE_AUTH_HEADER= # optional + # If true, NetBox will automatically create local accounts for users authenticated via a remote service (optional, default: False) + - REMOTE_AUTH_AUTO_CREATE_USER= # optional + # The list of groups to assign a new user account when created using remote authentication (optional, default: []) + - REMOTE_AUTH_DEFAULT_GROUPS= # optional + # A mapping of permissions to assign a new user account when created using remote authentication (optional, default: {}) + - REMOTE_AUTH_DEFAULT_PERMISSIONS= # optional volumes: # config directory volume mapping - ${BASEDIR:-/volume1/docker}/netbox/config:/config diff --git a/lsio/netbox/docker-run.sh b/lsio/netbox/docker-run.sh index e151ce2..fca9b4a 100644 --- a/lsio/netbox/docker-run.sh +++ b/lsio/netbox/docker-run.sh @@ -10,25 +10,27 @@ docker run -d \ --name=netbox \ -e PUID=${PUID:-1024} `# for GroupID` \ -e PGID=${PGID:-100} `# for UserID` \ - -e SUPERUSER_EMAIL= `# Username for admin account` \ - -e SUPERUSER_PASSWORD= `# Password for admin account` \ + -e TZ=${TZ:-Europe/Amsterdam} `# Specify a timezone to use for example Europe/Amsterdam` \ + -e SUPERUSER_EMAIL= `# Email address for `admin` account` \ + -e SUPERUSER_PASSWORD= `# Password for `admin` account` \ -e ALLOWED_HOST= `# The hostname you will use to access the app (i.e., netbox.example.com)` \ - -e BASE_PATH= `# The path you will use to access the app (i.e., /netbox, optional, default: none)` \ - -e DB_NAME= `# Database name (optional, default: netbox)` \ + -e DB_NAME= `# Database name (default: netbox)` \ -e DB_USER= `# Database user` \ -e DB_PASSWORD= `# Database password` \ - -e DB_HOST= `# Database host (optional, default: postgres)` \ - -e DB_PORT= `# Database port (optional)` \ - -e REDIS_HOST= `# Redis host (optional, default: redis)` \ - -e REDIS_PORT= `# Redis port number (optional, default: 6379)` \ - -e REDIS_PASSWORD= `# Redis password (optional, default: none)` \ - -e REMOTE_AUTH_ENABLED= `# Enable remote authentication (optional, default: False` \ - -e REMOTE_AUTH_BACKEND= `# Python path to the custom Django authentication backend to use for external user authentication (optional, default: netbox.authentication.RemoteUserBackend` \ - -e REMOTE_AUTH_HEADER= `# Name of the HTTP header which informs NetBox of the currently authenticated user. (optional, default: HTTP_REMOTE_USER` \ - -e REMOTE_AUTH_AUTO_CREATE_USER= `# If true, NetBox will automatically create local accounts for users authenticated via a remote service (optional, default: False` \ - -e REMOTE_AUTH_DEFAULT_GROUPS= `# The list of groups to assign a new user account when created using remote authentication (optional, default: []` \ - -e REMOTE_AUTH_DEFAULT_PERMISSIONS= `# A mapping of permissions to assign a new user account when created using remote authentication (optional, default: {}` \ - -e TZ=${TZ:-Europe/Amsterdam} `# Specify a timezone to use for example Europe/Amsterdam` \ + -e DB_HOST= `# Database host (default: postgres)` \ + -e DB_PORT= `# Database port (defaul: 5432)` \ + -e REDIS_HOST= `# Redis host (default: redis)` \ + -e REDIS_PORT= `# Redis port number (default: 6379)` \ + -e REDIS_PASSWORD= `# Redis password (default: none)` \ + -e REDIS_DB_TASK= `# Redis database ID for tasks (default: 0)` \ + -e REDIS_DB_CACHE= `# Redis database ID for caching (default: 1)` \ + -e BASE_PATH= `# optional` `# The path you will use to access the app (i.e., /netbox, optional, default: none)` \ + -e REMOTE_AUTH_ENABLED= `# optional` `# Enable remote authentication (optional, default: False)` \ + -e REMOTE_AUTH_BACKEND= `# optional` `# Python path to the custom Django authentication backend to use for external user authentication (optional, default: netbox.authentication.RemoteUserBackend)` \ + -e REMOTE_AUTH_HEADER= `# optional` `# Name of the HTTP header which informs NetBox of the currently authenticated user. (optional, default: HTTP_REMOTE_USER)` \ + -e REMOTE_AUTH_AUTO_CREATE_USER= `# optional` `# If true, NetBox will automatically create local accounts for users authenticated via a remote service (optional, default: False)` \ + -e REMOTE_AUTH_DEFAULT_GROUPS= `# optional` `# The list of groups to assign a new user account when created using remote authentication (optional, default: [])` \ + -e REMOTE_AUTH_DEFAULT_PERMISSIONS= `# optional` `# A mapping of permissions to assign a new user account when created using remote authentication (optional, default: {})` \ -p 8000:8000 `# will map the container's port 8000 to port 8000 on the host` \ -v ${BASEDIR:-/volume1/docker}/netbox/config:/config `# config directory volume mapping` \ --restart unless-stopped \