diff --git a/Build.md b/Build.md index f59cb40..88b2deb 100644 --- a/Build.md +++ b/Build.md @@ -1,12 +1,22 @@ This document describes two different intentions: -- *Enhance the image*: Adjust the existing Docker image to your organization's needs. - This can reduce the number of environment variables you'd have to configure or you can ship a default configuration by embedding your initializer yaml files. +- *Enhance the image*: Adjust the existing Docker image to the needs of your organization. + This can reduce the number of environment variables you have to configure or you can ship a default configuration by embedding your _initializer_ yaml files. - *Build the image from scratch*: This is mostly useful to you when you work on `netbox-docker` itself. -## Enhance the image +## Which build do you need? -The purpose of enhancing the image is usually to embed additional scripts or change the default configuration file. +**tl;dr: You need the _[Enhance the image](#enhance-the-image)_ build.** + +- Custom Configuration File: [Enhance the image](#enhance-the-image) +- Additional Files: [Enhance the image](#enhance-the-image) +- Custom Nginx Configuration: Either build your own _nginx_-based Docker image or [enhance the _netbox-docker_ image](#enhance-the-image) +- Netbox Plugin: [Enhance the image](#enhance-the-image) +- Develop Netbox: [Build the Image from Scratch](#build-the-image-from-scratch) + +## Enhance the Image + +The purpose of enhancing the image is usually to embed additional scripts, change the default configuration file or add a Netbox plugin. This usually works by using the `netboxcommunity/netbox` image as base image: ```Dockerfile @@ -20,10 +30,12 @@ COPY my_scripts/ /etc/netbox/scripts ``` You don't have to add all the files. -But usually you'd use a selection of them. +Usually you will only copy (and maybe overwrite) the files which you need to adjust. ## Build the Image from Scratch +**Hint: Unless you work on Netbox itself there should be no reason for re-building the image from scratch for your own purposes.** + The `netbox-docker` Docker image has a rather complex build system. That's why all of the complexity is captured in a few build scripts: