extern/netbox-docker
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox-docker.git synced 2025-06-11 12:36:40 +02:00
Code Issues Packages Projects Releases Wiki Activity

Destroyed Startup Scripts (markdown)

Tobias Genannt 2022-09-01 12:57:21 +02:00
parent 10af808ec8
commit 18959e90d3
1 changed files with 0 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
Startup-Scripts.md

@ -1,47 +0,0 @@
When using `docker-compose`, all the python scripts present in `/opt/netbox/startup_scripts` will automatically be executed in the context of `./manage.py` after the application boots.
That mechanism can be used for many things, e.g. to create Netbox custom fields:
```python
# docker/startup_scripts/load_custom_fields.py
from django.contrib.contenttypes.models import ContentType
from extras.models import CF_TYPE_TEXT, CustomField
from dcim.models import Device
from dcim.models import DeviceType
device = ContentType.objects.get_for_model(Device)
device_type = ContentType.objects.get_for_model(DeviceType)
my_custom_field, created = CustomField.objects.get_or_create(
type=CF_TYPE_TEXT,
name='my_custom_field',
description='My own custom field'
)
if created:
my_custom_field.obj_type.add(device)
my_custom_field.obj_type.add(device_type)
```
## Initializer Scripts
There's a bunch of scripts that come pre-built with the Netbox Docker image.
The [wiki page "Initializers"](Initializers) explains how to use them.
## Disable Startup Scripts
The execution of the startup scripts can be prevented by setting the environment variable `SKIP_STARTUP_SCRIPTS` to `true`, e.g. in the file `env/netbox.env`.
## Custom Docker Image
You can also build your own Netbox Docker image containing your own startup scripts, custom fields, users and groups
like this:
```Dockerfile
ARG VERSION=latest
FROM netboxcommunity/netbox:$VERSION
COPY startup_scripts/ /opt/netbox/startup_scripts/
COPY initializers/ /opt/netbox/initializers/
```