ncig/netbox

netbox-docker

!GitHub closed pull requests !Github release workflow !Docker Pulls

https://github.com/netbox-community/netbox-docker/包含将NetBox构建为容器所需的组件。镜像使用该仓库中的代码定期构建，并推送到https://hub.docker.com/r/netboxcommunity/netbox/、Quay.io和https://github.com/netbox-community/netbox-docker/pkgs/container/netbox。

有任何问题吗？在GitHub上提交issue之前，请加入我们的Slack并在#netbox-docker频道寻求帮助。

快速启动

要启动_NetBox Docker_，请运行以下命令。我们的wiki上有更完整的https://github.com/netbox-community/netbox-docker/wiki/Getting-Started，其中解释了每个步骤。

bash
git clone -b release https://github.com/netbox-community/netbox-docker.git
cd netbox-docker
tee docker-compose.override.yml <<EOF
version: '3.4'
services:
  netbox:
    ports:
      - 8000:8080
EOF
docker compose pull
docker compose up

几分钟后，整个应用程序将可用。在浏览器中打开URL http://0.0.0.0:8000/，您应该能看到NetBox的主页。

要创建第一个管理员用户，请运行以下命令：

bash
docker compose exec netbox /opt/netbox/netbox/manage.py createsuperuser

如果您需要经常从空数据库重新启动Netbox，也可以在docker-compose.override.yml中设置SUPERUSER_*变量，如示例所示。

容器镜像标签

新的容器镜像每约24小时自动构建和发布一次。

建议在生产环境中使用vX.Y.Z-a.b.c标签或vX.Y-a.b.c标签！

• vX.Y.Z-a.b.c、vX.Y-a.b.c： 这些是发布版本，包含_NetBox版本_ vX.Y.Z。它们包含_NetBox Docker版本_ a.b.c的支持文件。必须使用_NetBox Docker版本_ a.b.c以保证兼容性。这些镜像从https://github.com/netbox-community/netbox/releases自动构建。
• latest-a.b.c： 这些是发布版本，包含NetBox的最新稳定版本。它们包含_NetBox Docker版本_ a.b.c的支持文件。必须使用_NetBox Docker版本_ a.b.c以保证兼容性。这些镜像从https://github.com/netbox-community/netbox/tree/master自动构建。
• snapshot-a.b.c： 这些是预发布版本。它们包含_NetBox Docker版本_ a.b.c的支持文件。必须使用_NetBox Docker版本_ a.b.c以保证兼容性。这些镜像从https://github.com/netbox-community/netbox/tree/develop自动构建。

对于上述每个标签，还有一个额外的标签：

• vX.Y.Z、vX.Y： 与vX.Y.Z-a.b.c（或分别与vX.Y-a.b.c）版本相同。它始终指向NetBox Docker的最新版本。
• latest： 与latest-a.b.c版本相同。它始终指向NetBox Docker的最新版本。
• snapshot： 与snapshot-a.b.c版本相同。它始终指向NetBox Docker的最新版本。

文档

有关如何正确使用NetBox Docker镜像的更多信息，请参考https://github.com/netbox-community/netbox-docker/wiki/。该wiki涵盖高级主题，如使用文件存储密钥、配置TLS、部署到Kubernetes、监控和配置LDAP。

我们的wiki是社区共同努力的结果。欢迎纠正错误、更新过时信息或提供额外的指南和见解。

获取帮助

欢迎在我们的https://github.com/netbox-community/netbox-docker/discussions提问，或加入我们的Slack并在#netbox-docker频道提问，该频道免费使用，几乎随时都有人在线提供帮助。

如果您需要使用NetBox或为其开发或针对其API开发的帮助，您可能会发现同一Slack实例上的#netbox频道非常有帮助。

依赖项

本项目仅依赖满足以下要求的_Docker_和_docker-compose_：

• Docker版本必须至少为20.10.10。
• containerd版本必须至少为1.5.6。
• docker-compose版本必须至少为1.28.0。

要检查系统上安装的版本，请运行docker --version和docker compose version。

更新

更新到新镜像版本时，请仔细阅读https://github.com/netbox-community/netbox-docker/releases。请注意，NetBox Docker容器镜像的版本必须与代码保持同步。

如果您是首次更新，请务必https://github.com/netbox-community/netbox-docker/wiki/Updating。

重建镜像

./build.sh可用于重建容器镜像。有关更多信息，请参见./build.sh --help。

有关自定义构建的更多详细信息，请https://github.com/netbox-community/netbox-docker/wiki/Build。

测试

我们有一个测试脚本。它运行NetBox自己的单元测试，并确保所有初始化程序正常工作：

bash
IMAGE=netboxcommunity/netbox:latest ./test.sh

支持

此仓库目前由社区维护。请考虑赞助此项目的维护者。