lsiodev/netbox

linuxserver/netbox

Netbox 是一款IP地址管理(IPAM)和数据中心基础设施管理(DCIM)工具，最初由DigitalOcean的网络工程团队开发，专为满足网络和基础设施工程师的需求而设计，旨在作为网络运营的特定领域事实来源。

!https://raw.githubusercontent.com/netbox-community/netbox/develop/docs/netbox_logo.svg

支持的架构

我们利用Docker manifest实现多平台支持。只需拉取 lscr.io/linuxserver/netbox:latest 即可获取适合您架构的正确镜像，也可通过标签拉取特定架构的镜像。

支持的架构：

应用设置

Netbox需要PostgreSQL数据库和Redis实例。

通过 :8000 访问Web界面。更多信息请查看 https://github.com/netbox-community/netbox%E3%80%82

使用方法

以下提供Docker Compose和Docker CLI两种方式帮助您创建容器。

Docker Compose（推荐，点击查看更多信息）

yaml
---
version: "2.1"
services:
  netbox:
    image: lscr.io/linuxserver/netbox:latest
    container_name: netbox
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
      - SUPERUSER_EMAIL=
      - SUPERUSER_PASSWORD=
      - ALLOWED_HOST=
      - DB_NAME=
      - DB_USER=
      - DB_PASSWORD=
      - DB_HOST=
      - DB_PORT=
      - REDIS_HOST=
      - REDIS_PORT=
      - REDIS_PASSWORD=
      - REDIS_DB_TASK=
      - REDIS_DB_CACHE=
      - BASE_PATH= #可选
      - REMOTE_AUTH_ENABLED= #可选
      - REMOTE_AUTH_BACKEND= #可选
      - REMOTE_AUTH_HEADER= #可选
      - REMOTE_AUTH_AUTO_CREATE_USER= #可选
      - REMOTE_AUTH_DEFAULT_GROUPS= #可选
      - REMOTE_AUTH_DEFAULT_PERMISSIONS= #可选
    volumes:
      - /path/to/data:/config
    ports:
      - 8000:8000
    restart: unless-stopped

Docker CLI（点击查看更多信息）

bash
docker run -d \
  --name=netbox \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -e SUPERUSER_EMAIL= \
  -e SUPERUSER_PASSWORD= \
  -e ALLOWED_HOST= \
  -e DB_NAME= \
  -e DB_USER= \
  -e DB_PASSWORD= \
  -e DB_HOST= \
  -e DB_PORT= \
  -e REDIS_HOST= \
  -e REDIS_PORT= \
  -e REDIS_PASSWORD= \
  -e REDIS_DB_TASK= \
  -e REDIS_DB_CACHE= \
  -e BASE_PATH= `#可选` \
  -e REMOTE_AUTH_ENABLED= `#可选` \
  -e REMOTE_AUTH_BACKEND= `#可选` \
  -e REMOTE_AUTH_HEADER= `#可选` \
  -e REMOTE_AUTH_AUTO_CREATE_USER= `#可选` \
  -e REMOTE_AUTH_DEFAULT_GROUPS= `#可选` \
  -e REMOTE_AUTH_DEFAULT_PERMISSIONS= `#可选` \
  -p 8000:8000 \
  -v /path/to/data:/config \
  --restart unless-stopped \
  lscr.io/linuxserver/netbox:latest

参数

容器通过运行时传递的参数进行配置，格式为 <外部>:<内部>。例如，-p 8080:80 表示将容器内的80端口映射到主机的8080端口。

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

可通过特殊前缀 FILE__ 从文件设置任何环境变量。例如：

bash
-e FILE__MYVAR=/run/secrets/mysecretvariable

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

应用运行的Umask

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

用户/组标识符

使用卷（-v 标志）时，主机OS和容器之间可能出现权限问题。通过指定用户 PUID 和组 PGID 可避免此问题。

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

此处 PUID=1000 和 PGID=1000，可通过 id your_user 命令查找您的ID：

bash
id your_user

示例输出：

text
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

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%E4%B8%8A%E8%BF%B0%E5%8A%A8%E6%80%81%E5%BE%BD%E7%AB%A0%E5%8F%AF%E8%AE%BF%E9%97%AE%E6%AD%A4%E9%95%9C%E5%83%8F%E7%9A%84%E5%8F%AF%E7%94%A8Mods%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%E4%BB%BB%E4%BD%95LinuxServer.io%E9%95%9C%E5%83%8F%E7%9A%84%E9%80%9A%E7%94%A8Mods%E3%80%82

支持信息

• 容器运行时的Shell访问：

  bash
  docker exec -it netbox /bin/bash
  

• 实时监控容器日志：

  bash
  docker logs -f netbox
  

• 容器版本号：

  bash
  docker inspect -f '{{ index .Config.Labels "build_version" }}' netbox
  

• 镜像版本号：

  bash
  docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/netbox:latest
  

更新信息

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

以下是更新容器的说明：

通过Docker Compose

• 更新镜像：

  • 所有镜像：

    bash
    docker-compose pull
    

  • 单个镜像：

    bash
    docker-compose pull netbox
    

• 更新容器：

  • 所有容器：

    bash
    docker-compose up -d
    

  • 单个容器：

    bash
    docker-compose up -d netbox
    

• 也可删除旧的悬空镜像：

  bash
  docker image prune
  

通过Docker Run

• 更新镜像：

  bash
  docker pull lscr.io/linuxserver/netbox:latest
  

• 停止运行中的容器：

  bash
  docker stop netbox
  

• 删除容器：

  bash
  docker rm netbox
  

• 使用上述相同的docker run参数重新创建新容器（若正确映射到主机文件夹，您的/config文件夹和设置将被保留）

• 也可删除旧的悬空镜像：

  bash
  docker image prune
  

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

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

  bash
  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获取更新通知。不推荐或支持其他自动更新容器的工具。

本地构建

如需为开发目的或自定义逻辑对这些镜像进行本地修改：

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

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

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

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

版本历史

• 2023年6月11日： - 基于Alpine 3.18重建，弃用armhf。
• 2023年5月14日： - 首次运行时构建本地文档。
• 2023年3月5日： - 基于Alpine 3.17重建。
• 2022年11月2日： - 基于Alpine 3.16重建，迁移至s6v3。
• 2022年8月1日： - 移除py3-pillow，添加tiff以修复依赖。
• 2022年7月26日： - 在arm上重新添加py3-pillow包以修复构建问题。
• 2021年12月10日： - 移除py3-pillow包以修复3.2.0的依赖问题。
• 2021年12月10日： - 基于Alpine 3.15重建。
• 2021年4月26日： - 添加Redis数据库环境变量。
• 2021年2月3日： - 添加远程认证环境变量。
• 2021年1月2日： - 添加BASE_PATH环境变量。
• 2020年8月23日： - 初始发布。