{
  "schema_version": "0.3.0",
  "kind": "proxmenux.oci-template",
  "id": "linuxserver-netbox",
  "status": "generated-unvalidated",
  "catalog_ui": {
    "title": {
      "en_US": "Netbox"
    },
    "tagline": {
      "en_US": "Netbox is an IP address management (IPAM) and data center infrastructure management (DCIM) tool. Initially conceived by the network engineering team at DigitalOcean, NetBox was developed specifically to address the needs of network and infrastructure engineers. It is intended to function as a domain-specific source of truth for network operations."
    },
    "description": {
      "en_US": "Netbox is an IP address management (IPAM) and data center infrastructure management (DCIM) tool. Initially conceived by the network engineering team at DigitalOcean, NetBox was developed specifically to address the needs of network and infrastructure engineers. It is intended to function as a domain-specific source of truth for network operations."
    },
    "category": "network",
    "category_label": "Network & Firewall",
    "author": "LinuxServer.io",
    "developer": null,
    "icon": "https://cdn.jsdelivr.net/gh/selfhst/icons@main/webp/netbox.webp",
    "thumbnail": "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/netbox-banner.png",
    "screenshots": [],
    "architectures": [
      "amd64",
      "arm64"
    ],
    "launch": {
      "scheme": "http",
      "port": 8000,
      "path": "/"
    },
    "website": "https://github.com/netbox-community/netbox",
    "documentation": "https://docs.linuxserver.io/images/docker-netbox/",
    "repository": "https://github.com/linuxserver/docker-netbox",
    "tips": [],
    "mini_changelog": [
      {
        "date": "2026-01-05",
        "note": "Rebase to Alpine 3.23. Add CSRF_TRUSTED_ORIGINS env settings. Drop support for environments with explicitly disabled IPv6."
      },
      {
        "date": "2024-08-26",
        "note": "Restructure init to allow for plugins as mods."
      },
      {
        "date": "2024-07-16",
        "note": "Add required packages for LDAP support."
      },
      {
        "date": "2024-06-01",
        "note": "Rebase to Alpine 3.20."
      },
      {
        "date": "2023-12-23",
        "note": "Rebase to Alpine 3.19."
      }
    ],
    "display_version": null,
    "updated_at": "2026-01-05"
  },
  "source": {
    "provider": "linuxserver.io",
    "repository": "https://github.com/linuxserver/docker-netbox",
    "default_branch": "master",
    "revision": "ff7be89287df90a2204cb7443649f7ad061704e2",
    "readme_raw_url": "https://raw.githubusercontent.com/linuxserver/docker-netbox/ff7be89287df90a2204cb7443649f7ad061704e2/README.md",
    "readme_pushed_at": "2026-09-10T18:59:34Z",
    "compose_sha256": "c90d3bd873cb09a3906d82ede5bff290ea6916b86664d244992a37ca8faf8f76",
    "generated_at": "2026-09-12T14:37:32+00:00"
  },
  "container_contract": {
    "service_name": "netbox",
    "container_name": "netbox",
    "image": {
      "reference": "lscr.io/linuxserver/netbox:latest",
      "registry": "lscr.io",
      "repository": "lscr.io/linuxserver/netbox",
      "tag": "latest",
      "digest": null,
      "pull_policy": "resolve-selected-tag-to-architecture-digest-at-install"
    },
    "environment": [
      {
        "name": "PUID",
        "example": "1000",
        "required": true,
        "sensitive": false,
        "source": "linuxserver-compose"
      },
      {
        "name": "PGID",
        "example": "1000",
        "required": true,
        "sensitive": false,
        "source": "linuxserver-compose"
      },
      {
        "name": "TZ",
        "example": "Etc/UTC",
        "required": true,
        "sensitive": false,
        "source": "linuxserver-compose"
      },
      {
        "name": "SUPERUSER_EMAIL",
        "example": "",
        "required": true,
        "sensitive": false,
        "source": "linuxserver-compose"
      },
      {
        "name": "SUPERUSER_PASSWORD",
        "example": "",
        "required": true,
        "sensitive": true,
        "source": "linuxserver-compose"
      },
      {
        "name": "ALLOWED_HOST",
        "example": "",
        "required": true,
        "sensitive": false,
        "source": "linuxserver-compose"
      },
      {
        "name": "DB_NAME",
        "example": "",
        "required": true,
        "sensitive": false,
        "source": "linuxserver-compose"
      },
      {
        "name": "DB_USER",
        "example": "",
        "required": true,
        "sensitive": false,
        "source": "linuxserver-compose"
      },
      {
        "name": "DB_PASSWORD",
        "example": "",
        "required": true,
        "sensitive": true,
        "source": "linuxserver-compose"
      },
      {
        "name": "DB_HOST",
        "example": "",
        "required": true,
        "sensitive": false,
        "source": "linuxserver-compose"
      },
      {
        "name": "DB_PORT",
        "example": "",
        "required": true,
        "sensitive": false,
        "source": "linuxserver-compose"
      },
      {
        "name": "REDIS_HOST",
        "example": "",
        "required": true,
        "sensitive": false,
        "source": "linuxserver-compose"
      },
      {
        "name": "REDIS_PORT",
        "example": "",
        "required": true,
        "sensitive": false,
        "source": "linuxserver-compose"
      },
      {
        "name": "REDIS_USERNAME",
        "example": "",
        "required": true,
        "sensitive": false,
        "source": "linuxserver-compose"
      },
      {
        "name": "REDIS_PASSWORD",
        "example": "",
        "required": true,
        "sensitive": true,
        "source": "linuxserver-compose"
      },
      {
        "name": "REDIS_DB_TASK",
        "example": "",
        "required": true,
        "sensitive": false,
        "source": "linuxserver-compose"
      },
      {
        "name": "REDIS_DB_CACHE",
        "example": "",
        "required": true,
        "sensitive": false,
        "source": "linuxserver-compose"
      },
      {
        "name": "BASE_PATH",
        "example": "",
        "required": false,
        "sensitive": false,
        "source": "linuxserver-compose"
      },
      {
        "name": "CSRF_TRUSTED_ORIGINS",
        "example": "",
        "required": false,
        "sensitive": false,
        "source": "linuxserver-compose"
      },
      {
        "name": "REMOTE_AUTH_ENABLED",
        "example": "",
        "required": false,
        "sensitive": false,
        "source": "linuxserver-compose"
      },
      {
        "name": "REMOTE_AUTH_BACKEND",
        "example": "",
        "required": false,
        "sensitive": false,
        "source": "linuxserver-compose"
      },
      {
        "name": "REMOTE_AUTH_HEADER",
        "example": "",
        "required": false,
        "sensitive": false,
        "source": "linuxserver-compose"
      },
      {
        "name": "REMOTE_AUTH_AUTO_CREATE_USER",
        "example": "",
        "required": false,
        "sensitive": false,
        "source": "linuxserver-compose"
      },
      {
        "name": "REMOTE_AUTH_DEFAULT_GROUPS",
        "example": "",
        "required": false,
        "sensitive": false,
        "source": "linuxserver-compose"
      },
      {
        "name": "REMOTE_AUTH_DEFAULT_PERMISSIONS",
        "example": "",
        "required": false,
        "sensitive": false,
        "source": "linuxserver-compose"
      }
    ],
    "volumes": [
      {
        "id": "volume-0",
        "container_path": "/config",
        "compose_source_example": "/path/to/netbox/config",
        "read_only": false,
        "required": true,
        "installation_choice": [
          "managed-volume",
          "host-bind"
        ],
        "default": "managed-volume",
        "managed_volume": {
          "backup": true,
          "default_size_gb": 4
        }
      }
    ],
    "ports": [
      {
        "container_port": 8000,
        "published_example": 8000,
        "protocol": "tcp",
        "required": true,
        "proxmox_behavior": "listener-on-dedicated-lxc-address-no-nat"
      }
    ],
    "related_services": [],
    "restart": "unless-stopped",
    "stop_grace_period": null,
    "original_compose": "---\nservices:\n  netbox:\n    image: lscr.io/linuxserver/netbox:latest\n    container_name: netbox\n    environment:\n      - PUID=1000\n      - PGID=1000\n      - TZ=Etc/UTC\n      - SUPERUSER_EMAIL=\n      - SUPERUSER_PASSWORD=\n      - ALLOWED_HOST=\n      - DB_NAME=\n      - DB_USER=\n      - DB_PASSWORD=\n      - DB_HOST=\n      - DB_PORT=\n      - REDIS_HOST=\n      - REDIS_PORT=\n      - REDIS_USERNAME=\n      - REDIS_PASSWORD=\n      - REDIS_DB_TASK=\n      - REDIS_DB_CACHE=\n      - BASE_PATH= #optional\n      - CSRF_TRUSTED_ORIGINS= #optional\n      - REMOTE_AUTH_ENABLED= #optional\n      - REMOTE_AUTH_BACKEND= #optional\n      - REMOTE_AUTH_HEADER= #optional\n      - REMOTE_AUTH_AUTO_CREATE_USER= #optional\n      - REMOTE_AUTH_DEFAULT_GROUPS= #optional\n      - REMOTE_AUTH_DEFAULT_PERMISSIONS= #optional\n    volumes:\n      - /path/to/netbox/config:/config\n    ports:\n      - 8000:8000\n    restart: unless-stopped\n"
  },
  "first_run": {
    "endpoints": [
      {
        "label": "Web UI",
        "scheme": "http",
        "port": 8000,
        "path": "/",
        "source": "compose-first-tcp-port-fallback"
      }
    ],
    "credentials": []
  },
  "proxmox": {
    "runtime": "native-oci-lxc",
    "technology_status": "proxmox-technology-preview",
    "defaults": {
      "unprivileged": true,
      "ostype": "auto-from-image",
      "cores": 2,
      "memory_mb": 1024,
      "swap_mb": 512,
      "rootfs_size_gb": 8,
      "rootfs_storage": "local-lvm",
      "volume_storage": "local-lvm",
      "template_storage": "local",
      "bridge": "vmbr0",
      "ipv4": "dhcp",
      "firewall": true,
      "host_managed_network": true,
      "onboot": false,
      "features": [
        "nesting=1"
      ],
      "shutdown_timeout_seconds": 30
    },
    "image_metadata_policy": {
      "entrypoint": "import-from-oci-image",
      "cmd": "import-from-oci-image",
      "environment": "import-image-env-then-apply-compose-overrides",
      "user": "import-from-oci-image",
      "working_dir": "import-from-oci-image",
      "stop_signal": "import-from-oci-image"
    },
    "adaptations": [
      {
        "id": "dedicated-lxc-network",
        "upstream_behavior": "Docker publishes selected container ports on the Docker host.",
        "native_lxc_behavior": "The application listens on the same container ports at its dedicated LXC address.",
        "reason": "A native LXC has its own address and does not require Docker port NAT.",
        "behavioral_impact": "Users open the LXC address instead of the Proxmox host address.",
        "validation": "pending-per-application"
      },
      {
        "id": "compose-environment-overlay",
        "upstream_behavior": "Compose environment values override OCI image environment values.",
        "native_lxc_behavior": "ProxMenux merges the same values into lxc.environment.runtime while the CT is stopped.",
        "reason": "PVE imports image Env automatically; Compose values still need to override it.",
        "behavioral_impact": "None expected.",
        "validation": "pending-per-application"
      },
      {
        "id": "stop-grace-period",
        "upstream_behavior": "Docker waits for Compose stop_grace_period before forcing termination.",
        "native_lxc_behavior": "ProxMenux records the same timeout for its pct shutdown lifecycle operations.",
        "reason": "Proxmox has no equivalent per-CT persistent restart-policy field; startup.down is not a shutdown timeout.",
        "behavioral_impact": "Normal Proxmox node shutdown remains governed by the node-wide shutdown policy.",
        "validation": "not-requested-by-compose"
      }
    ]
  },
  "compatibility": {
    "automatic_install_candidate": true,
    "validated": false,
    "supported_compose_keys": [
      "container_name",
      "environment",
      "image",
      "ports",
      "restart",
      "stop_grace_period",
      "volumes"
    ],
    "untranslated_blockers": [],
    "policy": "A generated template is never promoted to validated without install, health, restart and persistence tests."
  },
  "validation": {
    "schema": "passed-at-generation",
    "clean_install": "pending",
    "service_health": "pending",
    "restart_persistence": "pending",
    "backup_restore": "pending",
    "update_preserves_data": "pending"
  },
  "lifecycle": {
    "update_strategy": "replace-rootfs-from-new-oci-image-preserve-managed-volumes",
    "registry_state": {
      "resolved_architecture": null,
      "resolved_digest": null,
      "image_version_label": null,
      "image_created": null
    },
    "change_detection": "compare-resolved-architecture-digest",
    "automatic_unattended_updates": false
  }
}