🐳 Docker Image of NetBox

docker docker-compose docker-image hacktoberfest netbox python

Go to file

Christian Mäder ec8bc17289 Fix typo.		2017-10-16 13:13:12 +02:00
docker	🐞 The upstream repo remove the docker config	2017-10-13 10:10:43 +02:00
.travis.yml	Builds snapshot image again	2017-10-05 12:48:00 +02:00
Dockerfile	🐞 The upstream repo remove the docker config	2017-10-13 10:10:43 +02:00
README.md	Fix typo.	2017-10-16 13:13:12 +02:00
build-latest.sh	✨ Only build prerelease if version higher than stable	2017-10-13 09:43:29 +02:00
build.sh	✏️ Overhaul of the README	2017-09-11 15:30:52 +02:00
docker-compose.test.yml	🐳 Extracted postgres env into new file	2017-08-30 12:12:17 +02:00
docker-compose.yml	🐳 Extracted postgres env into new file	2017-08-30 12:12:17 +02:00
netbox.env	Restructured docker-compose.yml	2017-04-21 13:46:15 +02:00
postgres.env	🐳 Extracted postgres env into new file	2017-08-30 12:12:17 +02:00

README.md

netbox-docker

This repository houses the components needed to build NetBox as a Docker container. Images built using this code are released to Docker Hub every night.

Quickstart

To get NetBox up and running:

$ git clone -b master https://github.com/ninech/netbox-docker.git
$ cd netbox-docker
$ docker-compose up -d

The application will be available after a few minutes. Use docker-compose port nginx 80 to find out where to connect to.

$ echo "http://$(docker-compose port nginx 80)/"
http://0.0.0.0:32768/

# Open netbox in your default browser on macOS:
$ open "http://$(docker-compose port nginx 80)/"

# Open netbox in your default browser on (most) linuxes:
$ xdg-open "http://$(docker-compose port nginx 80)/" &>/dev/null &

Default credentials:

Username: admin
Password: admin

Dependencies

This project relies only on Docker and docker-compose meeting this requirements:

The Docker version must be at least 1.13.0.
The docker-compose version must be at least 1.10.0.

To ensure this, compare the output of docker --version and docker-compose --version with the requirements above.

Configuration

You can configure the app using environment variables. These are defined in netbox.env.

Rebuilding & Publishing images

./build.sh is used to rebuild the Docker image:

$ ./build.sh --help
Usage: ./build.sh <branch> [--push]
  branch  The branch or tag to build. Required.
  --push  Pushes built Docker image to docker hub.

You can use the following ENV variables to customize the build:
  BRANCH   The branch to build.
           Also used for tagging the image.
  DOCKER_REPO The Docker registry (i.e. hub.docker.com/r/DOCKER_REPO/netbox)
           Also used for tagging the image.
           Default: ninech
  SRC_REPO Which fork of netbox to use (i.e. github.com/<SRC_REPO>/netbox).
           Default: digitalocean
  URL      Where to fetch the package from.
           Must be a tar.gz file of the source code.
           Default: https://github.com/${SRC_REPO}/netbox/archive/$BRANCH.tar.gz

Tests

To run the bundled test, use the docker-compose.test.yml file.

$ docker-compose -f docker-compose.test.yml run --rm app

About

This repository is currently maintained and funded by nine.