ChristianLempa_Boilerplates/library/compose/netbox/compose.yaml.j2

services:
  {{ service_name }}:
    image: docker.io/netboxcommunity/netbox:v4.2.3
    restart: {{ restart_policy }}
    {% if container_name %}
    container_name: {{ container_name }}
    {% endif %}
    {% if container_hostname %}
    hostname: {{ container_hostname }}
    {% endif %}
    depends_on:
      {% if not database_external %}
      - {{ service_name }}-postgres
      {% endif %}
      - {{ service_name }}-redis
      - {{ service_name }}-redis-cache
    environment:
      {% if container_timezone %}
      - TZ={{ 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_server }}
      - EMAIL_PORT={{ email_port }}
      - EMAIL_FROM={{ email_from }}
      - EMAIL_USERNAME={{ email_username }}
      - EMAIL_PASSWORD=${EMAIL_PASSWORD}
      - EMAIL_USE_SSL={{ email_use_ssl }}
      - EMAIL_USE_TLS={{ email_use_tls }}
      {% endif %}
    networks:
      {% if traefik_enabled %}
      - {{ traefik_network }}
      {% endif %}
      - {{ service_name }}_backend
    {% if not traefik_enabled %}
    ports:
      - "{{ ports_http }}:8080"
    {% endif %}
    volumes:
      {% if volume_mode == 'mount' %}
      - {{ volume_mount_path }}/media:/opt/netbox/netbox/media
      - {{ volume_mount_path }}/reports:/opt/netbox/netbox/reports
      - {{ volume_mount_path }}/scripts:/opt/netbox/netbox/scripts
      {% elif volume_mode in ['local', 'nfs'] %}
      - {{ service_name }}-media:/opt/netbox/netbox/media
      - {{ service_name }}-reports:/opt/netbox/netbox/reports
      - {{ service_name }}-scripts:/opt/netbox/netbox/scripts
      {% endif %}
    {% if traefik_enabled %}
    labels:
      - traefik.enable=true
      - traefik.docker.network={{ traefik_network }}
      - traefik.http.services.{{ service_name }}-web.name={{ service_name }}-web
      - 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 %}
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:8080/api/"]
      interval: 10s
      timeout: 5s
      retries: 5

  {{ service_name }}-worker:
    image: docker.io/netboxcommunity/netbox:v4.2.3
    restart: {{ restart_policy }}
    {% if container_name %}
    container_name: {{ container_name }}-worker
    {% endif %}
    {% if container_hostname %}
    hostname: {{ container_hostname }}-worker
    {% endif %}
    command:
      - /opt/netbox/venv/bin/python
      - /opt/netbox/netbox/manage.py
      - rqworker
    depends_on:
      - {{ service_name }}
      - {{ service_name }}-postgres
      - {{ service_name }}-redis
    environment:
      - TZ={{ container_timezone }}
      {% 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 email_enabled %}
      - EMAIL_SERVER={{ email_server }}
      - EMAIL_PORT={{ email_port }}
      - EMAIL_FROM={{ email_from }}
      - EMAIL_USERNAME={{ email_username }}
      - EMAIL_PASSWORD=${EMAIL_PASSWORD}
      - EMAIL_USE_SSL={{ email_use_ssl }}
      - EMAIL_USE_TLS={{ email_use_tls }}
      {% endif %}
    networks:
      - {{ service_name }}_backend
    volumes:
      {% if volume_mode == 'mount' %}
      - {{ volume_mount_path }}/media:/opt/netbox/netbox/media
      - {{ volume_mount_path }}/reports:/opt/netbox/netbox/reports
      - {{ volume_mount_path }}/scripts:/opt/netbox/netbox/scripts
      {% elif volume_mode in ['local', 'nfs'] %}
      - {{ service_name }}-media:/opt/netbox/netbox/media
      - {{ service_name }}-reports:/opt/netbox/netbox/reports
      - {{ service_name }}-scripts:/opt/netbox/netbox/scripts
      {% endif %}

  {{ service_name }}-redis:
    image: docker.io/library/redis:8.4.0-alpine
    restart: {{ restart_policy }}
    {% if container_name %}
    container_name: {{ container_name }}-redis
    {% endif %}
    {% if container_hostname %}
    hostname: {{ container_hostname }}-redis
    {% endif %}
    command:
      - sh
      - -c
      - redis-server --appendonly yes --requirepass $$REDIS_PASSWORD
    environment:
      - REDIS_PASSWORD=${REDIS_PASSWORD}
    networks:
      - {{ service_name }}_backend
    volumes:
      {% if volume_mode == 'mount' %}
      - {{ volume_mount_path }}/redis:/data
      {% elif volume_mode in ['local', 'nfs'] %}
      - {{ service_name }}-redis:/data
      {% endif %}

  {{ service_name }}-redis-cache:
    image: docker.io/library/redis:8.4.0-alpine
    restart: {{ restart_policy }}
    {% if container_name %}
    container_name: {{ container_name }}-redis-cache
    {% endif %}
    {% if container_hostname %}
    hostname: {{ container_hostname }}-redis-cache
    {% endif %}
    command:
      - sh
      - -c
      - redis-server --requirepass $$REDIS_PASSWORD
    environment:
      - REDIS_PASSWORD=${REDIS_PASSWORD}
    networks:
      - {{ service_name }}_backend
    volumes:
      {% if volume_mode == 'mount' %}
      - {{ volume_mount_path }}/redis-cache:/data
      {% elif volume_mode in ['local', 'nfs'] %}
      - {{ service_name }}-redis-cache:/data
      {% endif %}

  {% if not database_external %}
  {{ service_name }}-postgres:
    image: docker.io/library/postgres:17.2-alpine
    restart: {{ restart_policy }}
    {% if container_name %}
    container_name: {{ container_name }}-postgres
    {% endif %}
    {% if container_hostname %}
    hostname: {{ container_hostname }}-postgres
    {% endif %}
    environment:
      - TZ={{ container_timezone }}
      - POSTGRES_USER={{ database_user }}
      - POSTGRES_PASSWORD=${DATABASE_PASSWORD}
      - POSTGRES_DB={{ database_name }}
    networks:
      - {{ service_name }}_backend
    volumes:
      {% if volume_mode == 'mount' %}
      - {{ volume_mount_path }}/postgres:/var/lib/postgresql/data
      {% elif volume_mode in ['local', 'nfs'] %}
      - {{ service_name }}-postgres:/var/lib/postgresql/data
      {% endif %}
  {% endif %}

{% if volume_mode == 'local' %}
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
{% elif volume_mode == 'nfs' %}
volumes:
  {% if not database_external %}
  {{ service_name }}-postgres:
    driver: local
    driver_opts:
      type: nfs
      o: addr={{ volume_nfs_server }},{{ volume_nfs_options }}
      device: ":{{ volume_nfs_path }}/postgres"
  {% endif %}
  {{ service_name }}-redis:
    driver: local
    driver_opts:
      type: nfs
      o: addr={{ volume_nfs_server }},{{ volume_nfs_options }}
      device: ":{{ volume_nfs_path }}/redis"
  {{ service_name }}-redis-cache:
    driver: local
    driver_opts:
      type: nfs
      o: addr={{ volume_nfs_server }},{{ volume_nfs_options }}
      device: ":{{ volume_nfs_path }}/redis-cache"
  {{ service_name }}-media:
    driver: local
    driver_opts:
      type: nfs
      o: addr={{ volume_nfs_server }},{{ volume_nfs_options }}
      device: ":{{ volume_nfs_path }}/media"
  {{ service_name }}-reports:
    driver: local
    driver_opts:
      type: nfs
      o: addr={{ volume_nfs_server }},{{ volume_nfs_options }}
      device: ":{{ volume_nfs_path }}/reports"
  {{ service_name }}-scripts:
    driver: local
    driver_opts:
      type: nfs
      o: addr={{ volume_nfs_server }},{{ volume_nfs_options }}
      device: ":{{ volume_nfs_path }}/scripts"
{% endif %}

networks:
  {{ service_name }}_backend:
    driver: bridge
  {% if traefik_enabled %}
  {{ traefik_network }}:
    external: true
  {% endif %}