From 55149c8c39cd25e2a53a26fd33753ab9813b9221 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Christian=20M=C3=A4der?= <cimnine@users.noreply.github.com>
Date: Wed, 9 Oct 2019 12:22:15 +0200
Subject: [PATCH] Created Initializers (markdown)

---
 Initializers.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 Initializers.md

diff --git a/Initializers.md b/Initializers.md
new file mode 100644
index 0000000..415415e
--- /dev/null
+++ b/Initializers.md
@@ -0,0 +1,35 @@
+Initializers are built-in [startup scripts](Custom-Startup-Scripts) for defining Netbox custom fields, groups, users and many other resources.
+All you need to do is to mount you 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.
+
+Here's an example for defining a custom field:
+
+```yaml
+# initializers/custom_fields.yml
+text_field:
+  type: text
+  label: Custom Text
+  description: Enter text in a text field.
+  required: false
+  filter_logic: loose
+  weight: 0
+  on_objects:
+  - dcim.models.Device
+  - dcim.models.Rack
+  - ipam.models.IPAddress
+  - ipam.models.Prefix
+  - tenancy.models.Tenant
+  - virtualization.models.VirtualMachine
+```
+
+[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
+
+To get an up-to-date list about all the available permissions, run the following command.
+
+```bash
+# Make sure the 'netbox' container is already running! If unsure, run `docker-compose up -d`
+echo "from django.contrib.auth.models import Permission\nfor p in Permission.objects.all():\n  print(p.codename);" | docker-compose exec -T netbox ./manage.py shell
+```
\ No newline at end of file