---
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: v4.5.0
  author: Christian Lempa
  date: '2026-01-07'
  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
      database_host:
        type: str
        required: true
      database_password:
        type: str
        sensitive: true
        required: true
      redis_password:
        description: Redis password for authentication
        type: str
        sensitive: true
        autogenerated: true
        required: true
      database_external:
        type: bool
        default: false
        description: Use external database
  email:
    vars:
      email_host:
        description: SMTP server hostname
        type: str
        required: true
      email_port:
        description: SMTP server port
        type: int
        default: 25
        required: true
      email_username:
        description: SMTP username
        type: str
        required: true
      email_password:
        description: SMTP password
        type: str
        sensitive: true
        required: true
      email_from:
        description: From email address
        type: str
        required: true
      email_enabled:
        type: bool
        default: false
        description: Enable email integration
      email_encryption:
        type: str
        default: tls
        description: The email encryption type
  general:
    vars:
      service_name:
        default: netbox
      container_timezone:
        type: str
      restart_policy:
        type: enum
        options:
          - unless-stopped
          - always
          - on-failure
          - 'no'
        default: unless-stopped
        required: true
  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
      traefik_network:
        default: traefik
        type: str
        required: true
      traefik_domain:
        default: home.arpa
        type: str
        required: true
      traefik_enabled:
        type: bool
        default: false
        description: Enable Traefik integration
  traefik_tls:
    vars:
      traefik_tls_certresolver:
        type: str
        default: cloudflare
        required: true
      traefik_tls_enabled:
        type: bool
        default: false
        description: Enable Traefik TLS