---
kind: compose
metadata:
  name: NetBox
  description: |-
    Network infrastructure management (IPAM/DCIM) and network automation source of truth. Provides comprehensive API
    for managing IP addresses, circuits, devices, racks, cables, and other network infrastructure components with powerful
    automation capabilities.
    ## References
    - **Project:** https://netbox.dev/
    - **Documentation:** https://docs.netbox.dev/
    - **GitHub:** https://github.com/netbox-community/netbox
  version: 4.2.3
  author: Christian Lempa
  date: "2025-11-13"
  tags:
    - traefik
    - database
    - email
  icon:
    provider: selfh
    id: netbox
  draft: false
  next_steps: |-
    Log in with your initial admin user:
    ```bash
    Username: admin
    Password: admin
    ```
schema: 1.2
spec:
  database:
    vars:
      database_name:
        default: netbox
      database_user:
        default: netbox
      redis_password:
        description: Redis password for authentication
        type: str
        sensitive: true
        autogenerated: true
        required: true
  general:
    vars:
      service_name:
        default: netbox
  netbox:
    title: NetBox Configuration
    description: Configure NetBox application settings
    vars:
      netbox_metrics_enabled:
        description: Enable Prometheus metrics endpoint
        type: bool
        default: false
      netbox_secret_key:
        description: Secret Key
        type: str
        sensitive: true
        autogenerated: true
        autogenerated_length: 50
        required: true
        extra: Used for cryptographic signing and session management
  ports:
    vars:
      ports_http:
        description: Host port for HTTP
        default: 8000
  traefik:
    vars:
      traefik_host:
        default: netbox