本教程适用于以下操作系统版本
- Debian 12 (Bookworm)
- Debian 11 (Bullseye)
本页内容
- 先决条件
- 安装 PostgreSQL 服务器
- 安装 Redis 服务器
- 安装 NetBox IRM
- 创建 NetBox 管理员用户
- 将 NetBox 设置为 Systemd 服务
- 将 Apache2 设置为反向代理
- 结论
NetBox 是一款基础设施资源建模(IRM)软件,专为网络自动化和基础设施工程设计。最初,它由 DigitalOcean 团队创建,如今已成为一个基于 Apache 2 License 发布的开源项目。NetBox 使用 Python Django Web 框架开发,并以 PostgreSQL 作为默认数据库,其安装过程与其他 Python Django Web 应用程序十分相似。
NetBox 可帮助你管理基础设施,其中包括:
- DCIM(数据中心基础设施管理)
- IPAM(IP 地址管理)
- 数据电路
- 连接(网络、控制台和电源)
- 设备机架
- 虚拟化
- 密钥
本文将带你逐步了解如何在 Debian 11 服务器上安装 NetBox Infrastructure Resource Modeling。本文包含 PostgreSQL 数据库、Redis 服务器的基础安装,以及将 Apache2 作为反向代理的基础配置。最终,你将在 Debian 11 上运行起 NetBox,并在其上启用 HTTPS/SSL。
先决条件
要完成本教程,你需要满足以下要求:
- 一台 Debian 11 服务器实例。
- 一个具有 root/管理员权限的非 root 用户。
- 一个指向你的 Debian 服务器的域名。
安装 PostgreSQL 服务器
NetBox 应用程序仅支持 PostgreSQL 作为默认数据库。因此,你将在 Debian 服务器上安装 PostgreSQL。然后,为你的 NetBox 安装创建一个新的数据库和用户。
当前版本的 NetBox 至少需要 PostgreSQL v10 或更高版本。在 Debian 11 上,软件仓库提供默认的 PostgreSQL 服务器 v13。
首先,运行下面的 apt 命令来更新你的 Debian 软件仓库并刷新软件包索引。
sudo apt update
现在使用以下 apt 命令安装 PostgreSQL 服务器。输入 Y 确认并按 ENTER,PostgreSQL 的安装就会开始。
sudo apt install postgresql postgresql-common

完成 PostgreSQL 安装后,运行以下 systemctl 命令检查并验证 PostgreSQL 服务。你应该会看到 PostgreSQL 已启用,并将在系统启动时自动运行,且 PostgreSQL 服务当前状态为 running。
sudo systemctl is-enabled postgresql
sudo systemctl status postgresql

接下来,你将为 Nextbox 创建一个新的 PostgreSQL 数据库和用户。为此,你必须登录到 PostgreSQL 控制台。
运行以下命令,使用角色 " postgres " 登录到 PostgreSQL 控制台。
sudo -u postgres psql
现在在 PostgreSQL 控制台上运行以下查询来创建一个新的数据库和用户。在本例中,我们将创建一个名为 " netboxdb " 的新数据库,以及密码为 " NetBoxRocks " 的 PostgreSQL 用户 " netbox "。
CREATE DATABASE netboxdb;
CREATE USER netbox WITH ENCRYPTED PASSWORD 'NetBoxRocks';
GRANT ALL PRIVILEGES ON DATABASE netboxdb TO netbox;
现在按 " Ctrl+d " 退出 PostgreSQL 控制台,或输入 " \q " 退出。

要验证数据库和用户,运行以下命令。这将使用用户 " netbox " 连接到你的 PostgreSQL 服务器上的 " netboxdb " 数据库的 PostgreSQL shell。
当提示输入数据库密码时,输入密码 ' NetBoxRocks "。
sudo -u postgres psql --username netbox --password --host localhost netboxdb
登录到 PostgreSQL 控制台和 " netboxdb " 数据库后,运行以下查询检查当前连接。你应该会看到你正以用户 " netbox " 连接到 PostgreSQL 数据库 " netboxdb "。
\conninfo

按 " Ctrl+d " 退出 PostgreSQL 控制台,或输入 " \q " 退出。
安装 Redis 服务器
Redis 是一个内存键值数据库,NetBox 将用它来进行缓存和队列处理。因此,现在你将在 Debian 服务器上安装 Redis 服务器。
在撰写本文时,最新版本的 NetBox 要求 Redis v4.0 或更高版本。最新的 Debian 11 软件仓库提供 Redis v5.6。
要开始安装 Redis,运行下面的 apt 命令。输入 Y 确认安装并按 ENTER,Redis 的安装就会开始。
sudo apt install redis-server

安装完成后,运行以下 systemctl 命令检查并验证 Redis 服务。你应该会看到 Redis 服务已启用,并将在系统启动时自动运行,且 Redis 服务当前状态为 running。
sudo systemctl is-enabled redis-server
sudo systemctl status redis-server

默认的 Redis 安装不带身份验证。对于生产环境,建议在 Redis 服务器上启用身份验证。要启用 Redis 身份验证,你将修改配置文件 " /etc/redis/redis.conf "。
运行以下命令编辑 Redis 配置文件 " /etc/redis/redis.conf "。
sudo nano /etc/redis/redis.conf
取消 " requirepass " 选项的注释,并输入 Redis 的密码认证。在本例中,我们将使用密码 " RedisPasswordNetBox "。
requirepass RedisPasswordNetBox
完成后,保存并关闭文件。
现在运行以下命令重启 Redis 服务并应用新的更改。
sudo systemctl restart redis-server
要验证 Redi 身份验证,运行下面的 "redis-cli" 命令连接到 Redis 控制台。
redis-cli
现在运行以下命令验证你的 Redis 身份验证。如果密码正确,你将看到类似 " OK " 的输出消息。
AUTH RedisPasswordNetBox

现在按 " Ctrl+d " 退出 Redis 控制台。
安装 NetBox IRM
NetBox 是一个使用 Python Django 框架编写的开源 Web 应用程序。因此,NetBox 的安装与 Python Django Web-Framework 十分相似。最新版本的 Netbox 至少需要 Python v3.8 或更高版本。
在开始安装 NetBox 之前,运行以下命令创建一个新的系统用户 " netbox ",该用户将用于运行 NetBox Web 应用程序。
sudo useradd -r -d /opt/netbox -s /usr/sbin/nologin netbox
使用下面的 apt 命令安装 Python3 和一些软件包依赖。
sudo apt install -y git python3 python3-pip python3-venv python3-dev build-essential libxml2-dev libxslt1-dev libffi-dev libpq-dev libssl-dev zlib1g-dev

安装完成后,运行以下命令创建一个新的 NetBox 安装目录 "/opt/netbox ",并使用 Git 命令克隆 NetBox 源代码。
mkdir -p /opt/netbox; cd /opt/netbox
sudo git clone -b master --depth 1 https://github.com/netbox-community/netbox.git .
现在使用以下命令将 NetBox 安装目录的所有权更改为正确的用户 " netbox "。
sudo chown -R netbox:netbox /opt/netbox

接下来,将工作目录切换到 " /opt/netbox/netbox/netbox ",并将 NetBox 的示例配置 " configuration_example.py " 复制为 " configuration.py "。
cd /opt/netbox/netbox/netbox
sudo -u netbox cp configuration_example.py configuration.py
在编辑 netBox 配置文件之前,运行以下命令为 NetBox 生成 " SECRET_KEY "。将生成的 " SECRET_KEY " 复制到你的编辑器中,稍后编辑文件 " configuration.py " 时会用到它。
sudo -u netbox python3 ../generate_secret_key.py
运行以下命令开始编辑文件 " configuration.py "。
sudo -u netbox nano configuration.py
现在你需要按如下方式设置 NetBox 安装:
- 在 " ALLOWED_HOSTS " 配置中,输入 NetBox 安装的域名和服务器 IP 地址。在本例中,NetBox 将安装在域名 " netbox.example.local " 下,服务器 IP 地址为 " 192.168.5.20 "。
- 将你的 NetBox 的 PostgreSQL 数据库详细信息填入 " DATABASE " 设置。
- 在 " REDIS " 配置中填入 Redis 密码。务必同时修改 " tasks " 和 " caching " 两个部分中的密码。
- 最后,将生成的 " SECRET_KEY " 粘贴到文件中。
# domain and IP address
ALLOWED_HOSTS = ['netbox.example.local', '192.168.5.20']
# database configuration
DATABASE = {
'NAME': 'netboxdb', # Database name
'USER': 'netbox', # PostgreSQL username
'PASSWORD': 'NetBoxRocks', # PostgreSQL password
'HOST': 'localhost', # Database server
'PORT': '', # Database port (leave blank for default)
'CONN_MAX_AGE': 300, # Max database connection age (seconds)
}
# Redis cache configuration
REDIS = {
'tasks': {
'HOST': 'localhost', # Redis server
'PORT': 6379, # Redis port
'PASSWORD': 'RedisPasswordNetBox', # Redis password (optional)
'DATABASE': 0, # Database ID
'SSL': False, # Use SSL (optional)
},
'caching': {
'HOST': 'localhost',
'PORT': 6379,
'PASSWORD': 'RedisPasswordNetBox',
'DATABASE': 1, # Unique ID for second database
'SSL': False,
}
}
# Secret key
SECRET_KEY = 'Slr-8H@1XMcW!22_UYNLcWw+_5=$$=8mtL#JImfOlD*-KiuI6h'
完成后,保存并关闭文件。
现在要开始 NetBox 安装,可以像下面这样运行脚本 " upgrade.sh "。
sudo -u netbox /opt/netbox/upgrade.sh
该脚本将自动安装并配置 NetBox。详细内容如下:
- 这将为你的 NetBox 安装创建一个新的 Python 虚拟环境。
- 这还将为 NetBox 安装一些 Python 依赖项和库。
- 为 NetBox 执行数据库迁移。
- 为 NetBox 生成静态文件资源。
下面是安装开始时的输出。

安装完成后,你将看到以下输出。

创建 NetBox 管理员用户
你已完成 NetBox 的基础安装。现在,你将为 NetBox 创建一个新的管理员用户。这与需要创建 Django 管理员用户时的方式也很相似。
运行以下命令激活 Python 虚拟环境。
source /opt/netbox/venv/bin/activate
将工作目录切换到 " /opt/netbox/netbox "。然后,运行脚本 " manage.py " 为 NetBox 创建一个新的管理员用户。
cd /opt/netbox/netbox
python3 manage.py createsuperuser
输入 NextBox 的 username、email 和 password。
管理员配置完成后,运行以下命令为 NetBox 设置必要的 cron 脚本。它将每天自动运行。
sudo ln -s /opt/netbox/contrib/netbox-housekeeping.sh /etc/cron.daily/netbox-housekeeping

最后,运行以下命令测试并验证你的 NetBox 安装。如果安装正确,你将看到 netBox 正在端口 " 8000 " 上运行。
python3 manage.py runserver 0.0.0.0:8000 --insecure

现在在终端按 " Ctrl+c " 结束该进程。然后,运行 " deactivate " 命令退出 Python 虚拟环境。
将 NetBox 设置为 Systemd 服务
完成 NetBox 的管理员配置之后。现在,你将把 NetBox 设置为 systemd 服务。NetBox 服务将在 Gunicorn 和 HTTP 反向代理下运行。
所有必需的 NetBox Gunicorn 配置和 systemd 服务脚本默认都可以在 "/opt/netbox/contrib" 目录中找到。
运行以下命令将 Gunicorn 配置复制到 "/opt/netbox/gunicorn.py" 。然后,使用 nano 编辑器编辑该文件。
sudo -u netbox cp /opt/netbox/contrib/gunicorn.py /opt/netbox/gunicorn.py
sudo -u netbox nano /opt/netbox/gunicorn.py
在默认配置下,NetBox 应用程序将在 localhost 的 " 8001 " 端口上运行。你可以保留默认配置,或根据你的环境进行更改。
bind = '127.0.0.1:8001'
完成后保存并关闭配置文件。接下来,使用以下命令将 systemd 服务文件复制到 " /etc/systemd/system " 目录。这将启用两个服务:" netbox " 服务作为你 NetBox 应用程序的主服务,以及 " netbox-rq " 服务用于 NetBox 请求队列服务。
sudo cp -v /opt/netbox/contrib/*.service /etc/systemd/system/
现在重新加载系统管理器以应用新的 NetBox 服务文件。
sudo systemctl daemon-reload
重新加载 systemd 管理器后,你可以像下面这样使用 systemctl 命令运行 " netbox " 和 " netbox-rq " 服务。这两个服务都将在系统启动时自动运行。
sudo systemctl start netbox netbox-rq
sudo systemctl enable netbox netbox-rq

最后,使用以下命令检查并验证 NetBox 服务。
sudo systemctl status netbox
sudo systemctl status netbox-rq
在下面的输出中,你可以看到 " netbox " 服务已启用,且当前状态为 running。

对于 ' netbox-rq " 服务,你同样会得到该服务已启用的输出,并且它正在运行。

将 Apache2 设置为反向代理
运行下面的 apt 命令安装 Apache2 Web 服务器。输入 Y 确认安装并按 ENTER,安装就会开始。
sudo apt install apache2

完成 Apache2 安装后,运行以下命令启用一些将用于反向代理的 Aapche2 模块。你应该会看到一些额外的模块也被启用了。
sudo a2enmod ssl proxy proxy_http headers

接下来,将 NetBox 的 Apache2 虚拟主机配置示例复制到 "/etc/apache2/sites-available/netbox.conf" 。然后,使用 nano 编辑器编辑文件 " /etc/apache2/sites-available/netbox.conf "。
sudo cp /opt/netbox/contrib/apache.conf /etc/apache2/sites-available/netbox.conf
sudo nano /etc/apache2/sites-available/netbox.conf
修改你的 NetBox 安装的域名和 SSL 证书的路径。在本例中,我们将使用域名 " netbox.example.local ",以及来自 Letsencrypt 的 SSL 证书,这些证书位于目录 " /etc/letsencrypt/live/netbox.example.local/ " 中。
<VirtualHost *:443>
ProxyPreserveHost On
# CHANGE THIS TO YOUR SERVER'S NAME
ServerName netbox.example.local
SSLEngine on
SSLCertificateFile /etc/letsencrypt/live/netbox.example.local/fullchain.pem
SSLCertificateKeyFile /etc/letsencrypt/live/netbox.example.local/privkey.pem
Alias /static /opt/netbox/netbox/static
<Directory /opt/netbox/netbox/static>
Options Indexes FollowSymLinks MultiViews
AllowOverride None
Require all granted
</Directory>
<Location /static>
ProxyPass !
</Location>
RequestHeader set "X-Forwarded-Proto" expr=%{REQUEST_SCHEME}
ProxyPass / http://127.0.0.1:8001/
ProxyPassReverse / http://127.0.0.1:8001/
</VirtualHost>
完成后,保存并关闭文件。
现在运行以下命令激活虚拟主机配置 " netbox.conf "。然后,测试并验证 Apache 配置。你应该会得到类似 " Syntax OK " 的输出消息,这表示 Apache2 配置正确。
sudo a2ensite netbox.conf
sudo apachectl configtest
现在重启 Apache2 服务以应用对虚拟主机文件的新更改。Apache2 Web 服务器现已启用 HTTPS/SSL,作为运行在 " localhost:8001 " 上的 NetBox Web 应用程序的反向代理。
sudo systemctl restart apache2

要验证安装,打开你的 Web 浏览器并访问 NetBox 安装的域名(即:https://netbox.example.local/ )。你应该会看到处于锁定状态的 NetBox 管理仪表板。
点击右上角的 " Login " 按钮。

现在输入你的 netBox 安装的管理员用户和密码,然后点击 " Login "。

你应该会看到 NetBox 的管理仪表板。

结论
通过本教程,你已在 Debian 11 服务器上搭建了 NetBox Infrastructure Resource Modelling (IRM),并配置了 PostgreSQL 数据库、Redis 缓存系统、Gunicorn 和 Apache2 反向代理。你还已将 NetBox 配置为 systemd 服务,使你能更轻松地启动和停止 NetBox Web 应用程序。最终,你已在 Debian 服务器上完整配置好运行中的 NetBox IRM,并在其上启用了安全的 HTTPS/SSL。