NetBox配置
配置文件
NetBox的配置文件包含了控制NetBox功能的所有重要参数:数据库设置、安全控制、用户首选项等等。尽管默认配置对于大多数用例都足够,但在安装过程中必须定义一些必需的参数。
默认情况下,配置文件从$INSTALL_ROOT/netbox/netbox/configuration.py
加载。示例配置位于configuration_example.py
中,您可以复制它并用作默认配置。请注意,必须定义一个配置文件;没有配置文件,NetBox将无法运行。
自定义配置模块
可以通过设置NETBOX_CONFIGURATION
环境变量来指定自定义配置模块。这必须是指向所需Python模块的点分路径。例如,与settings.py
位于同一目录中的名为my_config.py
的文件可以引用为netbox.my_config
。
为简单起见,NetBox文档简单地将配置文件称为configuration.py
。
在文档中适用的情况下,某些配置参数可以在configuration.py
中定义,也可以在用户界面的管理部分内定义。在配置文件中“硬编码”的设置优先于通过UI定义的设置。
动态配置参数
一些配置参数主要通过NetBox的管理界面(在Admin > Extras > Configuration Revisions下)进行控制。在文档中适用的地方进行了相应的注释。这些设置也可以在configuration.py
中进行覆盖,以防止通过UI进行修改。以下是支持的参数的完整列表:
ALLOWED_URL_SCHEMES
BANNER_BOTTOM
BANNER_LOGIN
BANNER_TOP
CHANGELOG_RETENTION
CUSTOM_VALIDATORS
DEFAULT_USER_PREFERENCES
ENFORCE_GLOBAL_UNIQUE
GRAPHQL_ENABLED
JOB_RETENTION
MAINTENANCE_MODE
MAPS_URL
MAX_PAGE_SIZE
PAGINATE_COUNT
POWERFEED_DEFAULT_AMPERAGE
POWERFEED_DEFAULT_MAX_UTILIZATION
POWERFEED_DEFAULT_VOLTAGE
PREFER_IPV4
RACK_ELEVATION_DEFAULT_UNIT_HEIGHT
RACK_ELEVATION_DEFAULT_UNIT_WIDTH
修改配置
可以随时修改配置文件。但是,在这些更改生效之前,必须重新启动WSGI服务(例如Gunicorn):
$ sudo systemctl restart netbox
可以通过用户界面修改的动态配置参数会立即生效。