Port details |
- librenms Autodiscovering PHP/MySQL/SNMP based network monitoring
- 24.11.0,1 net-mgmt =8 24.8.1,1Version of this port present on the latest quarterly branch.
- Maintainer: dvl@FreeBSD.org
- Port Added: 2015-06-20 08:10:10
- Last Update: 2024-11-21 00:39:07
- Commit Hash: 35b83a6
- People watching this port, also watch:: elasticsearch7, free-sa-devel, monit, nut, rubygem-oxidized-script
- License: GPLv3
- WWW:
- https://www.librenms.org
- 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.
- ¦ ¦ ¦ ¦
- Manual pages:
- FreshPorts has no man page information for this port.
- pkg-plist: as obtained via:
make generate-plist - Dependency lines:
-
- librenms>0:net-mgmt/librenms
- To install the port:
- cd /usr/ports/net-mgmt/librenms/ && make install clean
- To add the package, run one of these commands:
- pkg install net-mgmt/librenms
- pkg install librenms
NOTE: If this package has multiple flavors (see below), then use one of them instead of the name specified above.- PKGNAME: librenms
- Flavors: there is no flavor information for this port.
- distinfo:
- TIMESTAMP = 1732119849
SHA256 (librenms-vendor-24.11.0.tar.gz) = 1014e59cd1a70a908307d72bd4ed54a6cb9a59bd37195199bd67e76290ec7fa6
SIZE (librenms-vendor-24.11.0.tar.gz) = 28809754
Packages (timestamps in pop-ups are UTC):
- Dependencies
- NOTE: FreshPorts displays only information on required and default dependencies. Optional dependencies are not covered.
- Build dependencies:
-
- python3.11 : lang/python311
- Test dependencies:
-
- python3.11 : lang/python311
- Runtime dependencies:
-
- py311-psutil>0 : sysutils/py-psutil@py311
- py311-pymysql>0 : databases/py-pymysql@py311
- py311-python-dotenv>0 : www/py-python-dotenv@py311
- bash : shells/bash
- dot : graphics/graphviz
- rrdtool : databases/rrdtool
- snmpget : net-mgmt/net-snmp
- sudo : security/sudo
- fping : net/fping
- ipmitool : sysutils/ipmitool
- virsh : devel/libvirt
- check_nagios : net-mgmt/nagios-plugins
- nmap : security/nmap
- wmic : net-mgmt/wmi-client
- mtr : net/mtr@nox11
- php.h : lang/php82
- python3.11 : lang/python311
- ctype.so : textproc/php82-ctype
- curl.so : ftp/php82-curl
- dom.so : textproc/php82-dom
- fileinfo.so : sysutils/php82-fileinfo
- filter.so : security/php82-filter
- gd.so : graphics/php82-gd
- iconv.so : converters/php82-iconv
- ldap.so : net/php82-ldap
- mbstring.so : converters/php82-mbstring
- mysqli.so : databases/php82-mysqli
- pdo.so : databases/php82-pdo
- pdo_mysql.so : databases/php82-pdo_mysql
- phar.so : archivers/php82-phar
- posix.so : sysutils/php82-posix
- session.so : www/php82-session
- simplexml.so : textproc/php82-simplexml
- snmp.so : net-mgmt/php82-snmp
- sockets.so : net/php82-sockets
- tokenizer.so : devel/php82-tokenizer
- xml.so : textproc/php82-xml
- xmlwriter.so : textproc/php82-xmlwriter
- zip.so : archivers/php82-zip
- zlib.so : archivers/php82-zlib
- Library dependencies:
-
- libmysqlclient.so.21 : databases/mysql80-client
- libMagick++-6.so : graphics/ImageMagick6@nox11
- There are no ports dependent upon this port
Configuration Options:
- ===> The following configuration options are available for librenms-24.11.0,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
- Options name:
- net-mgmt_librenms
- USES:
- cpe php python shebangfix mysql:client magick:6,nox11
- pkg-message:
- For install:
-
You can mostly follow the guide at:
http://docs.librenms.org/
with the following notes:
- Installation directory is /usr/local/www/librenms
NOTE: setting sql-mode="" is no longer required. You can remove it from
/usr/local/etc/mysql/my.cnf
LibreNMS requires specific entries in my.cnf for MySQL. In MySQL 8, once the
service is started for the first time, the lower_case_table_names value can not
be changed. It is recommended that you my.cnf before starting MySQL for the
first time or pass specific values on the command-line when starting MySQL.
NOTE that the lower_case_table_names entry needs to be set before you start
MySQL for the first time.
innodb_file_per_table=1
lower_case_table_names=0
By default MySQL 8 uses a different authentication plugin to auth database users.
If you see errors in the logs like this:
"The server requested authentication method unknown to the client..."
Add this to my.cnf:
[mysqld]
default-authentication-plugin=mysql_native_password
The following MySQL configuration is required. Adjust 'localhost' as
required if MySQL is on a different host.
CREATE DATABASE librenms CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
CREATE USER 'librenms'@'localhost' IDENTIFIED with mysql_native_password BY 'password';
GRANT ALL PRIVILEGES ON librenms.* TO 'librenms'@'localhost';
FLUSH PRIVILEGES;
Enable the poller service with this command:
sysrc librenms_enable="YES"
The service will log to /var/log/librems/librenms-service.log
For log file rotation
* sample file installed to /usr/local/www/librenms/contrib/newsyslog.conf.sample
* actual file installed, never overwriting, to /usr/local/etc/newsyslog.conf.d/librenms.conf
For new installs, you need a /usr/local/www/librenms/.env file. To create:
cd /usr/local/www/librenms
cp -i .env.example .env
That file will eventually contain secrets. Make sure it is not world-readable.
Database connection details are required in that file.
When trying to run /install for the first time you need to have (INSTALL=true)
in your .env file. If you don't set it you will get a 403 error on the
webpage.
Then run:
sudo php artisan key:generate
It should write directly to your .env file. The output should look something
like this:
$ sudo php artisan key:generate
Application key set successfully.
You need an APP_KEY.
* /usr/local/www/librenms/.env should now contain:
* APP_KEY
* NODE_I
* DB_HOST
* DB_DATABASE
* DB_USERNAME
* DB_PASSWORD
* you can create a NODE_ID with: php -r 'echo uniqid() . "\n";'
After that, follow the LibreNMS documentation for configuration.
It is also a good idea to validate your configuation after MySQL has been
started:
cd /usr/local/www/librenms
echo ./validate.php | sudu su -fm www
- If upgrading
- Depending on the version, you may have to run the upgrade script.
sudo su -fm www
/usr/local/bin/lnms migrate
NOTE: that script is particular about who runs it and ownership.
Previously, it was suggested you avoid this via chown when using
the script /usr/local/www/librenms/lnms
Now, a symlink is provided. Using /usr/local/bin/lnms avoids
those issues. Use it instead.
re: https://docs.librenms.org/General/Updating/
LibreNMS requires specific entries in my.cnf for MySQL.
NOTE that the lower_case_table_names entry needs to be set before you start
MySQL for the first time.
innodb_file_per_table=1
lower_case_table_names=0
For MySQL 8, you need to update the my.cnf
And adjust the login (adjusting localhost as required):
alter user 'librenms'@'localhost' identified with mysql_native_password by 'passwordhere';
NOTE: Starting with the 22.2.1 port the /usr/local/www/librenms/storage directory has
been replaced with a symlink to /var/db/librenms/storage
NOTE: Maintainer has noticed that upon reboot (at least in jails), the service
does not properly start. Monitor /var/log/librenms/*.log and if you see
'Unable to launch a new process', then restart the service via:
service librenms restart
- Master Sites:
|
Commit History - (may be incomplete: for full details, see links to repositories near top of page) |
Commit | Credits | Log message |
1.26,1 11 Apr 2017 22:11:39 |
bofh |
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 |
1.25,1 11 Mar 2017 12:54:20 |
bofh |
net-mgmt/librenms: Update version 1.24=>1.25 |
1.24,1 10 Mar 2017 13:06:23 |
antoine |
Do not override USES when PACKAGE_BUILDING is set, this should fix the
failure reported by package builders |
1.24,1 26 Feb 2017 11:01:41 |
bofh |
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] |
1.23_3,1 16 Jan 2017 14:19:17 |
dvl |
Add more detail about my.cnf changes
Submitted by: Christoph Moench-Tegeder <cmt@burggraben.net> |
1.23_2,1 16 Jan 2017 03:14:54 |
dvl |
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> |
1.23_1,1 15 Jan 2017 21:20:16 |
dvl |
Upgrade to 1.23,1
Be sure to set the following in my.cnf:
[mysqld]
innodb_file_per_table=1
sql-mode="" |
201607 27 Jul 2016 20:42:46 |
bofh |
net-mgmt/librenms: Update version 201605=>201607 |
201605 11 Jun 2016 18:42:57 |
bofh |
net-mgmt/librenms: Update version 201604=>201605 |
201604_1 23 May 2016 20:35:01 |
amdmi3 |
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 |
201604_1 19 May 2016 10:44:12 |
amdmi3 |
- Fix trailing whitespace in pkg-descrs, categories [g-n]*
Approved by: portmgr blanket |
201604_1 02 May 2016 16:08:56 |
zeising |
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 |
201604 22 Apr 2016 13:53:36 |
mat |
Remove ${PORTSDIR}/ from *_DEPENDS lines.
Sponsored by: Absolight |
201604 15 Apr 2016 09:30:09 |
bofh |
net-mgmt/librenms: Update version 201601=>201604
- Fix circular dependency of x11 and nox11 [1]
PR: 208356 [1]
Submitted by: daniel@blodan.se [1] |
201601 01 Apr 2016 14:16:20 |
mat |
Remove ${PORTSDIR}/ from dependencies, categories m, n, o, and p.
With hat: portmgr
Sponsored by: Absolight |
201601 01 Apr 2016 13:18:17 |
mat |
Fixup some whitespace at the beginning of lines problems.
With hat: portmgr
Sponsored by: Absolight |
201601 29 Jan 2016 19:00:52 |
dvl |
Upgrade to 201601
PR: 206298
Approved by: maintainer(bofh) |
201510 19 Oct 2015 18:44:41 |
bofh |
net-mgmt/librenms: Update version 201509=>201510 |
201509 15 Sep 2015 08:52:05 |
bofh |
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] |
201506 20 Jun 2015 08:10:00 |
bofh |
[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 |