Skip to main content
← back to extensions

Netbox

@taylor/netboxv2026.10.11.1· 2d agoBEHAVIORSACCEPTED WARNINGS
01README

Run a NetBox instance for development and testing with Docker Compose: NetBox, its background worker, PostgreSQL and Valkey from the netbox-docker images. Start generates the internal secrets on first run, waits for every service to be healthy, sets the superuser's password from a vault and, optionally, gives it a v2 API token from a vault. Also reports status and stops or removes the project, keeping the volumes unless asked.

02Behaviors1
@taylor/netbox/instancev2026.10.11.1netbox_instance.ts

Global Arguments

ArgumentTypeDescription
name?stringCompose project name; also the prefix for its volumes (<name>-postgres, <name>-media, ...)
image?stringNetBox image, used for both NetBox and its worker
port?numberHost port for the NetBox web UI and API
bindAddress?stringHost address to publish the port on; 0.0.0.0 exposes it to the network
adminUsername?stringSuperuser created on the first start
adminEmail?stringEmail address of the superuser
adminPasswordstringSuperuser password, set on every start; use a vault expression
apiToken?stringOptional v2 API token for the superuser, nbt_<12 letters/digits>.<40 letters/digits>; use a vault expression
dockerPath?stringDocker CLI binary
fn start(timeoutSeconds?: number)
Bring up NetBox, its worker, PostgreSQL and Valkey, wait until they are healthy, and set up the superuser and API token
ArgumentTypeDescription
timeoutSeconds?numberHow long to wait for every service to be healthy; the first start runs database migrations
fn status()
Report whether NetBox and each of its services is running
fn stop()
Stop every container, keeping them and their volumes
fn remove(deleteVolumes?: boolean)
Remove the containers and network; the volumes are kept unless deleteVolumes is set
ArgumentTypeDescription
deleteVolumes?booleanAlso delete the database, media, scripts, Redis and secrets volumes

Resources

instance(infinite)— The NetBox compose project, where to reach it and its services' states
03Stats
A
93 / 100
Downloads
1
Archive size
28.3 KB
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types (deprecated)1/1earned
  • Dependencies pass trust audit2/2earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License1/2partial

    no SPDX license declared

  • Verified public repository2/2earned
Repository
https://github.com/taylorific/swampworks

05Platforms
06Labels
#netbox#docker#dcim#ipam