Merge pull request #1152 from hatchmt/netbox-dns

netbox: dns initial release

Author: aptalca

.github/workflows/BuildImage.yml

@@ -12,10 +12,10 @@ on:
 env:
   GITHUB_REPO: "linuxserver/docker-mods" #don't modify
   ENDPOINT: "linuxserver/mods" #don't modify
-  BASEIMAGE: "replace_baseimage" #replace
-  MODNAME: "replace_modname" #replace
+  BASEIMAGE: "netbox" #replace
+  MODNAME: "dns" #replace
   MOD_VERSION: ${{ inputs.mod_version }} #don't modify
-  MULTI_ARCH: "true" #set to false if not needed
+  MULTI_ARCH: "false" #set to false if not needed
 
 jobs:
   set-vars:

Dockerfile

@@ -2,7 +2,7 @@
 
 FROM scratch
 
-LABEL maintainer="username"
+LABEL maintainer="hatchmt"
 
 # copy local files
 COPY root/ /

Dockerfile.complex

@@ -1,25 +1,23 @@
-# Rsync - Docker mod for openssh-server
+# NetBox DNS - Docker mod for installing the netbox-plugin-dns plugin for NetBox
 
-This mod adds rsync to openssh-server, to be installed/updated during container start.
+This mod adds the [NetBox DNS](https://github.com/sys4/netbox-plugin-dns) plugin (PyPI: `netbox-plugin-dns`) to a netbox container.
 
-In openssh-server docker arguments, set an environment variable `DOCKER_MODS=linuxserver/mods:openssh-server-rsync`
+In netbox docker arguments, set an environment variable `DOCKER_MODS=linuxserver/mods:netbox-dns`
 
-If adding multiple mods, enter them in an array separated by `|`, such as `DOCKER_MODS=linuxserver/mods:openssh-server-rsync|linuxserver/mods:openssh-server-mod2`
+If adding multiple mods, enter them in an array separated by `|`, such as `DOCKER_MODS=linuxserver/mods:netbox-dns|linuxserver/mods:netbox-mod2`
 
-# Mod creation instructions
+Update your `configuration.py` to include the plugin
 
-* Fork the repo, create a new branch based on the branch `template`.
-* Edit the `Dockerfile` for the mod. `Dockerfile.complex` is only an example and included for reference; it should be deleted when done.
-* Inspect the `root` folder contents. Edit, add and remove as necessary.
-* After all init scripts and services are created, run `find ./  -path "./.git" -prune -o \( -name "run" -o -name "finish" -o -name "check" \) -not -perm -u=x,g=x,o=x -print -exec chmod +x {} +` to fix permissions.
-* Edit this readme with pertinent info, delete these instructions.
-* Finally edit the `.github/workflows/BuildImage.yml`. Customize the vars for `BASEIMAGE` and `MODNAME`. Set the versioning logic and `MULTI_ARCH` if needed.
-* Ask the team to create a new branch named `<baseimagename>-<modname>`. Baseimage should be the name of the image the mod will be applied to. The new branch will be based on the `template` branch.
-* Submit PR against the branch created by the team.
+```
+...
+# Enable installed plugins. Add the name of each plugin to the list.
+PLUGINS = ['netbox_dns']
 
+...
+```
 
-## Tips and tricks
+On the next container start, the mod adds `netbox-plugin-dns` to the pip install list before NetBox runs its database migrations, and the plugin's tables will be created automatically.
 
-* Some images have helpers built in, these images are currently:
-    * [Openvscode-server](https://github.com/linuxserver/docker-openvscode-server/pull/10/files)
-    * [Code-server](https://github.com/linuxserver/docker-code-server/pull/95)
+## Removal
+
+Before removing `DOCKER_MODS`, remove `'netbox_dns'` from the `PLUGINS` list in your `configuration.py`. Otherwise NetBox will fail to start because the plugin package will no longer be installed but is still referenced in the configuration.