Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/jalmargyyk/netbox-ripe-updater/llms.txt

Use this file to discover all available pages before exploring further.

Netbox RIPE Updater is configured through two environment files that serve distinct roles: .env controls Docker Compose-level settings such as the host port binding, the Minio object-storage credentials, and the path to your RIPE templates, while .env.updater configures the application itself — NetBox connectivity, RIPE database credentials, email reporting, and S3 backup settings. Keeping these files separate makes it easier to manage infrastructure concerns independently from application secrets.
The default Minio credentials in .env (MINIO_ROOT_USER and MINIO_ROOT_PASSWORD) are shared examples. Replace them with strong, unique values before any production deployment. The matching S3_ACCESS_KEY and S3_SECRET_ACCESS_KEY values in .env.updater must be updated to the same credentials.

​
.env — Docker Compose settings

These variables are read by Docker Compose to configure the host environment and the Minio service.
VariableDefaultDescription
UPDATER_HTTP_PORT127.0.0.1:9000Host address and port that the updater service binds to. Change the address to 0.0.0.0 to expose it on all interfaces.
RIPE_TEMPLATE_DIR./ripe-templates/examplePath to the directory containing your RIPE templates. Copy the example directory and point this variable to your custom copy.
MINIO_ROOT_USERCjGb9PDkjQqMi6VRoot username for the bundled Minio instance. Must match S3_ACCESS_KEY in .env.updater.
MINIO_ROOT_PASSWORD8s82NHXq6pPsJAP4SRoot password for the bundled Minio instance. Must match S3_SECRET_ACCESS_KEY in .env.updater.
.env
# The port/address which the updater will bind to on the host machine.
UPDATER_HTTP_PORT=127.0.0.1:9000

# The template directory to use for the RIPE updater (copy your templates to 'custom' & change this)
RIPE_TEMPLATE_DIR=./ripe-templates/example

# Minio access details
# When changing, update S3_ACCESS_KEY & S3_SECRET_ACCESS_KEY in .env.updater too
MINIO_ROOT_USER=CjGb9PDkjQqMi6V
MINIO_ROOT_PASSWORD=8s82NHXq6pPsJAP4S

​
.env.updater — Application settings

These variables are injected into the updater container and read by ripeupdater/configuration.py. They are grouped below by functional area.

​
UI authentication

VariableTypeDefaultDescription
UI_USERstring—Username for HTTP basic auth protecting the /backups UI.
UI_PASSWORDstring—Password for HTTP basic auth protecting the /backups UI.
UPDATE_TOKENstring—When set, every NetBox webhook must include Authorisation: Token <value> in its headers.

​
NetBox

VariableTypeDefaultDescription
NETBOX_URLURL—Full URL of your NetBox instance, e.g. https://netbox.local.
NETBOX_TOKENstring—NetBox API token with read access to prefixes, aggregates, regions, and sites.

​
RIPE

VariableTypeDefaultDescription
RIPE_API_USERstring—RIPE NCC API username with write permissions to your INET(6)NUM objects.
RIPE_API_PASSstring—RIPE NCC API password with write permissions to your INET(6)NUM objects.
RIPE_DBRIPE / TESTTESTWhich RIPE database to write to. Use TEST during initial setup and RIPE for production.
DEFAULT_COUNTRYISO 3166-1 alpha-2—Fallback country code used when a prefix’s site has no parent country region, e.g. GB or DE.
SMALLEST_PREFIX_V40–3231IPv4 prefixes longer than this value are ignored and not written to RIPE-DB.
SMALLEST_PREFIX_V60–128127IPv6 prefixes longer than this value are ignored and not written to RIPE-DB.

​
S3 / backup

VariableTypeDefaultDescription
S3_BACKUPyes / noyesEnable or disable S3 backups of deleted and overwritten RIPE objects.
S3_ENDPOINT_URLURLhttp://minio:9000URL of your S3-compatible endpoint. Defaults to the bundled Minio container.
S3_ACCESS_KEYstring—S3 access key. Must match MINIO_ROOT_USER when using the bundled Minio.
S3_SECRET_ACCESS_KEYstring—S3 secret access key. Must match MINIO_ROOT_PASSWORD when using the bundled Minio.
S3_BUCKETstringripe-backupsS3 bucket name where backup objects are stored.

​
General

VariableTypeDefaultDescription
DEBUGyes / nonoEnable verbose logging. Useful for troubleshooting webhook delivery and RIPE API calls.
MAIL_REPORTyes / nonoEnable email reports on RIPE-DB update activity.
SMTPURL / IP127.0.0.1Address of the SMTP server used to send email reports.
SMTP_STARTTLSyes / nonoUse STARTTLS when connecting to the SMTP server.
SENDER_MAILemail—From address used in email reports.
RECIPIENT_MAILemail—Destination address for email reports.
TEMPLATES_DIRpath/opt/ripeupdater/templatesFilesystem path inside the container where RIPE templates are mounted.
INCLUDE_ORGyes / noyesInclude the org attribute on INETNUM and INET6NUM objects.
INCLUDE_DESCRyes / noyesInclude the descr attribute on INETNUM and INET6NUM objects.
.env.updater
# UI credentials, ie /backups (Administrators -> Updater UI)
UI_USER=admin
UI_PASSWORD=password

# Update API credentials (Netbox -> Updater)
UPDATE_TOKEN=Token 123456abcdef

# Netbox API (Updater -> Netbox)
NETBOX_URL=https://netbox.local
NETBOX_TOKEN=123456abcdef

# RIPE (Updater -> RIPE)
DEFAULT_COUNTRY=GB
RIPE_API_USER=empty_user
RIPE_API_PASS=empty_pass
RIPE_DB=TEST

# S3 (Minio by default) backup storage (these must match Minio credentials in .env if using Minio)
S3_ACCESS_KEY=CjGb9PDkjQqMi6V
S3_SECRET_ACCESS_KEY=8s82NHXq6pPsJAP4S
#S3_ENDPOINT_URL (defaulted to local Minio)

# Misc
DEBUG=no

NetBox setup

Configure custom fields, regions, and the webhook in NetBox.

Templates

Define RIPE object attributes using the JSON template system.

Build docs developers (and LLMs) love

Get started for freeTalk to us