extern/netbox-docker
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox-docker.git synced 2025-06-10 20:16:39 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated Build (markdown)

Christian Mäder 2020-06-02 13:22:31 +02:00
parent 18e8e25357
commit b6b3e125dd
1 changed files with 17 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
Build.md

@ -1,12 +1,22 @@
This document describes two different intentions: This document describes two different intentions:
- *Enhance the image*: Adjust the existing Docker image to your organization's needs. - *Enhance the image*: Adjust the existing Docker image to the needs of your organization.
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. 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. - *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: This usually works by using the `netboxcommunity/netbox` image as base image:
```Dockerfile ```Dockerfile
@ -20,10 +30,12 @@ COPY my_scripts/ /etc/netbox/scripts
``` ```
You don't have to add all the files. 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 ## 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. 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: That's why all of the complexity is captured in a few build scripts: