Docker

Recommended System Specification

If installing Docker in a virtual machine without a graphical desktop, it is recommended that at least 8GB disk space and 2GB RAM is allocated. After installing essential utilities, Docker, and Nautobot, 2.4GB is available on an 8GB virtual disk.

Installation

Use the instructions on the Docker website to install Docker on Debian. Docker can be installed inside of a virtual machine.

Brief Instructions

These instructions are based on the instructions on the Docker website. If they are contradicted by the official instructions, use the official instructions.

su

# Add Docker's official GPG key:
apt-get update
apt-get install ca-certificates curl gnupg
install -m 0755 -d /etc/apt/keyrings
curl -fsSL https://download.docker.com/linux/debian/gpg | \
    gpg --dearmor -o /etc/apt/keyrings/docker.gpg
chmod a+r /etc/apt/keyrings/docker.gpg

# Add the repository to Apt sources:
echo \
  "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/debian \
   $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
   tee /etc/apt/sources.list.d/docker.list > /dev/null
apt-get update

apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin

Docker Compose

A single additional command installs Docker Compose;

apt install docker-compose

Nautobot

Installation with Docker Compose

Use the Nautobot Docker Compose configuration to quickly and easily install Nautobot. The configuration is on the Nautobot Compose Github repository.

To run the docker-compose configuration, first clone the repository;

git clone https://github.com/nautobot/nautobot-docker-compose.git
cd nautobot-docker-compose

Copy the example config;

cp local.env.example local.env
chmod 0600 local.env

Start the environment (as root);

docker-compose up

Nautobot will be exposed on the host’s port 8080.

Creating a Superuser

The quickest way to create the superuser account is to edit the local.env file, locate the ‘NAUTOBOT_CREATE_SUPERUSER’ variable line, and set the value to ‘true’.