Mirrors/librenms-docker
1
0
Fork 0
mirror of https://github.com/librenms/docker.git synced 2026-01-23 02:14:48 +00:00
Code Issues Projects Releases Wiki Activity
librenms-docker/doc/docker/environment-variables.md

2.6 KiB
Raw Blame History

Environment variables

General

  • TZ: The timezone assigned to the container (default UTC)
  • PUID: LibreNMS user id (default 1000)
  • PGID: LibreNMS group id (default 1000)
  • MEMORY_LIMIT: PHP memory limit (default 256M)
  • UPLOAD_MAX_SIZE: Upload max size (default 16M)
  • OPCACHE_MEM_SIZE: PHP OpCache memory consumption (default 128)
  • LISTEN_IPV6: Enable IPv6 for Nginx (default true)
  • REAL_IP_FROM: Trusted addresses that are known to send correct replacement addresses (default 0.0.0.0/32)
  • REAL_IP_HEADER: Request header field whose value will be used to replace the client address (default X-Forwarded-For)
  • LOG_IP_VAR: Use another variable to retrieve the remote IP address for access log_format on Nginx. (default remote_addr)

Dispatcher service

⚠️ Only used if you enable and run a sidecar dispatcher container

  • SIDECAR_DISPATCHER: Set to 1 to enable sidecar dispatcher mode for this container (default 0)
  • DISPATCHER_NODE_ID: Unique node ID for your dispatcher service
  • DISPATCHER_ARGS: Additional args to pass to the dispatcher service
  • REDIS_HOST: Redis host for poller synchronization
  • REDIS_PORT: Redis port (default 6379)
  • REDIS_PASSWORD: Redis password
  • REDIS_DB: Redis database (default 0)

Syslog-ng

⚠️ Only used if you enable and run a sidecar syslog-ng container

  • SIDECAR_SYSLOGNG: Set to 1 to enable sidecar syslog-ng mode for this container (default 0)

Database

  • DB_HOST: MySQL database hostname / IP address
  • DB_PORT: MySQL database port (default 3306)
  • DB_NAME: MySQL database name (default librenms)
  • DB_USER: MySQL user (default librenms)
  • DB_PASSWORD: MySQL password (default librenms)
  • DB_TIMEOUT: Time in seconds after which we stop trying to reach the MySQL server (useful for clusters, default 60)

Misc

  • LIBRENMS_BASE_URL: URL of your LibreNMS instance (default /)
  • LIBRENMS_SNMP_COMMUNITY: This container's SNMP v2c community string (default librenmsdocker)
  • LIBRENMS_WEATHERMAP: Enable LibreNMS Weathermap plugin (default false)
  • LIBRENMS_WEATHERMAP_SCHEDULE: CRON expression format (default */5 * * * *)
  • MEMCACHED_HOST: Hostname / IP address of a Memcached server
  • MEMCACHED_PORT: Port of the Memcached server (default 11211)
  • RRDCACHED_SERVER: RRDcached server (default rrdcached:42217)