Updated Initializers (markdown)

Christian Mäder 2020-03-15 15:20:33 +01:00
parent 4d4c04cc8d
commit 9b0b851097

@ -1,6 +1,4 @@
Initializers are built-in [startup scripts](Startup-Scripts) for defining Netbox custom fields, groups, users and many other resources.
All you need to do is to mount your own `initializers` folder ([see `docker-compose.yml`][netbox-docker-compose]).
Look at the [`initializers` folder][netbox-docker-initializers] to learn how the files must look like.
Initializers are built-in [startup scripts](Startup-Scripts) for defining Netbox custom fields, groups, users and many other resources in YAML files. Just edit the files in the `initializers` folder to get started. See below for a cleaner solution.
Here's an example for defining a custom field:
@ -27,7 +25,21 @@ See [startup scripts](Startup-Scripts) for how to build a Docker image baked wit
[netbox-docker-initializers]: https://github.com/netbox-community/netbox-docker/tree/master/initializers
[netbox-docker-compose]: https://github.com/netbox-community/netbox-docker/blob/master/docker-compose.yml
## Available Groups for User/Group initializers
## Separate Initializers Folder
To reduce the chances of conflicts with your files when updating the Netbox Docker folder you are advised to create a separate `initializers` folder.
Begin by making a copy of the existing folder. Then edit (or create) your `docker-compose.override.yml` file. Edit the file and add/merge the following keys and value:
```yaml
version: '3.4'
services:
netbox:
volumes:
- ./my_initializers:/opt/netbox/initializers:z,ro ## <-- Replace `my_initializers` with the name of your folder
```
## Available Groups for User/Group initializers`
To get an up-to-date list about all the available permissions, run the following command.