propellent/netbox

linuxserver/netbox

https://github.com/netbox-community/netbox 是一款IP地址管理(IPAM)和数据中心基础设施管理(DCIM)工具。最初由DigitalOcean的网络工程团队设计，专门用于满足网络和基础设施工程师的需求，旨在作为网络运营的特定领域事实来源。

LinuxServer.io团队提供的此容器具有以下特点：

• 定期及时的应用更新
• 简单的用户映射（PGID、PUID）
• 带有s6 overlay的自定义基础镜像
• 每周基础操作系统更新，整个LinuxServer.io生态系统共享通用层，以最小化空间使用、停机时间和带宽
• 定期安全更新

支持的架构

我们的镜像支持多种架构，如x86-64、arm64和armhf。我们利用docker manifest实现多平台支持。只需拉取ghcr.io/linuxserver/netbox即可获取适合您架构的正确镜像，也可通过标签拉取特定架构的镜像。

支持的架构及对应标签：

使用方法

以下是帮助您开始创建容器的示例代码片段。

docker-compose（推荐）

兼容docker-compose v2架构。

yaml
---
version: "2.1"
services:
  netbox:
    image: ghcr.io/linuxserver/netbox
    container_name: netbox
    environment:
      - PUID=1000
      - PGID=1000
      - SUPERUSER_EMAIL=<SUPERUSER_EMAIL>
      - SUPERUSER_PASSWORD=<SUPERUSER_PASSWORD>
      - SUPERUSER_API_TOKEN=<SUPERUSER_TOKEN>
      - ALLOWED_HOST=<ALLOWED_HOST>
      - BASE_PATH=<BASE_PATH>
      - DB_NAME=<DB_NAME>
      - DB_USER=<DB_USER>
      - DB_PASSWORD=<DB_PASSWORD>
      - DB_HOST=<DB_HOST>
      - DB_PORT=<DB_PORT>
      - REDIS_HOST=<REDIS_HOST>
      - REDIS_PORT=<REDIS_PORT>
      - REDIS_PASSWORD=<REDIS_PASSWORD>
      - TZ=<TZ>
    volumes:
      - <主机数据路径>:/config
    ports:
      - 8000:8000
    restart: unless-stopped

docker cli

docker run -d \
  --name=netbox \
  -e PUID=1000 \
  -e PGID=1000 \
  -e SUPERUSER_EMAIL=<SUPERUSER_EMAIL> \
  -e SUPERUSER_PASSWORD=<SUPERUSER_PASSWORD> \
  -e SUPERUSER_API_TOKEN=<SUPERUSER_TOKEN> \
  -e ALLOWED_HOST=<ALLOWED_HOST> \
  -e BASE_PATH=<BASE_PATH> \
  -e DB_NAME=<DB_NAME> \
  -e DB_USER=<DB_USER> \
  -e DB_PASSWORD=<DB_PASSWORD> \
  -e DB_HOST=<DB_HOST> \
  -e DB_PORT=<DB_PORT> \
  -e REDIS_HOST=<REDIS_HOST> \
  -e REDIS_PORT=<REDIS_PORT> \
  -e REDIS_PASSWORD=<REDIS_PASSWORD> \
  -e TZ=<TZ> \
  -p 8000:8000 \
  -v <主机数据路径>:/config \
  --restart unless-stopped \
  ghcr.io/linuxserver/netbox

参数

容器镜像通过运行时传递的参数进行配置（如上所示）。这些参数用冒号分隔，表示<外部>:<内部>。例如，-p 8080:80会将容器内的80端口暴露到主机IP的8080端口。

来自文件的环境变量（Docker secrets）

您可以使用特殊前缀FILE__从文件设置任何环境变量。

例如：

-e FILE__PASSWORD=/run/secrets/mysecretpassword

这将根据/run/secrets/mysecretpassword文件的内容设置环境变量PASSWORD。

应用运行的Umask

对于我们所有的镜像，您可以使用可选的-e UMASK=022设置来覆盖容器内启动的服务的默认umask设置。请注意，umask不是chmod，它基于其值减去权限，而不是添加。请在请求支持前阅读此处的相关内容。

用户/组标识符

使用卷（-v标志）时，主机操作系统和容器之间可能会出现权限问题。我们通过允许您指定用户PUID和组PGID来避免此问题。

确保主机上的任何卷目录都由您指定的相同用户拥有，任何权限问题都将迎刃而解。

在这种情况下，PUID=1000和PGID=1000，要找到您的PUID和PGID，请使用id user命令：

  $ id username
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

应用设置

通过:8000访问WebUI。有关更多信息，请查看https://github.com/netbox-community/netbox%E3%80%82

Docker Mods

我们发布了各种https://github.com/linuxserver/docker-mods%E4%BB%A5%E5%90%AF%E7%94%A8%E5%AE%B9%E5%99%A8%E5%86%85%E7%9A%84%E9%99%84%E5%8A%A0%E5%8A%9F%E8%83%BD%E3%80%82%E5%8F%AF%E7%94%A8%E4%BA%8E%E6%AD%A4%E9%95%9C%E5%83%8F%E7%9A%84Mods%E5%88%97%E8%A1%A8%EF%BC%88%E5%A6%82%E6%9C%89%EF%BC%89%E4%BB%A5%E5%8F%8A%E5%8F%AF%E5%BA%94%E7%94%A8%E4%BA%8E%E6%88%91%E4%BB%AC%E4%BB%BB%E4%BD%95%E9%95%9C%E5%83%8F%E7%9A%84%E9%80%9A%E7%94%A8Mods%E5%8F%AF%E9%80%9A%E8%BF%87%E4%B8%8A%E6%96%B9%E7%9A%84%E5%8A%A8%E6%80%81%E5%BE%BD%E7%AB%A0%E8%AE%BF%E9%97%AE%E3%80%82

支持信息

• 容器运行时的Shell访问：docker exec -it netbox /bin/bash
• 实时监控容器日志：docker logs -f netbox
• 容器版本号：docker inspect -f '{{ index .Config.Labels "build_version" }}' netbox
• 镜像版本号：docker inspect -f '{{ index .Config.Labels "build_version" }}' ghcr.io/linuxserver/netbox

更新信息

我们的大多数镜像是静态的、版本化的，需要更新镜像并重新创建容器才能更新内部的应用。除某些例外（如nextcloud、plex），我们不建议或支持在容器内更新应用。请参考上方的应用设置部分，了解是否推荐对此镜像进行应用更新。

以下是更新容器的说明：

通过Docker Compose

• 更新所有镜像：docker-compose pull
  • 或更新单个镜像：docker-compose pull netbox
• 让compose按需更新所有容器：docker-compose up -d
  • 或更新单个容器：docker-compose up -d netbox
• 您还可以删除旧的悬空镜像：docker image prune

通过Docker Run

• 更新镜像：docker pull ghcr.io/linuxserver/netbox
• 停止运行中的容器：docker stop netbox
• 删除容器：docker rm netbox
• 使用上述相同的docker run参数重新创建新容器（如果正确映射到主机文件夹，您的/config文件夹和设置将被保留）
• 您还可以删除旧的悬空镜像：docker image prune

通过Watchtower自动更新器（仅在您不记得原始参数时使用）

• 拉取最新标签的镜像并使用相同的环境变量替换：

  docker run --rm \
  -v /var/run/docker.sock:/var/run/docker.sock \
  containrrr/watchtower \
  --run-once netbox
  

• 您还可以删除旧的悬空镜像：docker image prune

注意： 我们不认可使用Watchtower作为现有Docker容器自动更新的解决方案。事实上，我们通常不鼓励自动更新。但是，对于您忘记原始参数的容器，这是一个有用的一次性手动更新工具。从长远来看，我们强烈建议使用Docker Compose。

镜像更新通知 - Diun（Docker镜像更新通知器）

• 我们推荐Diun用于更新通知。不建议或支持其他自动更新容器的工具。

本地构建

如果您想对这些镜像进行本地修改以用于开发目的或自定义逻辑：

git clone https://github.com/linuxserver/docker-netbox.git
cd docker-netbox
docker build \
  --no-cache \
  --pull \
  -t ghcr.io/linuxserver/netbox:latest .

可以使用multiarch/qemu-user-static在x86_64硬件上构建ARM变体：

docker run --rm --privileged multiarch/qemu-user-static:register --reset

注册后，您可以使用-f Dockerfile.aarch64指定要使用的dockerfile。

版本历史

• 15.03.21： - 添加了SUPERUSER_API_TOKEN环境变量。
• 02.01.21： - 添加了BASE_PATH环境变量。
• 23.08.20： - 初始发布。