From d3e5b0da3b5d7374711ed65d2751fcccb243aca1 Mon Sep 17 00:00:00 2001 From: Santiago Z Date: Wed, 8 May 2024 00:45:21 -0300 Subject: [PATCH] [DOC] Install LibreNMS: add Icons (#16017) * [DOC] Install LibreNMS: add Icons * Update mkdocs.yml * Update Customizing-the-Web-UI.md --- doc/Extensions/Customizing-the-Web-UI.md | 2 +- doc/Installation/Install-LibreNMS.md | 80 ++++++++++++------------ mkdocs.yml | 4 ++ 3 files changed, 45 insertions(+), 41 deletions(-) diff --git a/doc/Extensions/Customizing-the-Web-UI.md b/doc/Extensions/Customizing-the-Web-UI.md index a6406844c5..def634439b 100644 --- a/doc/Extensions/Customizing-the-Web-UI.md +++ b/doc/Extensions/Customizing-the-Web-UI.md @@ -65,7 +65,7 @@ Windows Registry Editor Version 5.00 [HKEY_CLASSES_ROOT\winbox\shell] [HKEY_CLASSES_ROOT\winbox\shell\open] [HKEY_CLASSES_ROOT\winbox\shell\open\command] -@= '@="C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe -Command \"$val=\'%l\'; $val = $val.TrimEnd(\'/\');if ($val.StartsWith(\'winbox://\' { $val = $val.SubString(9) }; & \'C:\Program Files\winbox64.exe\' \"$val\"\""' =@ +@= '@="C:\\Windows\\System32\\WindowsPowerShell\v1.0\\powershell.exe -Command \"$val=\'%l\'; $val = $val.TrimEnd(\'/\');if ($val.StartsWith(\'winbox://\' { $val = $val.SubString(9) }; & \'C:\\Program Files\\winbox64.exe\' \"$val\"\""' =@ ``` Now we can use that in the device menu entry to open winbox. diff --git a/doc/Installation/Install-LibreNMS.md b/doc/Installation/Install-LibreNMS.md index 3d876e3e41..d3deff4149 100644 --- a/doc/Installation/Install-LibreNMS.md +++ b/doc/Installation/Install-LibreNMS.md @@ -18,14 +18,14 @@ Connect to the server command line and follow the instructions below. ## Install Required Packages -=== "Ubuntu 22.04" - === "NGINX" +=== ":fontawesome-brands-ubuntu: Ubuntu 22.04" + === ":simple-nginx: NGINX" ``` apt install acl curl fping git graphviz imagemagick mariadb-client mariadb-server mtr-tiny nginx-full nmap php-cli php-curl php-fpm php-gd php-gmp php-json php-mbstring php-mysql php-snmp php-xml php-zip rrdtool snmp snmpd unzip python3-pymysql python3-dotenv python3-redis python3-setuptools python3-systemd python3-pip whois traceroute ``` -=== "Ubuntu 20.04" - === "NGINX" +=== ":fontawesome-brands-ubuntu: Ubuntu 20.04" + === ":simple-nginx: NGINX" ``` apt install software-properties-common add-apt-repository universe @@ -34,7 +34,7 @@ Connect to the server command line and follow the instructions below. apt install acl curl fping git graphviz imagemagick mariadb-client mariadb-server mtr-tiny nginx-full nmap php-cli php-curl php-fpm php-gd php-gmp php-json php-mbstring php-mysql php-snmp php-xml php-zip rrdtool snmp snmpd unzip python3-pymysql python3-dotenv python3-redis python3-setuptools python3-systemd python3-pip whois traceroute ``` - === "Apache" + === ":simple-apache: Apache" ``` apt install software-properties-common add-apt-repository universe @@ -43,8 +43,8 @@ Connect to the server command line and follow the instructions below. apt install acl curl apache2 fping git graphviz imagemagick libapache2-mod-fcgid mariadb-client mariadb-server mtr-tiny nmap php-cli php-curl php-fpm php-gd php-gmp php-json php-mbstring php-mysql php-snmp php-xml php-zip rrdtool snmp snmpd whois python3-pymysql python3-dotenv python3-redis python3-setuptools python3-systemd python3-pip unzip traceroute ``` -=== "CentOS 8" - === "NGINX" +=== ":fontawesome-brands-centos: CentOS 8" + === ":simple-nginx: NGINX" ``` dnf -y install epel-release dnf -y install dnf-utils http://rpms.remirepo.net/enterprise/remi-release-8.rpm @@ -53,7 +53,7 @@ Connect to the server command line and follow the instructions below. dnf install bash-completion cronie fping git ImageMagick mariadb-server mtr net-snmp net-snmp-utils nginx nmap php-fpm php-cli php-common php-curl php-gd php-gmp php-json php-mbstring php-process php-snmp php-xml php-zip php-mysqlnd python3 python3-PyMySQL python3-redis python3-memcached python3-pip python3-systemd rrdtool unzip ``` - === "Apache" + === ":simple-apache: Apache" ``` dnf -y install epel-release dnf -y install dnf-utils http://rpms.remirepo.net/enterprise/remi-release-8.rpm @@ -62,8 +62,8 @@ Connect to the server command line and follow the instructions below. dnf install bash-completion cronie fping gcc git httpd ImageMagick mariadb-server mtr net-snmp net-snmp-utils nmap php-fpm php-cli php-common php-curl php-gd php-gmp php-json php-mbstring php-process php-snmp php-xml php-zip php-mysqlnd python3 python3-devel python3-PyMySQL python3-redis python3-memcached python3-pip python3-systemd rrdtool unzip ``` -=== "Debian 12" - === "NGINX" +=== ":fontawesome-brands-debian: Debian 12" + === ":simple-nginx: NGINX" ``` apt install apt-transport-https lsb-release ca-certificates wget acl curl fping git graphviz imagemagick mariadb-client mariadb-server mtr-tiny nginx-full nmap php8.2-cli php8.2-curl php8.2-fpm php8.2-gd php8.2-gmp php8.2-mbstring php8.2-mysql php8.2-snmp php8.2-xml php8.2-zip python3-dotenv python3-pymysql python3-redis python3-setuptools python3-systemd python3-pip rrdtool snmp snmpd unzip whois ``` @@ -110,24 +110,24 @@ See for a list of supported timezones. Valid examples are: "America/New_York", "Australia/Brisbane", "Etc/UTC". Ensure date.timezone is set in php.ini to your preferred time zone. -=== "Ubuntu 22.04" +=== ":fontawesome-brands-ubuntu: Ubuntu 22.04" ```bash vi /etc/php/8.1/fpm/php.ini vi /etc/php/8.1/cli/php.ini ``` -=== "Ubuntu 20.04" +=== ":fontawesome-brands-ubuntu: Ubuntu 20.04" ```bash vi /etc/php/8.1/fpm/php.ini vi /etc/php/8.1/cli/php.ini ``` -=== "CentOS 8" +=== ":fontawesome-brands-centos: CentOS 8" ``` vi /etc/php.ini ``` -=== "Debian 12" +=== ":fontawesome-brands-debian: Debian 12" ```bash vi /etc/php/8.2/fpm/php.ini vi /etc/php/8.2/cli/php.ini @@ -142,22 +142,22 @@ timedatectl set-timezone Etc/UTC ## Configure MariaDB -=== "Ubuntu 22.04" +=== ":fontawesome-brands-ubuntu: Ubuntu 22.04" ``` vi /etc/mysql/mariadb.conf.d/50-server.cnf ``` -=== "Ubuntu 20.04" +=== ":fontawesome-brands-ubuntu: Ubuntu 20.04" ``` vi /etc/mysql/mariadb.conf.d/50-server.cnf ``` -=== "CentOS 8" +=== ":fontawesome-brands-centos: CentOS 8" ``` vi /etc/my.cnf.d/mariadb-server.cnf ``` -=== "Debian 12" +=== ":fontawesome-brands-debian: Debian 12" ``` vi /etc/mysql/mariadb.conf.d/50-server.cnf ``` @@ -192,25 +192,25 @@ exit ## Configure PHP-FPM -=== "Ubuntu 22.04" +=== ":fontawesome-brands-ubuntu: Ubuntu 22.04" ```bash cp /etc/php/8.1/fpm/pool.d/www.conf /etc/php/8.1/fpm/pool.d/librenms.conf vi /etc/php/8.1/fpm/pool.d/librenms.conf ``` -=== "Ubuntu 20.04" +=== ":fontawesome-brands-ubuntu: Ubuntu 20.04" ```bash cp /etc/php/8.1/fpm/pool.d/www.conf /etc/php/8.1/fpm/pool.d/librenms.conf vi /etc/php/8.1/fpm/pool.d/librenms.conf ``` -=== "CentOS 8" +=== ":fontawesome-brands-centos: CentOS 8" ```bash cp /etc/php-fpm.d/www.conf /etc/php-fpm.d/librenms.conf vi /etc/php-fpm.d/librenms.conf ``` -=== "Debian 12" +=== ":fontawesome-brands-debian: Debian 12" ```bash cp /etc/php/8.2/fpm/pool.d/www.conf /etc/php/8.2/fpm/pool.d/librenms.conf vi /etc/php/8.2/fpm/pool.d/librenms.conf @@ -237,8 +237,8 @@ Feel free to tune the performance settings in librenms.conf to meet your needs. ## Configure Web Server -=== "Ubuntu 22.04" - === "NGINX" +=== ":fontawesome-brands-ubuntu: Ubuntu 22.04" + === ":simple-nginx: NGINX" ```bash vi /etc/nginx/conf.d/librenms.conf ``` @@ -275,8 +275,8 @@ Feel free to tune the performance settings in librenms.conf to meet your needs. systemctl restart php8.1-fpm ``` -=== "Ubuntu 20.04" - === "NGINX" +=== ":fontawesome-brands-ubuntu: Ubuntu 20.04" + === ":simple-nginx: NGINX" ```bash vi /etc/nginx/conf.d/librenms.conf ``` @@ -313,7 +313,7 @@ Feel free to tune the performance settings in librenms.conf to meet your needs. systemctl restart php8.1-fpm ``` - === "Apache" + === ":simple-apache: Apache" ```bash vi /etc/apache2/sites-available/librenms.conf ``` @@ -351,8 +351,8 @@ Feel free to tune the performance settings in librenms.conf to meet your needs. systemctl restart php8.1-fpm ``` -=== "CentOS 8" - === "NGINX" +=== ":fontawesome-brands-centos: CentOS 8" + === ":simple-nginx: NGINX" ``` vi /etc/nginx/conf.d/librenms.conf ``` @@ -393,7 +393,7 @@ Feel free to tune the performance settings in librenms.conf to meet your needs. systemctl enable --now php-fpm ``` - === "Apache" + === ":simple-apache: Apache" Create the librenms.conf: ``` @@ -433,8 +433,8 @@ Feel free to tune the performance settings in librenms.conf to meet your needs. systemctl enable --now php-fpm ``` -=== "Debian 12" - === "NGINX" +=== ":fontawesome-brands-debian: Debian 12" + === ":simple-nginx: NGINX" ```bash vi /etc/nginx/sites-enabled/librenms.vhost ``` @@ -473,13 +473,13 @@ Feel free to tune the performance settings in librenms.conf to meet your needs. ## SELinux -=== "Ubuntu 22.04" +=== ":fontawesome-brands-ubuntu: Ubuntu 22.04" SELinux not enabled by default -=== "Ubuntu 20.04" +=== ":fontawesome-brands-ubuntu: Ubuntu 20.04" SELinux not enabled by default -=== "CentOS 8" +=== ":fontawesome-brands-centos: CentOS 8" Install the policy tool for SELinux: ``` @@ -535,25 +535,25 @@ Feel free to tune the performance settings in librenms.conf to meet your needs. audit2why < /var/log/audit/audit.log ``` -=== "Debian 12" +=== ":fontawesome-brands-debian: Debian 12" SELinux not enabled by default ## Allow access through firewall -=== "Ubuntu 22.04" +=== ":fontawesome-brands-ubuntu: Ubuntu 22.04" Firewall not enabled by default -=== "Ubuntu 20.04" +=== ":fontawesome-brands-ubuntu: Ubuntu 20.04" Firewall not enabled by default -=== "CentOS 8" +=== ":fontawesome-brands-centos: CentOS 8" ``` firewall-cmd --zone public --add-service http --add-service https firewall-cmd --permanent --zone public --add-service http --add-service https ``` -=== "Debian 12" +=== ":fontawesome-brands-debian: Debian 12" Firewall not enabled by default diff --git a/mkdocs.yml b/mkdocs.yml index 1d7fa1c44a..981f983960 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -33,8 +33,12 @@ theme: site_dir: out site_url: https://docs.librenms.org markdown_extensions: + - attr_list - tables - admonition + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg - pymdownx.tasklist - pymdownx.tilde - pymdownx.superfences