Optional Configuration Settings


NetBox will email details about critical errors to the administrators listed here. This should be a list of (name, email) tuples. For example:

    ['Hank Hill', 'hhill@example.com'],
    ['Dale Gribble', 'dgribble@example.com'],


Default: ('file', 'ftp', 'ftps', 'http', 'https', 'irc', 'mailto', 'sftp', 'ssh', 'tel', 'telnet', 'tftp', 'vnc', 'xmpp')

A list of permitted URL schemes referenced when rendering links within NetBox. Note that only the schemes specified in this list will be accepted: If adding your own, be sure to replicate the entire default list as well (excluding those schemes which are not desirable).

Setting these variables will display content in a banner at the top and/or bottom of the page, respectively. HTML is allowed. To replicate the content of the top banner in the bottom banner, set:

BANNER_TOP = 'Your banner text'

The value of this variable will be displayed on the login page above the login form. HTML is allowed.


Default: None

The base URL path to use when accessing NetBox. Do not include the scheme or domain name. For example, if installed at http://example.com/netbox/, set:

BASE_PATH = 'netbox/'


Default: 900

The number of seconds to retain cache entries before automatically invalidating them.


Default: 90

The number of days to retain logged changes (object creations, updates, and deletions). Set this to 0 to retain changes in the database indefinitely. (Warning: This will greatly increase database size over time.)


Default: False

If True, cross-origin resource sharing (CORS) requests will be accepted from all origins. If False, a whitelist will be used (see below).



These settings specify a list of origins that are authorized to make cross-site API requests. Use CORS_ORIGIN_WHITELIST to define a list of exact hostnames, or CORS_ORIGIN_REGEX_WHITELIST to define a set of regular expressions. (These settings have no effect if CORS_ORIGIN_ALLOW_ALL is True.) For example:



Default: False

This setting enables debugging. This should be done only during development or troubleshooting. Note that only clients which access NetBox from a recognized internal IP address will see debugging tools in the user interface.


Never enable debugging on a production system, as it can expose sensitive data to unauthenticated users.


Default: False

This parameter serves as a safeguard to prevent some potentially dangerous behavior, such as generating new database schema migrations. Set this to True only if you are actively developing the NetBox code base.


Default: $INSTALL_DIR/docs/

The file path to NetBox's documentation. This is used when presenting context-sensitive documentation in the web UI. by default, this will be the docs/ directory within the root NetBox installation path. (Set this to None to disable the embedded documentation.)


In order to send email, NetBox needs an email server configured. The following items can be defined within the EMAIL configuration parameter:

  • SERVER - Host name or IP address of the email server (use localhost if running locally)
  • PORT - TCP port to use for the connection (default: 25)
  • USERNAME - Username with which to authenticate
  • PASSSWORD - Password with which to authenticate
  • USE_SSL - Use SSL when connecting to the server (default: False). Mutually exclusive with USE_TLS.
  • USE_TLS - Use TLS when connecting to the server (default: False). Mutually exclusive with USE_SSL.
  • SSL_CERTFILE - Path to the PEM-formatted SSL certificate file (optional)
  • SSL_KEYFILE - Path to the PEM-formatted SSL private key file (optional)
  • TIMEOUT - Amount of time to wait for a connection, in seconds (default: 10)
  • FROM_EMAIL - Sender address for emails sent by NetBox (default: root@localhost)

Email is sent from NetBox only for critical events or if configured for logging. If you would like to test the email server configuration please use the django function send_mail():

# python ./manage.py nbshell
>>> from django.core.mail import send_mail
>>> send_mail(
  'Test Email Subject',
  'Test Email Body',


Default: Empty list

A list of models to exempt from the enforcement of view permissions. Models listed here will be viewable by all users and by anonymous users.

List models in the form <app>.<model>. For example:


To exempt all models from view permission enforcement, set the following. (Note that EXEMPT_VIEW_PERMISSIONS must be an iterable.)



Default: False

Enforcement of unique IP space can be toggled on a per-VRF basis. To enforce unique IP space within the global table (all prefixes and IP addresses not assigned to a VRF), set ENFORCE_GLOBAL_UNIQUE to True.


Default: None

A dictionary of HTTP proxies to use for outbound requests originating from NetBox (e.g. when sending webhooks). Proxies should be specified by schema as per the Python requests library documentation. For example:

    'http': '',
    'https': '',


Default: ('', '::1',)

A list of IP addresses recognized as internal to the system, used to control the display of debugging output. For example, the debugging toolbar will be viewable only when a client is accessing NetBox from one of the listed IP addresses (and DEBUG is true).


By default, all messages of INFO severity or higher will be logged to the console. Additionally, if DEBUG is False and email access has been configured, ERROR and CRITICAL messages will be emailed to the users defined in ADMINS.

The Django framework on which NetBox runs allows for the customization of logging, e.g. to write logs to file. Please consult the Django logging documentation for more information on configuring this setting. Below is an example which will write all INFO and higher messages to a file:

    'version': 1,
    'disable_existing_loggers': False,
    'handlers': {
        'file': {
            'level': 'INFO',
            'class': 'logging.FileHandler',
            'filename': '/var/log/netbox.log',
    'loggers': {
        'django': {
            'handlers': ['file'],
            'level': 'INFO',

Available Loggers

  • netbox.auth.* - Authentication events
  • netbox.api.views.* - Views which handle business logic for the REST API
  • netbox.reports.* - Report execution (module.name)
  • netbox.scripts.* - Custom script execution (module.name)
  • netbox.views.* - Views which handle business logic for the web UI


Default: False

Setting this to True will permit only authenticated users to access any part of NetBox. By default, anonymous users are permitted to access most data in NetBox (excluding secrets) but not make any changes.


Default: 1209600 seconds (14 days)

The liftetime (in seconds) of the authentication cookie issued to a NetBox user upon login.


Default: False

Setting this to True will display a "maintenance mode" banner at the top of every page.


Default: 1000

An API consumer can request an arbitrary number of objects by appending the "limit" parameter to the URL (e.g. ?limit=1000). This setting defines the maximum limit. Setting it to 0 or None will allow an API consumer to request all objects by specifying ?limit=0.


Default: $BASE_DIR/netbox/media/

The file path to the location where media files (such as image attachments) are stored. By default, this is the netbox/media/ directory within the base NetBox installation path.


Default: False

Toggle exposing Prometheus metrics at /metrics. See the Prometheus Metrics documentation for more details.



NetBox will use these credentials when authenticating to remote devices via the NAPALM library, if installed. Both parameters are optional.

Note: If SSH public key authentication has been set up for the system account under which NetBox runs, these parameters are not needed.


A dictionary of optional arguments to pass to NAPALM when instantiating a network driver. See the NAPALM documentation for a complete list of optional arguments. An example:

    'api_key': '472071a93b60a1bd1fafb401d9f8ef41',
    'port': 2222,

Note: Some platforms (e.g. Cisco IOS) require an argument named secret to be passed in addition to the normal password. If desired, you can use the configured NAPALM_PASSWORD as the value for this argument:

NAPALM_USERNAME = 'username'
NAPALM_PASSWORD = 'MySecretPassword'
    'secret': NAPALM_PASSWORD,
    # Include any additional args here


Default: 30 seconds

The amount of time (in seconds) to wait for NAPALM to connect to a device.


Default: 50

Determine how many objects to display per page within each list of objects.


Default: Empty

A list of installed NetBox plugins to enable. Plugins will not take effect unless they are listed here.


Plugins extend NetBox by allowing external code to run with the same access and privileges as NetBox itself. Only install plugins from trusted sources. The NetBox maintainers make absolutely no guarantees about the integrity or security of your installation with plugins enabled.


Default: Empty

This parameter holds configuration settings for individual NetBox plugins. It is defined as a dictionary, with each key using the name of an installed plugin. The specific parameters supported are unique to each plugin: Reference the plugin's documentation to determine the supported parameters. An example configuration is shown below:

    'plugin1': {
        'foo': 123,
        'bar': True
    'plugin2': {
        'foo': 456,

Note that a plugin must be listed in PLUGINS for its configuration to take effect.


Default: False

When determining the primary IP address for a device, IPv6 is preferred over IPv4 by default. Set this to True to prefer IPv4 instead.


Default: 22

Default height (in pixels) of a unit within a rack elevation. For best results, this should be approximately one tenth of RACK_ELEVATION_DEFAULT_UNIT_WIDTH.


Default: 220

Default width (in pixels) of a unit within a rack elevation.


Default: False

NetBox can be configured to support remote user authentication by inferring user authentication from an HTTP header set by the HTTP reverse proxy (e.g. nginx or Apache). Set this to True to enable this functionality. (Local authentication will still take effect as a fallback.)


Default: 'utilities.auth_backends.RemoteUserBackend'

Python path to the custom Django authentication backend to use for external user authentication, if not using NetBox's built-in backend. (Requires REMOTE_AUTH_ENABLED.)



When remote user authentication is in use, this is the name of the HTTP header which informs NetBox of the currently authenticated user. (Requires REMOTE_AUTH_ENABLED.)


Default: False

If true, NetBox will automatically create local accounts for users authenticated via a remote service. (Requires REMOTE_AUTH_ENABLED.)


Default: [] (Empty list)

The list of groups to assign a new user account when created using remote authentication. (Requires REMOTE_AUTH_ENABLED.)


Default: [] (Empty list)

The list of permissions to assign a new user account when created using remote authentication. (Requires REMOTE_AUTH_ENABLED.)


Default: 86,400 (24 hours)

The number of seconds to retain the latest version that is fetched from the GitHub API before automatically invalidating it and fetching it from the API again. This must be set to at least one hour (3600 seconds).


Default: None

The releases of this repository are checked to detect new releases, which are shown on the home page of the web interface. You can change this to your own fork of the NetBox repository, or set it to None to disable the check. The URL provided must be compatible with the GitHub API.

Use 'https://api.github.com/repos/netbox-community/netbox/releases' to check for release in the official NetBox repository.


Default: $BASE_DIR/netbox/reports/

The file path to the location where custom reports will be kept. By default, this is the netbox/reports/ directory within the base NetBox installation path.


Default: $BASE_DIR/netbox/scripts/

The file path to the location where custom scripts will be kept. By default, this is the netbox/scripts/ directory within the base NetBox installation path.


Default: None

Session data is used to track authenticated users when they access NetBox. By default, NetBox stores session data in the PostgreSQL database. However, this inhibits authentication to a standby instance of NetBox without write access to the database. Alternatively, a local file path may be specified here and NetBox will store session data as files instead of using the database. Note that the user as which NetBox runs must have read and write permissions to this path.


Default: None (local storage)

The backend storage engine for handling uploaded files (e.g. image attachments). NetBox supports integration with the django-storages package, which provides backends for several popular file storage services. If not configured, local filesystem storage will be used.

The configuration parameters for the specified storage backend are defined under the STORAGE_CONFIG setting.


Default: Empty

A dictionary of configuration parameters for the storage backend configured as STORAGE_BACKEND. The specific parameters to be used here are specific to each backend; see the django-storages documentation for more detail.

If STORAGE_BACKEND is not defined, this setting will be ignored.


Default: UTC

The time zone NetBox will use when dealing with dates and times. It is recommended to use UTC time unless you have a specific need to use a local time zone. List of available time zones.

Date and Time Formatting

You may define custom formatting for date and times. For detailed instructions on writing format strings, please see the Django documentation.


DATE_FORMAT = 'N j, Y'               # June 26, 2016
SHORT_DATE_FORMAT = 'Y-m-d'          # 2016-06-27
TIME_FORMAT = 'g:i a'                # 1:23 p.m.
SHORT_TIME_FORMAT = 'H:i:s'          # 13:23:00
DATETIME_FORMAT = 'N j, Y g:i a'     # June 26, 2016 1:23 p.m.
SHORT_DATETIME_FORMAT = 'Y-m-d H:i'  # 2016-06-27 13:23