NetBox Documentation

NetBox: How to run it on your Synology - Maurice Kevenaar's Techblog

Prerequisites

Before we dive into the installation process, there are a few prerequisites you need to have in place:

• A device with Docker and Portainer installed. I have an instance running on my Synology NAS and have a walk-through here.
  • NetBox is unable to run on ARM architecture, so a Raspberry Pi is not the best choice for this project.
  • If you have no other choice, this article has a few work-arounds for you.
• Basic knowledge of Docker and Portainer.

Installing NetBox with Portainer

1. Open your Portainer dashboard and navigate to “Stacks” in the left-hand menu.

1. Click on the Add Stack button.

   

2. Give your stack a name and enter the following code into the Web editor box:

version: '3'

services:
  netbox:
    image: netboxcommunity/netbox
    restart: always
    ports:
      - "8000:8080"
    volumes:
      - /mnt/user/appdata/netbox:/opt/netbox/netbox/media
    environment:
      - DB_HOST=netboxdb
      - DB_NAME=netbox
      - DB_USER=netbox
      - DB_PASSWORD=yourpassword
    depends_on:
      - netboxdb
    networks:
      - default

  netboxdb:
    image: postgres:13-alpine
    restart: always
    volumes:
      - /mnt/user/appdata/netbox:/var/lib/postgresql/data
    environment:
      - POSTGRES_USER=netbox
      - POSTGRES_PASSWORD=yourpassword
      - POSTGRES_DB=netbox
    networks:
      - default

networks:
  default:

• Make sure to check if the port number you are choosing is not in use.
  • If you want to use a different port, simply change the host port in the ports section.
    • HOST:Container port
• You will need to set the “Volumes” location to a directory already created
  • Update in both “netboxcommunity/netbox” image, and “postgres:13-alpine” image sections.
• You can change the “DB_USER” attribute to a username of your choice and make sure to replace “yourpassword” with a strong password of your choice.
  • Update in both “netboxcommunity/netbox” image, and “postgres:13-alpine” image sections.