update
This commit is contained in:
Mike McFetridge
@@ -0,0 +1,9 @@
|
||||
# NetBox credentials
|
||||
DATABASE_USER=<< database_user >>
|
||||
DATABASE_PASSWORD=<< database_password >>
|
||||
REDIS_PASSWORD=<< redis_password >>
|
||||
NETBOX_SECRET_KEY=<< netbox_secret_key >>
|
||||
<%- if email_enabled %>
|
||||
EMAIL_USERNAME=<< email_username >>
|
||||
EMAIL_PASSWORD=<< email_password >>
|
||||
<%- endif %>
|
||||
@@ -0,0 +1,199 @@
|
||||
---
|
||||
services:
|
||||
<< service_name >>:
|
||||
image: docker.io/netboxcommunity/netbox:v4.5.10
|
||||
restart: << restart_policy >>
|
||||
environment:
|
||||
<%- if container_timezone %>
|
||||
- TIME_ZONE=<< container_timezone >>
|
||||
<%- endif %>
|
||||
<%- if traefik_enabled %>
|
||||
- ALLOWED_HOSTS=<< traefik_host >>.<< traefik_domain >>
|
||||
<%- else %>
|
||||
- ALLOWED_HOSTS=*
|
||||
<%- endif %>
|
||||
<%- if database_external %>
|
||||
- DB_HOST=<< database_host >>
|
||||
<%- else %>
|
||||
- DB_HOST=<< service_name >>_postgres
|
||||
<%- endif %>
|
||||
- DB_NAME=<< database_name >>
|
||||
- DB_USER=${DATABASE_USER}
|
||||
- DB_PASSWORD=${DATABASE_PASSWORD}
|
||||
- REDIS_HOST=<< service_name >>_redis
|
||||
- REDIS_PASSWORD=${REDIS_PASSWORD}
|
||||
- REDIS_CACHE_HOST=<< service_name >>_redis-cache
|
||||
- REDIS_CACHE_PASSWORD=${REDIS_PASSWORD}
|
||||
- SECRET_KEY=${NETBOX_SECRET_KEY}
|
||||
<%- if netbox_metrics_enabled %>
|
||||
- METRICS_ENABLED=true
|
||||
<%- endif %>
|
||||
<%- if email_enabled %>
|
||||
- EMAIL_SERVER=<< email_host >>
|
||||
- EMAIL_PORT=<< email_port >>
|
||||
- EMAIL_FROM=<< email_from >>
|
||||
- EMAIL_USERNAME=${EMAIL_USERNAME}
|
||||
- EMAIL_PASSWORD=${EMAIL_PASSWORD}
|
||||
<%- if email_encryption == "ssl" %>
|
||||
- EMAIL_USE_SSL=True
|
||||
<%- elif email_encryption == "starttls" %>
|
||||
- EMAIL_USE_TLS=True
|
||||
<%- endif %>
|
||||
<%- endif %>
|
||||
networks:
|
||||
<%- if traefik_enabled %>
|
||||
<< traefik_network >>:
|
||||
<%- endif %>
|
||||
<< service_name >>_backend:
|
||||
<%- if not traefik_enabled %>
|
||||
ports:
|
||||
- "<< ports_http >>:8080"
|
||||
<%- endif %>
|
||||
volumes:
|
||||
- << service_name >>_media:/opt/netbox/netbox/media
|
||||
- << service_name >>_reports:/opt/netbox/netbox/reports
|
||||
- << service_name >>_scripts:/opt/netbox/netbox/scripts
|
||||
<%- if traefik_enabled %>
|
||||
labels:
|
||||
- traefik.enable=true
|
||||
- traefik.docker.network=<< traefik_network >>
|
||||
- traefik.http.services.<< service_name >>_web.loadBalancer.server.port=8080
|
||||
- traefik.http.routers.<< service_name >>_http.service=<< service_name >>_web
|
||||
- traefik.http.routers.<< service_name >>_http.rule=Host(`<< traefik_host >>.<< traefik_domain >>`)
|
||||
- traefik.http.routers.<< service_name >>_http.entrypoints=<< traefik_entrypoint >>
|
||||
<%- if traefik_tls_enabled %>
|
||||
- traefik.http.routers.<< service_name >>_https.service=<< service_name >>_web
|
||||
- traefik.http.routers.<< service_name >>_https.rule=Host(`<< traefik_host >>.<< traefik_domain >>`)
|
||||
- traefik.http.routers.<< service_name >>_https.entrypoints=<< traefik_tls_entrypoint >>
|
||||
- traefik.http.routers.<< service_name >>_https.tls=true
|
||||
- traefik.http.routers.<< service_name >>_https.tls.certresolver=<< traefik_tls_certresolver >>
|
||||
<%- endif %>
|
||||
<%- endif %>
|
||||
depends_on:
|
||||
<%- if not database_external %>
|
||||
- << service_name >>_postgres
|
||||
<%- endif %>
|
||||
- << service_name >>_redis
|
||||
- << service_name >>_redis-cache
|
||||
|
||||
<< service_name >>_worker:
|
||||
image: docker.io/netboxcommunity/netbox:v4.5.10
|
||||
restart: << restart_policy >>
|
||||
command:
|
||||
- /opt/netbox/venv/bin/python
|
||||
- /opt/netbox/netbox/manage.py
|
||||
- rqworker
|
||||
environment:
|
||||
<%- if container_timezone %>
|
||||
- TIME_ZONE=<< container_timezone >>
|
||||
<%- endif %>
|
||||
<%- if database_external %>
|
||||
- DB_HOST=<< database_host >>
|
||||
<%- else %>
|
||||
- DB_HOST=<< service_name >>_postgres
|
||||
<%- endif %>
|
||||
- DB_NAME=<< database_name >>
|
||||
- DB_USER=${DATABASE_USER}
|
||||
- DB_PASSWORD=${DATABASE_PASSWORD}
|
||||
- REDIS_HOST=<< service_name >>_redis
|
||||
- REDIS_PASSWORD=${REDIS_PASSWORD}
|
||||
- REDIS_CACHE_HOST=<< service_name >>_redis-cache
|
||||
- REDIS_CACHE_PASSWORD=${REDIS_PASSWORD}
|
||||
- SECRET_KEY=${NETBOX_SECRET_KEY}
|
||||
<%- if netbox_metrics_enabled %>
|
||||
- METRICS_ENABLED=true
|
||||
<%- endif %>
|
||||
<%- if email_enabled %>
|
||||
- EMAIL_SERVER=<< email_host >>
|
||||
- EMAIL_PORT=<< email_port >>
|
||||
- EMAIL_FROM=<< email_from >>
|
||||
- EMAIL_USERNAME=${EMAIL_USERNAME}
|
||||
- EMAIL_PASSWORD=${EMAIL_PASSWORD}
|
||||
<%- if email_encryption == "ssl" %>
|
||||
- EMAIL_USE_SSL=True
|
||||
<%- elif email_encryption == "starttls" %>
|
||||
- EMAIL_USE_TLS=True
|
||||
<%- endif %>
|
||||
<%- endif %>
|
||||
networks:
|
||||
<< service_name >>_backend:
|
||||
volumes:
|
||||
- << service_name >>_media:/opt/netbox/netbox/media
|
||||
- << service_name >>_reports:/opt/netbox/netbox/reports
|
||||
- << service_name >>_scripts:/opt/netbox/netbox/scripts
|
||||
depends_on:
|
||||
<%- if not database_external %>
|
||||
- << service_name >>_postgres
|
||||
<%- endif %>
|
||||
- << service_name >>
|
||||
- << service_name >>_redis
|
||||
- << service_name >>_redis-cache
|
||||
|
||||
<< service_name >>_redis:
|
||||
image: docker.io/library/redis:8.6.2-alpine
|
||||
restart: << restart_policy >>
|
||||
command: ["redis-server", "--requirepass", "${REDIS_PASSWORD}"]
|
||||
environment:
|
||||
- REDIS_PASSWORD=${REDIS_PASSWORD}
|
||||
networks:
|
||||
<< service_name >>_backend:
|
||||
volumes:
|
||||
- << service_name >>_redis:/data
|
||||
|
||||
<< service_name >>_redis-cache:
|
||||
image: docker.io/library/redis:8.6.2-alpine
|
||||
restart: << restart_policy >>
|
||||
command: ["redis-server", "--requirepass", "${REDIS_PASSWORD}"]
|
||||
environment:
|
||||
- REDIS_PASSWORD=${REDIS_PASSWORD}
|
||||
networks:
|
||||
<< service_name >>_backend:
|
||||
volumes:
|
||||
- << service_name >>_redis-cache:/data
|
||||
|
||||
<%- if not database_external %>
|
||||
<< service_name >>_postgres:
|
||||
image: docker.io/library/postgres:17.9
|
||||
restart: << restart_policy >>
|
||||
environment:
|
||||
<%- if container_timezone %>
|
||||
- TZ=<< container_timezone >>
|
||||
<%- endif %>
|
||||
- POSTGRES_USER=${DATABASE_USER}
|
||||
- POSTGRES_PASSWORD=${DATABASE_PASSWORD}
|
||||
- POSTGRES_DB=<< database_name >>
|
||||
healthcheck:
|
||||
test: ["CMD-SHELL", "pg_isready -U << database_user >>"]
|
||||
start_period: 30s
|
||||
interval: 10s
|
||||
timeout: 10s
|
||||
retries: 5
|
||||
networks:
|
||||
- << service_name >>_backend
|
||||
volumes:
|
||||
- << service_name >>_postgres:/var/lib/postgresql/data
|
||||
<%- endif %>
|
||||
|
||||
networks:
|
||||
<< service_name >>_backend:
|
||||
driver: bridge
|
||||
<%- if traefik_enabled %>
|
||||
<< traefik_network >>:
|
||||
external: true
|
||||
<%- endif %>
|
||||
|
||||
volumes:
|
||||
<%- if not database_external %>
|
||||
<< service_name >>_postgres:
|
||||
driver: local
|
||||
<%- endif %>
|
||||
<< service_name >>_redis:
|
||||
driver: local
|
||||
<< service_name >>_redis-cache:
|
||||
driver: local
|
||||
<< service_name >>_media:
|
||||
driver: local
|
||||
<< service_name >>_reports:
|
||||
driver: local
|
||||
<< service_name >>_scripts:
|
||||
driver: local
|
||||
@@ -0,0 +1,324 @@
|
||||
{
|
||||
"slug": "netbox-compose",
|
||||
"kind": "compose",
|
||||
"metadata": {
|
||||
"name": "NetBox",
|
||||
"description": "Network infrastructure management (IPAM/DCIM) and automation source of truth. Manages IP addresses, circuits, devices, racks, cables, and other network infrastructure components.",
|
||||
"tags": [
|
||||
"traefik",
|
||||
"database",
|
||||
"email"
|
||||
],
|
||||
"icon": {
|
||||
"provider": "selfhst",
|
||||
"id": "netbox"
|
||||
},
|
||||
"draft": false,
|
||||
"version": {
|
||||
"name": "v4.5.10",
|
||||
"source_dep_name": "docker.io/netboxcommunity/netbox",
|
||||
"source_dep_version": "v4.5.10"
|
||||
}
|
||||
},
|
||||
"variables": [
|
||||
{
|
||||
"title": "Database",
|
||||
"name": "database",
|
||||
"items": [
|
||||
{
|
||||
"name": "database_name",
|
||||
"type": "str",
|
||||
"title": "Database Name",
|
||||
"required": false,
|
||||
"default": "netbox",
|
||||
"config": {
|
||||
"placeholder": "netbox"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "database_user",
|
||||
"type": "str",
|
||||
"title": "Database User",
|
||||
"required": false,
|
||||
"default": "netbox",
|
||||
"config": {
|
||||
"placeholder": "netbox"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "database_host",
|
||||
"type": "str",
|
||||
"title": "Database Host",
|
||||
"required": true,
|
||||
"needs": [
|
||||
"database_external=true"
|
||||
],
|
||||
"config": {
|
||||
"placeholder": "postgres"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "database_password",
|
||||
"type": "secret",
|
||||
"title": "Database Password",
|
||||
"required": true,
|
||||
"config": {
|
||||
"autogenerated": {
|
||||
"length": 32
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "redis_password",
|
||||
"type": "secret",
|
||||
"title": "Redis Password",
|
||||
"required": true,
|
||||
"config": {
|
||||
"autogenerated": {
|
||||
"length": 32
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "database_external",
|
||||
"type": "bool",
|
||||
"title": "External Database",
|
||||
"required": false,
|
||||
"default": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"title": "Email",
|
||||
"toggle": "email_enabled",
|
||||
"name": "email",
|
||||
"items": [
|
||||
{
|
||||
"name": "email_host",
|
||||
"type": "str",
|
||||
"title": "SMTP server hostname",
|
||||
"required": true,
|
||||
"config": {
|
||||
"placeholder": "smtp.home.arpa"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "email_port",
|
||||
"type": "int",
|
||||
"title": "SMTP server port",
|
||||
"required": true,
|
||||
"default": 25,
|
||||
"config": {
|
||||
"placeholder": "25"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "email_username",
|
||||
"type": "str",
|
||||
"title": "SMTP username",
|
||||
"required": true,
|
||||
"config": {
|
||||
"placeholder": "user@example.com"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "email_password",
|
||||
"type": "secret",
|
||||
"title": "SMTP password",
|
||||
"required": true
|
||||
},
|
||||
{
|
||||
"name": "email_from",
|
||||
"type": "str",
|
||||
"title": "From email address",
|
||||
"required": true,
|
||||
"config": {
|
||||
"placeholder": "noreply@example.com"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "email_enabled",
|
||||
"type": "bool",
|
||||
"title": "Email",
|
||||
"required": false,
|
||||
"default": false
|
||||
},
|
||||
{
|
||||
"name": "email_encryption",
|
||||
"type": "str",
|
||||
"title": "Encryption",
|
||||
"required": false,
|
||||
"default": "tls",
|
||||
"config": {
|
||||
"placeholder": "tls"
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"title": "General",
|
||||
"name": "general",
|
||||
"items": [
|
||||
{
|
||||
"name": "service_name",
|
||||
"type": "str",
|
||||
"title": "Service Name",
|
||||
"required": false,
|
||||
"default": "netbox",
|
||||
"config": {
|
||||
"placeholder": "netbox"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "container_timezone",
|
||||
"type": "str",
|
||||
"title": "Container Timezone",
|
||||
"required": false,
|
||||
"config": {
|
||||
"placeholder": "Europe/Berlin"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "restart_policy",
|
||||
"type": "enum",
|
||||
"title": "Restart Policy",
|
||||
"required": true,
|
||||
"default": "unless-stopped",
|
||||
"config": {
|
||||
"options": [
|
||||
"unless-stopped",
|
||||
"always",
|
||||
"on-failure",
|
||||
"no"
|
||||
]
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"title": "NetBox Configuration",
|
||||
"name": "netbox",
|
||||
"items": [
|
||||
{
|
||||
"name": "netbox_metrics_enabled",
|
||||
"type": "bool",
|
||||
"title": "Metrics",
|
||||
"required": false,
|
||||
"default": false
|
||||
},
|
||||
{
|
||||
"name": "netbox_secret_key",
|
||||
"type": "secret",
|
||||
"title": "Secret Key",
|
||||
"required": true,
|
||||
"config": {
|
||||
"autogenerated": {
|
||||
"length": 50
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"title": "Ports",
|
||||
"name": "ports",
|
||||
"items": [
|
||||
{
|
||||
"name": "ports_http",
|
||||
"type": "str",
|
||||
"title": "HTTP Port",
|
||||
"required": false,
|
||||
"default": 8000,
|
||||
"config": {
|
||||
"placeholder": "8000"
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"title": "Traefik",
|
||||
"name": "traefik",
|
||||
"toggle": "traefik_enabled",
|
||||
"items": [
|
||||
{
|
||||
"name": "traefik_enabled",
|
||||
"type": "bool",
|
||||
"title": "Traefik",
|
||||
"required": false,
|
||||
"default": false
|
||||
},
|
||||
{
|
||||
"name": "traefik_host",
|
||||
"type": "str",
|
||||
"title": "Host",
|
||||
"required": true,
|
||||
"config": {
|
||||
"placeholder": "netbox"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "traefik_domain",
|
||||
"type": "str",
|
||||
"title": "Domain",
|
||||
"required": true,
|
||||
"config": {
|
||||
"placeholder": "home.arpa"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "traefik_entrypoint",
|
||||
"type": "str",
|
||||
"title": "Entrypoint",
|
||||
"required": true,
|
||||
"default": "web",
|
||||
"config": {
|
||||
"placeholder": "web"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "traefik_network",
|
||||
"type": "str",
|
||||
"title": "Network",
|
||||
"required": true,
|
||||
"default": "traefik",
|
||||
"config": {
|
||||
"placeholder": "traefik"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "traefik_tls_enabled",
|
||||
"type": "bool",
|
||||
"title": "TLS",
|
||||
"required": false,
|
||||
"default": false
|
||||
},
|
||||
{
|
||||
"name": "traefik_tls_entrypoint",
|
||||
"type": "str",
|
||||
"title": "TLS Entrypoint",
|
||||
"required": true,
|
||||
"default": "websecure",
|
||||
"config": {
|
||||
"placeholder": "websecure"
|
||||
},
|
||||
"needs": [
|
||||
"traefik_tls_enabled=true"
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "traefik_tls_certresolver",
|
||||
"type": "str",
|
||||
"title": "Cert Resolver",
|
||||
"required": true,
|
||||
"default": "cloudflare",
|
||||
"config": {
|
||||
"placeholder": "cloudflare"
|
||||
},
|
||||
"needs": [
|
||||
"traefik_tls_enabled=true"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
Reference in New Issue
Block a user