NetMap/docker-compose.example.yml at main · xoriin/NetMap · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
# ─────────────────────────────────────────────────────────────────────────────
# NetMap — Docker Hub image compose example
#
# Quick start:
#   1. Edit the environment values below.
#   2. docker compose -f docker-compose.example.yml up -d
# ─────────────────────────────────────────────────────────────────────────────

services:
  netmap:
    image: xoriin/netmap:latest
    container_name: netmap
    environment:
      APP_ENV: production
      DATABASE_URL: sqlite:////app/data/netmap.db
      DATA_DIR: /app/data

      # Match the container's internal user to your host user so bind mounts
      # are writable. Run `id` on the host to find your UID and GID.
      PUID: 1000
      PGID: 1000

      # Container timezone — affects log timestamps and scheduled tasks.
      # Use a tz database name, e.g. Europe/London, America/New_York.
      # TZ: UTC

      # Required: replace these before first start.
      SECRET_KEY: replace-with-a-long-random-secret
      MASTER_KEY: replace-with-a-fernet-key

      # Public URL used to build password-reset links in emails.
      # Set this if you use a reverse proxy or a non-default port.
      # APP_URL: http://netmap.example.com:8080

      # Simplest default for self-hosted installs where the URL may be localhost,
      # a LAN IP, or a reverse proxy hostname. For public deployments, replace
      # this with exact hostnames such as ["netmap.example.com"].
      TRUSTED_HOSTS: '["*"]'

      # Set true only when served behind a TLS-terminating reverse proxy.
      SECURE_HSTS_ENABLED: "false"
      AUTH_COOKIE_SECURE: "false"
      TRUSTED_PROXY_IPS: '["127.0.0.1"]'

      LOG_LEVEL: info
      EVENT_RETENTION_DAYS: "7"
      FIREWALL_LOG_RETENTION_DAYS: "7"

      SYSLOG_ENABLED: "true"
      SYSLOG_UDP_ENABLED: "true"
      SYSLOG_TCP_ENABLED: "true"
      SYSLOG_HOST: 0.0.0.0
      SYSLOG_UDP_PORT: "1514"
      SYSLOG_TCP_PORT: "1514"
      # SYSLOG_SENDER_ALLOWLIST: '["192.168.1.1","10.0.0.0/8"]'
      ACTIVE_NETWORK_PUBLIC_TARGETS_ENABLED: "false"
    volumes:
      - /mnt/change/this/netmap:/app/data
    ports:
      - "8080:8080"      # Web UI + API
      - "5514:1514/udp"  # Syslog UDP
      - "5514:1514/tcp"  # Syslog TCP
    read_only: true
    tmpfs:
      - /tmp
    cap_drop:
      - ALL
    cap_add:
      - NET_RAW
    restart: unless-stopped