diff --git a/Build.md b/Build.md index eff019b..670d1e6 100644 --- a/Build.md +++ b/Build.md @@ -1,21 +1,21 @@ This document describes two different intentions: -- *Enhance the image*: Adjust the existing Docker image to the needs of your organization. +- *Extend 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. ## Which build do you need? -**tl;dr: You need the _[Enhance the image](#enhance-the-image)_ build.** +**tl;dr: You need the _[Extend the image](#extend-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) +- Custom Configuration File: [Extend the image](#extend-the-image) +- Additional Files: [Extend the image](#extend-the-image) +- Custom Nginx Configuration: Either build your own _nginx_-based Docker image or [extend the _netbox-docker_ image](#extend-the-image) +- NetBox Plugin: [Extend the image](#extend-the-image) - ⚠️ See the extra guide [Using NetBox Plugins](Using-Netbox-Plugins) - Develop NetBox : [Build the Image from Scratch](#build-the-image-from-scratch) -## Enhance the Image +## Extend 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: