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 ships as a self-contained Docker Compose stack. Within a few minutes you will have the updater service and a local Minio backup store running, ready to receive webhooks from NetBox and push changes to the RIPE database. The steps below walk you through every command needed to get from a fresh clone to a running, healthy service.
1

Clone the repository

Clone the repository and move into the project directory:
git clone https://github.com/grizzlyware/netbox-ripe-updater.git
cd netbox-ripe-updater
2

Copy the environment files

The project ships two example environment files. Copy both to create your working configuration:
cp .env.example .env
cp .env.updater.example .env.updater
The .env file controls Docker Compose-level settings (ports, Minio credentials, template directory). The .env.updater file is passed directly into the updater container and controls NetBox, RIPE, and S3 connection details.
# 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
3

Edit your configuration

Open .env and .env.updater and update the values to match your environment.
Change MINIO_ROOT_USER and MINIO_ROOT_PASSWORD in .env, and the matching S3_ACCESS_KEY and S3_SECRET_ACCESS_KEY in .env.updater, before starting the stack. The example values are public and must not be used in production.
Key values to set in .env.updater:
VariableDescription
UI_USER / UI_PASSWORDCredentials for the /backups web interface
UPDATE_TOKENToken NetBox uses to authenticate webhook calls to /update
NETBOX_URL / NETBOX_TOKENURL and API token for your NetBox instance
RIPE_API_USER / RIPE_API_PASSYour RIPE DB API credentials
RIPE_DBTarget RIPE database — TEST or RIPE
RIPE_DB defaults to TEST, which writes to the RIPE test database. This is safe for initial setup and lets you verify the full pipeline without touching live RIPE objects. Change it to RIPE only when you are ready to push to production.
See Environment variables for the full reference.
4

Configure templates

Copy your RIPE object templates into the custom directory (or another directory of your choice) and update RIPE_TEMPLATE_DIR in .env to point to it:
RIPE_TEMPLATE_DIR=./ripe-templates/custom
The ripe-templates/example directory contains example templates you can use as a starting point.
5

Start the stack

Build and start all containers:
docker compose up
Add the -d flag to run in the background:
docker compose up -d
Docker Compose will build the ripe-updater image and start the minio container. The updater waits for Minio to be available before it starts.
6

Verify the service is healthy

Once the containers are running, check the health endpoint:
curl http://localhost:9000/health
A healthy service returns:
Ok
If you changed UPDATER_HTTP_PORT in .env, replace 9000 with the port you configured.

​
Next steps

With the stack running and healthy, connect NetBox and review the full configuration reference:

Environment variables

Full reference for every variable in .env and .env.updater

NetBox setup

Configure custom fields, regions, and webhooks in NetBox

Build docs developers (and LLMs) love

Get started for freeTalk to us