Home

Welcome to the NetBox Docker wiki!

This wiki is a community project. Everyone is invited to share her/his knowledge and edit the pages freely.

These are currently the most relevant topics in this wiki:

Basics

• Getting Started: How to get started with NetBox Docker for a local installation.
• Configuration: General information about how to configure the Docker image. Read for production use!
• Troubleshooting: Useful tips and tricks when something goes wrong. Also covers basic backup techniques and upgrading.
• How To Update: Describes the intended way to update the project.

Advanced

• Deployment: What to consider when using NetBox Docker in production, e.g. when deploying to Kubernetes.
• Using a specific Version: Describes how to run a specific version of NetBox.
• LDAP: How to use the LDAP variant.
• NAPALM Configuration: How to use the NAPALM feature of NetBox with the Docker image.
• TLS: How to configure TLS for NetBox
• Monitoring: Learn how to use Prometheus and Grafana to monitor your NetBox Docker instance.

Customizing

• Initializers: Initialize NetBox with information (aka Seeds), useful when developing for/with NetBox.
• Startup Scripts: How to write custom scripts that run on startup of the Docker image.
• Custom Reports & Scripts: Add custom python reports to the Docker image.
• Build Image: Build custom images and extend the existing images.
• NetBox Plugins: How to use NetBox Plugins with NetBox Docker

Contributor and Maintainer Guides

• Project Principles: Describes the principles this project is trying to apply.
• Release: Describes how to cut a release.
• Branching Model: Explains the branches in this repo.