Home

Welcome to the netbox-docker wiki!

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 commands when something goes wrong, also covers basic backup techniques and upgrading.

Advanced

• Deployment: What to consider when using Netbox Docker in production, e.g. when deploying to Kubernetes.
• 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

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: 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.