Skip to content

Commit

Permalink
Add configuration settings introduced between 2.8.1 and 2.8.9
Browse files Browse the repository at this point in the history
  • Loading branch information
@bootc
bootc committed Sep 6, 2020
1 parent d36c9ef commit 050972d
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ The following table lists the configurable parameters for this chart and their d
| `skipStartupScripts` | Skip [netbox-docker startup scripts] | `true` |
| `allowedHosts` | List of valid FQDNs for this NetBox instance | `["*"]` |
| `admins` | List of admins to email about critical errors | `[]` |
| `allowedUrlSchemes` | URL schemes that are allowed within links in NetBox | *see `values.yaml`* |
| `banner.top` | Banner text to display at the top of every page | `""` |
| `banner.bottom` | Banner text to display at the bottom of every page | `""` |
| `banner.login` | Banner text to display on the login page | `""` |
Expand All @@ -88,6 +89,8 @@ The following table lists the configurable parameters for this chart and their d
| `email.from` | Sender address for emails sent by NetBox | `""` |
| `enforceGlobalUnique` | Enforce unique IP space in the global table (not in a VRF) | `false` |
| `exemptViewPermissions` | A list of models to exempt from the enforcement of view permissions | `[]` |
| `httpProxies` | HTTP proxies NetBox should use when sending outbound HTTP requests | `null` |
| `internalIPs` | IP addresses recognized as internal to the system | `['127.0.0.1', '::1']` |
| `logging` | Custom Django logging configuration | `{}` |
| `loginRequired` | Permit only logged-in users to access NetBox | `false` (unauthenticated read-only access) |
| `maintenanceMode` | Display a "maintenance mode" banner on every page | `false` |
Expand All @@ -100,6 +103,8 @@ The following table lists the configurable parameters for this chart and their d
| `plugins` | Additional plugins to load into NetBox | `[]` |
| `pluginsConfig` | Configuration for the additional plugins | `{}` |
| `preferIPv4` | Prefer devices' IPv4 address when determining their primary address | `false` |
| `rackElevationDefaultUnitHeight` | Rack elevation default height in pixels | `22` |
| `rackElevationDefaultUnitWidth` | Rack elevation default width in pixels | `220` |
| `remoteAuth.enabled` | Enable remote authentication support | `false` |
| `remoteAuth.backend` | Remote authentication backend class | `utilities.auth_backends.RemoteUserBackend` |
| `remoteAuth.header` | The name of the HTTP header which conveys the username | `HTTP_REMOTE_USER` |
Expand Down
5 changes: 5 additions & 0 deletions templates/configmap.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ data:
CONN_MAX_AGE: {{ .Values.externalDatabase.connMaxAge | int }}
ADMINS: {{ toJson .Values.admins }}
ALLOWED_URL_SCHEMES: {{ toJson .Values.allowedUrlSchemes }}
BANNER_TOP: {{ .Values.banner.top | quote }}
BANNER_BOTTOM: {{ .Values.banner.bottom | quote }}
BANNER_LOGIN: {{ .Values.banner.login | quote }}
Expand All @@ -107,6 +108,8 @@ data:
ENFORCE_GLOBAL_UNIQUE: {{ toJson .Values.enforceGlobalUnique }}
EXEMPT_VIEW_PERMISSIONS: {{ toJson .Values.exemptViewPermissions }}
HTTP_PROXIES: {{ toJson .Values.httpProxies }}
INTERNAL_IPS: {{ toJson .Values.internalIPs }}
LOGGING: {{ toJson .Values.logging }}
LOGIN_REQUIRED: {{ toJson .Values.loginRequired }}
MAINTENANCE_MODE: {{ toJson .Values.maintenanceMode }}
Expand All @@ -120,6 +123,8 @@ data:
PLUGINS: {{ toJson .Values.plugins }}
PLUGINS_CONFIG: {{ toJson .Values.pluginsConfig }}
PREFER_IPV4: {{ toJson .Values.preferIPv4 }}
RACK_ELEVATION_DEFAULT_UNIT_HEIGHT: {{ int .Values.rackElevationDefaultUnitHeight }}
RACK_ELEVATION_DEFAULT_UNIT_WIDTH: {{ int .Values.rackElevationDefaultUnitWidth }}
REMOTE_AUTH_ENABLED: {{ toJson .Values.remoteAuth.enabled }}
REMOTE_AUTH_BACKEND: {{ .Values.remoteAuth.backend | quote }}
REMOTE_AUTH_HEADER: {{ .Values.remoteAuth.header | quote }}
Expand Down
17 changes: 17 additions & 0 deletions values.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ allowedHosts:
admins: []
# - ['John Doe', '[email protected]']

# URL schemes that are allowed within links in NetBox
allowedUrlSchemes: [file, ftp, ftps, http, https, irc, mailto, sftp, ssh, tel,
telnet, tftp, vnc, xmpp]

banner:
# Optionally display a persistent banner at the top and/or bottom of every
# page. HTML is allowed.
Expand Down Expand Up @@ -94,6 +98,14 @@ exemptViewPermissions: []
# - dcim.region
# - ipam.prefix

# HTTP proxies NetBox should use when sending outbound HTTP requests (e.g. for
# webhooks).
httpProxies: null

# IP addresses recognized as internal to the system. The debugging toolbar will
# be available only to clients accessing NetBox from an internal IP.
internalIPs: ['127.0.0.1', '::1']

# Enable custom logging. Please see the Django documentation for detailed
# guidance on configuring custom logs:
# https://docs.djangoproject.com/en/1.11/topics/logging/
Expand Down Expand Up @@ -142,6 +154,11 @@ pluginsConfig: {}
# IPv4 by default. Set this to True to prefer IPv4 instead.
preferIPv4: false

# Rack elevation size defaults, in pixels. For best results, the ratio of width
# to height should be roughly 10:1.
rackElevationDefaultUnitHeight: 22
rackElevationDefaultUnitWidth: 220

# Remote authentication support
remoteAuth:
enabled: false
Expand Down

0 comments on commit 050972d

Please sign in to comment.