diff --git a/CONTRIBUTORS b/CONTRIBUTORS new file mode 100644 index 0000000..466cb8d --- /dev/null +++ b/CONTRIBUTORS @@ -0,0 +1 @@ +Jonathan Senecal \ No newline at end of file diff --git a/README.md b/README.md index 0f194fe..770174b 100644 --- a/README.md +++ b/README.md @@ -44,14 +44,30 @@ If you are interested, [check out](https://hub.docker.com/r/crazymax/) my other * `UPLOAD_MAX_SIZE` : Upload max size (default `16M`) * `OPCACHE_MEM_SIZE` : PHP OpCache memory consumption (default `128`) * `LIBRENMS_POLLER_THREADS` : Threads that `poller-wrapper.py` runs (default `16`) -* `LIBRENMS_SNMP_COMMUNITY` : Your community string (default `librenmsdocker`) +* `LIBRENMS_POLLER_INTERVAL` : Interval in minutes at which `poller-wrapper.py` runs (defaults to `5`) [docs](https://docs.librenms.org/#Support/1-Minute-Polling/) +* `LIBRENMS_DISTRIBUTED_POLLER_ENABLE` : Enable distributed poller functionality +* `LIBRENMS_DISTRIBUTED_POLLER_NAME` : Optional name of poller (defaults to hostname) +* `LIBRENMS_DISTRIBUTED_POLLER_GROUP` : By default, all hosts are shared and have the poller_group = 0. To pin a device to a poller, set it to a value greater than 0 and set the same value here. One can also specify a comma separated string of poller groups. The poller will then poll devices from any of the groups listed. [docs](https://docs.librenms.org/#Extensions/Distributed-Poller/#distributed-poller) +* `LIBRENMS_DISTRIBUTED_POLLER_MEMCACHED_HOST` : Memcached server for poller synchronization (Defaults to `$MEMCACHED_HOST`) +* `LIBRENMS_DISTRIBUTED_POLLER_MEMCACHED_PORT` : Port of memcached server (Defaults to `$MEMCACHED_PORT`) +* `LIBRENMS_CRON_DISCOVERY_ENABLE` : Enable LibreNMS discovery for this container cronjobs (default `true`) +* `LIBRENMS_CRON_DAILY_ENABLE` : Enable LibreNMS daily script for this container cronjobs (default `true`) +* `LIBRENMS_CRON_ALERTS_ENABLE` : Enable LibreNMS alerts generation for this container cronjobs (default `true`) +* `LIBRENMS_CRON_BILLING_ENABLE` : Enable LibreNMS billing polling for this container cronjobs (default `true`) +* `LIBRENMS_CRON_BILLING_CALCULATE_ENABLE` : Enable LibreNMS billing for this container cronjobs (default `true`) +* `LIBRENMS_CRON_CHECK_SERVICES_ENABLE` : Enable LibreNMS service checks for this container cronjobs (default `true`) +* `LIBRENMS_CRON_POLLER_ENABLE` : Enable LibreNMS polling for this container cronjobs (default `true`) +* `LIBRENMS_SNMP_COMMUNITY` : This container's SNMP v2c community string (default `librenmsdocker`) * `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 (userful for clusters, default `30`) * `MEMCACHED_HOST` : Hostname / IP address of a Memcached server +* `MEMCACHED_PORT` : Port of the Memcached server * `RRDCACHED_HOST` : Hostname / IP address of a RRDcached server +* `RRDCACHED_PORT` : Port of the RRDcached server ### Volumes