librenms Autodiscovering PHP/MySQL/SNMP based network monitoring

1.66,1 net-mgmt =4 1.63_2,1Version of this port present on the latest quarterly branch.

Maintainer: dvl@FreeBSD.org

Port Added: 2015-06-20 08:10:10

Last Update: 2020-08-12 18:36:53

SVN Revision: 544758

People watching this port, also watch: dovecot, rubygem-oxidized-web, rspamd-devel, nut, monit

License: GPLv3

Description:

LibreNMS is an autodiscovering PHP/MySQL/SNMP based network monitoring which includes support for a wide range of network hardware and operating systems including Cisco, Linux, FreeBSD, Juniper, Brocade, Foundry, HP and many more. LibreNMS has grown out of a lack of easy to configure network monitoring platforms. It is intended to provide a more navigable interface to the health and performance of your network. Its design goals include collecting as much historical data about devices as possible, being completely autodiscovered with little or no manual intervention, and having a very intuitive interface. WWW: http://www.librenms.org

SVNWeb : Homepage

pkg-plist: as obtained via: make generate-plist

Expand this list (3 items)

1. /usr/local/share/licenses/librenms-1.66,1/catalog.mk
2. /usr/local/share/licenses/librenms-1.66,1/LICENSE
3. /usr/local/share/licenses/librenms-1.66,1/GPLv3

Collapse this list.

Dependency lines:

• ${PYTHON_PKGNAMEPREFIX}>0:net-mgmt/librenms

To install the port: cd /usr/ports/net-mgmt/librenms/ && make install clean

To add the package: pkg install librenms

PKGNAME: librenms

Flavors: there is no flavor information for this port.

distinfo:

TIMESTAMP = 1596654257 SHA256 (librenms-vendor-1.66.tar.gz) = f08f081dc50a5fdc90dc3fd04195c58df51eb41aa47796f596858072874ba388 SIZE (librenms-vendor-1.66.tar.gz) = 27668445 SHA256 (librenms-librenms-1.66_GH0.tar.gz) = 1e05675d719f93527762fefca4d0a54756ab26d959ea03cab58aca3cb822b7c6 SIZE (librenms-librenms-1.66_GH0.tar.gz) = 45889619

Dependencies

NOTE: FreshPorts displays only information on required and default dependencies. Optional dependencies are not covered.

Build dependencies:

1. python3.7 : lang/python37

Runtime dependencies:

1. rrdtool : databases/rrdtool
2. dot : graphics/graphviz
3. IPv4.php : net/pear-Net_IPv4@php72
4. IPv6.php : net/pear-Net_IPv6@php72
5. snmpget : net-mgmt/net-snmp
6. bash : shells/bash
7. sudo : security/sudo
8. py37-python-dotenv>0 : www/py-python-dotenv@py37
9. py37-pymysql>0 : databases/py-pymysql@py37
10. fping : net/fping
11. ipmitool : sysutils/ipmitool
12. virsh : devel/libvirt
13. check_nagios : net-mgmt/nagios-plugins
14. nmap : security/nmap
15. wmic : net-mgmt/wmi-client
16. Magick-config : graphics/ImageMagick6-nox11
17. mtr : net/mtr-nox11
18. python3.7 : lang/python37
19. php.h : lang/php72
20. ctype.so : textproc/php72-ctype
21. curl.so : ftp/php72-curl
22. dom.so : textproc/php72-dom
23. fileinfo.so : sysutils/php72-fileinfo
24. filter.so : security/php72-filter
25. gd.so : graphics/php72-gd
26. hash.so : security/php72-hash
27. json.so : devel/php72-json
28. ldap.so : net/php72-ldap
29. mbstring.so : converters/php72-mbstring
30. mysqli.so : databases/php72-mysqli
31. openssl.so : security/php72-openssl
32. pdo.so : databases/php72-pdo
33. pdo_mysql.so : databases/php72-pdo_mysql
34. phar.so : archivers/php72-phar
35. posix.so : sysutils/php72-posix
36. session.so : www/php72-session
37. simplexml.so : textproc/php72-simplexml
38. snmp.so : net-mgmt/php72-snmp
39. sockets.so : net/php72-sockets
40. tokenizer.so : devel/php72-tokenizer
41. xml.so : textproc/php72-xml
42. xmlwriter.so : textproc/php72-xmlwriter
43. zip.so : archivers/php72-zip

Library dependencies:

1. libmysqlclient.so.20 : databases/mysql57-client

There are no ports dependent upon this port

Configuration Options

===> The following configuration options are available for librenms-1.66,1: DOCS=on: Build and/or install documentation EXAMPLES=on: Build and/or install examples FPING=on: Enable fping support ping monitoring IPMITOOL=on: Enable support for monitoring hardware IPMI LIBVIRT=on: Virtualization support via libvirt MYSQLD=off: Use local MySQL server NAGPLUGINS=on: Plugins from nagios-plugins.org NMAP=on: NMAP security scanning support WMIC=on: Enable support for WMI polling X11=off: X11 (graphics) support ===> Use 'make config' to modify these settings

USES:

shebangfix python mysql:client php

Master Sites:

1. https://codeload.github.com/librenms/librenms/tar.gz/1.66?dummy=/

• 2020-07-26

  Affects: users of net-mgmt/librenms

  Author: dvl@FreeBSD.org

  Reason: 
    The %%WWWDIR%%%/logs directory has been relocated to /var/log/librenms/
    via the APP_LOG directive in %%WWWDIR%%%/.env.example - this won't affect
    existing installs, but you are strongly encouraged to update your .env file
    settings and relocate your logs.
  
    Logs which were going to /var/log/messages and /var/log/librenms/ now only go
    to /var/log/librenms/
  
  

• 2020-07-20

  Affects: users of net-mgmt/librenms

  Author: dvl@FreeBSD.org

  Reason: 
    As mentioned previously in 20200503 polling via cronjob has been removed as of
    release 1.63 - see
    https://community.librenms.org/t/dropping-support-for-php-7-1-and-python-2/11851
  
    A database upgrade is required:
  
       cd /usr/local/www/librenms
       sudo ./lnms migrate
  
    You must  migrate to the Dispatch Service:
    https://docs.librenms.org/Extensions/Dispatcher-Service/
  
    You may need to add LIBRENMS_USER to .env (see .env.example).
  
    These steps should get you running:
    * comment out the crontab entries listed above under PYPOLLER
    * populate %%WWWDIR%%/.env with:
      * APP_KEY - see farther below for how to create
      * NODE_ID - see just below for how to create
      * DB_HOST
      * DB_DATABASE
      * DB_USERNAME
      * DB_PASSWORD
    * you can create a NODE_ID with: php -r 'echo uniqid() . "\n";'
    * sysrc librenms_enable="YES"
    * service librenms start
  
  

• 2020-05-03

  Affects: users of net-mgmt/librenms

  Author: dvl@FreeBSD.org

  Reason: 
    Polling via cronjob is deprecated as of release 1.63
    Please see https://community.librenms.org/t/dropping-support-for-php-7-1-and-python-2/11851
  
    Please migrate to the Dispatch Service:
    https://docs.librenms.org/Extensions/Dispatcher-Service/
  
    These steps should get you running:
    * comment out the crontab entries listed above under PYPOLLER
    * populate %%WWWDIR%%/.env with:
      * APP_KEY - see farther below for how to create
      * NODE_ID - see just below for how to create
      * DB_HOST
      * DB_DATABASE
      * DB_USERNAME
      * DB_PASSWORD
    * you can create a NODE_ID with: php -r 'echo uniqid() . "\n";'
    * sysrc librenms_enable="YES"
    * service librenms start
  
  

• 2020-03-03

  Affects: users of net-mgmt/librenms

  Author: dvl@FreeBSD.org

  Reason: 
    1. Apache / mod_php options removed
  
    The APACHEMOD option has been removed. LibreNMS can be used
    with other webservers, not just Apache. In order to simplify
    the port, the option was removed.
  
    Now you manually install the webserver of your preference.
  
    If upgrading from LibreNMS < 1.61, you can do this to
    prevent 'pkg autoremove' from uninstalling Apache / mod_php:
  
    $ sudo pkg set -A 0 apache24 mod_php74
    Mark apache24-2.4.41 as not automatically installed? [y/N]: y
    Mark mod_php74-7.4.3 as not automatically installed? [y/N]: y
  
    Adjust mod_php74 to suit the version of mod_php you have.
  
    2. include/defaults.inc.php is gone
  
    The file include/defaults.inc.php is no longer distributed by
    the upstream project. The FreeBSD port patched this file to
    correct the paths to common tools such as ping, snmpwalk, etc.
  
    These values previously adjusted by the port must now be specified
    in config.php. New installs will have this automatically, but existing
    installs must be updated manually. These are the entries you should
    add if upgrading from LibreNMS < 1.61:
  
    $config['snmpwalk']       = '/usr/local/bin/snmpwalk';
    $config['snmpget']        = '/usr/local/bin/snmpget';
    $config['snmpbulkwalk']   = '/usr/local/bin/snmpbulkwalk';
    $config['snmptranslate']  = '/usr/local/bin/snmptranslate';
  
    $config['ping']           = '/sbin/ping';
    $config['mtr']            = '/usr/local/bin/mtr';
    $config['nmap']           = '/usr/local/bin/nmap';
  
    $config['nagios_plugins'] = '/usr/local/libexec/nagios';
    $config['ipmitool']       = '/usr/local/bin/ipmitool';
    $config['virsh']          = '/usr/local/bin/virsh';
    $config['dot']            = '/usr/local/bin/dot';
    $config['sfdp']           = '/usr/local/bin/sfdp';
    $config['nfdump']         = '/usr/local/bin/nfdump';
  
  

• 2018-09-01

  Affects: net-mgmt/librenms

  Author: dvl@FreeBSD.org

  Reason: 
    As of version 1.42, to conform with man hier, logs and rrd files have
    relocated outside the WWW directory. When upgrading from < 1.42 to more
    recent versions, the following steps are required.
  
    You must update config.php and manually relocate the rrd and log files.
    Before upgrading, please stop librenms,  update the configuration, and
    relocate the files.
  
    If you find graphs are not updating, fping >= 4.0 requires an IPv6
    address. Adding an IPv6 address should fix graphing.
  
    Please add these entries to config.php:
  
    $config['installed_from_package'] = true;
    $config['log_dir'] = '/var/log/librenms';
    $config['rrd_dir'] = '/var/db/librenms/rrd';
  
    To relocate the files:
  
    mkdir /var/log/librenms /var/db/librenms
    chown www:ww: /var/log/librenms /var/db/librenms
    cd /usr/local/www/librenms
    mv rrd /var/db/librenms/
    mv logs/librenms.log /var/log/librenms/
    rmdir logs
  
    An application key is required. Please follow these steps to generate it:
  
    cd /usr/local/www/librenms
    cp -i .env.sample .env
  
    You might need to set your database details in that file.
    Then run:
  
    php artisan key:generate
  
    The output should look something like this:
  
    **************************************
    *     Application In Production!     *
    **************************************
  
     Do you really wish to run this command? (yes/no) [no]:
     > y
  
    Application key [base64:P62La9V........qw=] set successfully.
  
  

• 2017-01-15

  Affects: users of net-mgmt/librenms

  Author: dvl@FreeBSD.org

  Reason: 
    The following is recommended for /var/db/mysql/my.cnf
  
    NOTE: these are global settings.  Please read this first:
  
    http://dev.mysql.com/doc/refman/5.7/en/sql-mode.html
  
    [mysqld]
    innodb_file_per_table=1
    sql-mode=""
  
  

Update to 1.66

As of this release, the package now updates files which were previously
updated by the app.  In keeping with not having modified files within
WWWDIR, the following files are now supplied by the package and are
created at the same time the vendor tarball is manually created.

The files in question are located in

* bootstrap/cache
* html/js/lang

These files should now be static and not modified by the application,
which would create them if not found. These files will get updated
with each new release.

Add more comments into the config.php.default patches so it is clear to the
user which settings are FreeBSD-specfic.

Also, set $config['update'] = 0; because if you're installing from a package
you don't want the software trying to update itself via git, which it will
attempt from daily.sh, but will fail because git is [usually] not installed.

Fix double logging

HEADS UP: See UPDATING for changes affecting your upgrade.
          New installs not affected.

This patch adds a new rc_variable: librenms_daemonflags

The -T option is gone as that will force a log to syslog, doubling up on log
entries.

A new APP_LOG setting has been added to the .env file. Please update and
move your logs.  See UPDATING.

PR:		246598
Submitted by:	Dries Michiels <driesm.michiels@gmail.com>

Add lang/pyton3 recommendation to pkg-message

While here, patch pip3 warnings, which we don't use because we are a
package and we don't do things like that.

PR:		248255
Submitted by:	Alexander Moisseev <moiseev@mezonplus.ru>

Update to 1.65.1

This upgrade disables polling via cronjob.
You must now use the Dispatcher.  See UPDATING

fix log file creation in rc script

disable allowance of multiple instances (-m in rc.d script)

PR:		246160
Submitted by:	Dries Michiels <driesm.michiels@gmail.com>

Add support for polling as a service

Two new options

* PYPOLLER  - default, deprecated, needs Python 2.7
* PYSERVICE - Dispatcher service, recompile required

HEADS UP HEADS UP

Polling via cron job is now deprecated. Please use the Dispatcher.

LibreNMS will be dropping support for PHP 7.1 and Python 2 in the next release
expected May 31 2020.  see
https://community.librenms.org/t/dropping-support-for-php-7-1-and-python-2/11851

Your existing crontab entries for the PYPOLLER option will be going away.

You can migrate to the PYSERVICE option of LibreNMS now.

PR:		246105
Submitted by:	Dries Michiels <driesm.michiels@gmail.com>

Update to 1.63

re: https://github.com/librenms/librenms/releases/tag/1.63

Fixed broken hash for librenms-vendor-1.62.2.tar.gz

Reported by:	pkg-fallout

Update to 1.62.2

skipping 1.62 & 1.62.1

* https://github.com/librenms/librenms/releases/tag/1.62
* https://github.com/librenms/librenms/releases/tag/1.62.1
* https://github.com/librenms/librenms/releases/tag/1.62.2

With recent versions of LibreNMS, the .env file may need to contain secrets.

Install .env.example with chmod o=

Add notice to pkg-message. The file is populated manually.

Update to 1.61

While here, adjust the webserver options (see PR)

NOTE: upgrading existing installations will break unless you read UPGRADING
and follow the instructions.

In short:

* Apache / mod_php is no longer an option
* config.php needs entries added manually

We are jumping a few versions here:

* https://github.com/librenms/librenms/releases/tag/1.61
* https://github.com/librenms/librenms/releases/tag/1.60
* https://github.com/librenms/librenms/releases/tag/1.59
* https://github.com/librenms/librenms/releases/tag/1.58.1
* https://github.com/librenms/librenms/releases/tag/1.58

PR:		235949
Submitted by:	Dries Michiels <driesm.michiels@gmail.com>

add dependencies to fix after update of libremns to 1.56

PR:		243875
Submitted by:	Dirk Meyer <dinoex@FreeBSD.org>

Fix default location of ping and nagios plugins

PR:		242651
Submitted by:	Dries Michiels <driesm.michiels@gmail.com>

Update to 1.56

https://github.com/librenms/librenms/releases/tag/1.56

Update to 1.55

re: https://github.com/librenms/librenms/releases/tag/1.55

Upgrade to 1.54

* MPLS Services (#10421) - vitalisator
* Graylog entry matching device if source is not hostname or primary ip (#10458)
- rsys-dev
* Allow filtering of getUserlist LDAP function (#10399) - ifred16

re: https://github.com/librenms/librenms/releases/tag/1.54

Convert to UCL & cleanup pkg-message (categories n)

(and missed 3 missed files from previous categories.)

Upgrade to 1.53.1

release notes:

1.53.1 - https://github.com/librenms/librenms/releases/tag/1.53.1
1.53   - https://github.com/librenms/librenms/releases/tag/1.53
1.52   - https://github.com/librenms/librenms/releases/tag/1.52

Upgrade to 1.51

https://github.com/librenms/librenms/releases/tag/1.51

Upgrade to 1.50

https://github.com/librenms/librenms/releases

Upgrade to 1.49

https://github.com/librenms/librenms/releases/tag/1.49

As with every LibreNMS upgrade, visit /validate/ to see if you need
run any scripts post-upgrade.

Upgrade to 1.48.1
Take over as maintainer
in pkg-message:
* Correct the .env.example
* Add ./validate

1.48 was skipped because of time issue

Release notes:
1.48.1  Fix for some OS loading issues.
        https://github.com/librenms/librenms/releases/tag/1.48.1
1.48    https://github.com/librenms/librenms/releases/tag/1.48

PR:		235537
Submitted by:	Laszlo Danielisz <lacibsd@gmail.com>
Approved by:	bofh@FreeBSD.org (maintainer)

net-mgmt/librenms: Update version 1.45=>1.47

PR:		234645
Submitted by:	dvl
Relnotes:	https://github.com/librenms/librenms/releases

net-mgmtt/librenms: Fix build with EXAMPLES disabled

- Pet portlint

PR:			233202
Submitted by:		pizzamig

Update ImageMagick to 6.9.10.14 [1]

* Add PKGNAMESUFFIX and rename the directory. This was done to show
  that IM6 is not the "main" version. But still fully supported by upstream.
* Convert a number of options to optionhelpers.
* Add option for ISO/IEC 23008-12:2017 HEIF suport
* Add comment to pkg-descr explaining IM6's "legacy" tag.
* Add comment to the patch-config_policy.xml file why it still needed.

Please note that IM7 is not a drop in replacement due to library API and
command arguments changes. And as a result ports need to decide for themself
which version to use.

Chase these changes in all the ports that using IM6.

PR:		225102 (based on, only the version update) [1]
Submitted by:	Pascal Christen <pascal.christen@hostpoint.ch>

Upgrade to 1.45

https://github.com/librenms/librenms/releases/tag/1.45

* remove mcrypt from depends (no longer used)
* add pdo_mysql (long required but not included)
* remove lib from ROOT_DIRS
* mention sql-mode="" is no longer required
* Make ./validate.php work from a package

PR:		232658
Approved by:	maintainer timeout (14 days)

Correct paths for nmap and mtr in patch for includes/defaults.inc.php
Correct user in patch for .env.example

PR:		231089
Submitted by:	Dries Michiels <driesm.michiels@gmail.com>

Upgrade to 1.43

While here, fix a bug in the files/patch-includes_common.php where the
variables for PORTVERSION & RELEASE_TIMESTAMP were not present.

Approved by:	maintainer (via private email)

Upgrade to 1.42.01

Approved by:	maintainer (via private email)
Differential Revision:	https://reviews.freebsd.org/D16942

Add PY_FLAVOR to Python module dependencies.

Sponsored by:	Absolight

Introduce PHP flavors.

  Ports using USES=php:phpize, php:ext, php:zend, and php:pecl are now
  flavored.  They will automatically get flavors (php56, php70, php71, php72)
  depending of the versions they support (set with IGNORE_WITH_PHP).  As a
  consequence, ports using USES=pear and USES=horde are also flavored.

PR:		226242
Submitted by:	mat
Exp-run by:	antoine
Approved by:	portmgr
Sponsored by:	Absolight
Differential Revision:	https://reviews.freebsd.org/D14208

net-mgmt/librenms: Upstream re-rolled the distfile

Only change is the doc/General/Changelog.md file which *removed* the entry
for 1.35.

net-mgmt/librenms: Fix build

Leftover change crept into last commit

MFH:		2018Q1

net-mgmt/librenms: Update to 1.35, many improvements

Improvements:

-    All files should be owned root:wheel except logs and rrd which need to be
writable by the app
-    Add missing php posix extension
-    Do not install config.php by default. This breaks the install process which
won't run if this file exists
-    Clean up automatic PLIST creation: don't install .orig or .bak files, don't
add @dir as they aren't needed
-    Patch LibreNMS to make /validate/ page not produce warnings about files not
being writable (for git updates)
-    Remove the Updates validation check altogether as we won't be using git to
update
-    Patch the User validation check to only check the logs and rrd dir and
ensure the correct user owns them
-    Change the default user in the generated config to "www"
-    Patch the File Lock code to put the lock file in /tmp and not in the WWWDIR
which should not be writable
-    Update message in installer to use WWWDIR as suggested path for config.php
-    Use shebangfix instead of patch where applicable
-    Fix APACHEMOD port option and declaration of the USES=php

PR:		225161
MFH:		2018Q1
Differential Revision:	https://reviews.freebsd.org/D13907

databases/py-MySQLdb only supports Python 2, restrict ports that uses it.

Sponsored by:	Absolight

Set path to rrdtool

Upgrade to 1.33.01

Fix the context of some patches so that they apply with stricter patch(1)

PR:		223545
With hat:	portmgr

net-mgmt/librenms: Update version 1.26=>1.28

- Fixed an issue where services-wrapper wasn't working (by adding the PATH
  line to the crontab) [1]
- Fixed a permissions issue with some directories [1]
- Added patch to validate.php which allows it to work correctly
  (accidentally ommitted from previous commit) [1]

PR:		218608[1]
Submitted by:	freebsd@jonathanprice.org[1]

net-mgmt/librenms: Update version 1.25=>1.26

- Fix validate.php
- Created logs dir, used by daily.php
- fixed daily.sh to use sudo (replaces GNU su command)
- made daily.sh executable
- Disabled update checks in daily.sh, as they try to use git
- Updated the username in config.php to www

PR:		218351
Submitted by:	freebsd@jonathanprice.org

net-mgmt/librenms: Update version 1.24=>1.25

Do not override USES when PACKAGE_BUILDING is set, this should fix the
failure reported by package builders

net-mgmt/librenms: Update version 1.23=>1.24

- Add PHP 7.0 support [1]
- Pet portlint

PR:		213376[1]
Submitted by:	fredrik.eriksson@loopia.se[1]

Add more detail about my.cnf changes

Submitted by: Christoph Moench-Tegeder <cmt@burggraben.net>

Add patches missing from previous commit.
Add note to pkg-message about my.cnf
Add not to UPGRADING about my.cnf
Bump PORTREVISION

Submitted by: Larry Rosenman <ler@FreeBSD.org>

Upgrade to 1.23,1

Be sure to set the following in my.cnf:

[mysqld]
innodb_file_per_table=1
sql-mode=""

net-mgmt/librenms: Update version 201605=>201607

net-mgmt/librenms: Update version 201604=>201605

Remove NLS, DOCS, EXAMPLES and IPV6 from OPTIONS_DEFAULT, they are enabled by
default anyway and don't need to be listed

Approved by:	portmgr blanket

- Fix trailing whitespace in pkg-descrs, categories [g-n]*

Approved by:	portmgr blanket

Update databases/rrdtool to 1.6.0

Most notably, this version of rrdtools.so is thread safe, so the
rrdtools_th.so library is removed.

Bump portrevision for depending ports due to shlib version bump.

For full changelog: http://oss.oetiker.ch/rrdtool/pub/CHANGES

Reviewed by:	kwm
Differential Revision:	D6168

Remove ${PORTSDIR}/ from *_DEPENDS lines.

Sponsored by:	Absolight

net-mgmt/librenms: Update version 201601=>201604

- Fix circular dependency of x11 and nox11 [1]

PR:		208356 [1]
Submitted by:	daniel@blodan.se [1]

Remove ${PORTSDIR}/ from dependencies, categories m, n, o, and p.

With hat:	portmgr
Sponsored by:	Absolight

Fixup some whitespace at the beginning of lines problems.

With hat:	portmgr
Sponsored by:	Absolight

Upgrade to 201601
PR:             206298
Approved by:    maintainer(bofh)

net-mgmt/librenms: Update version 201509=>201510

net-mgmt/librenms: Update version 201506=>201509 [1]

- Correct the path of fping [1]
- Make proper use of OPTIONSNG

PR:		202938 [1]
Submitted by:	dvl [1]
Differential Revision:	https://reviews.freebsd.org/D3578 [1]

[NEW] net-mgmt/librenms: Autodiscovering PHP/MySQL/SNMP based network monitoring

LibreNMS is an autodiscovering PHP/MySQL/SNMP based network monitoring which
includes support for a wide range of network hardware and operating systems
including Cisco, Linux, FreeBSD, Juniper, Brocade, Foundry, HP and many more.

LibreNMS has grown out of a lack of easy to configure network monitoring
platforms. It is intended to provide a more navigable interface to the health
and performance of your network. Its design goals include collecting as much
historical data about devices as possible, being completely autodiscovered with
little or no manual intervention, and having a very intuitive interface.

WWW: http://www.librenms.org

14 vulnerabilities affecting 115 ports have been reported in the past 14 days

^* - modified, not new

All vulnerabilities

Last updated:
2020-08-13 11:49:23