From a0062aa63339397e14cb77cd6ae4e479c0aeaf70 Mon Sep 17 00:00:00 2001 From: CrazyMax <1951866+crazy-max@users.noreply.github.com> Date: Fri, 27 Nov 2020 23:34:58 +0100 Subject: [PATCH] Remove hardcoded URLs to doc (#12364) Co-authored-by: CrazyMax --- .github/ISSUE_TEMPLATE/New-Device.md | 2 +- .github/PULL_REQUEST_TEMPLATE.md | 2 +- CODE_OF_CONDUCT.md | 2 +- README.md | 6 +++--- doc/Developing/Code-Structure.md | 2 +- doc/Developing/Validating-Code.md | 2 +- doc/Extensions/Agent-Setup.md | 3 +-- doc/Extensions/Authentication.md | 2 +- doc/Extensions/Distributed-Poller.md | 2 +- doc/Extensions/Fast-Ping-Check.md | 4 ++-- doc/Extensions/Proxmox.md | 2 +- doc/Extensions/RRDCached.md | 4 +--- doc/Extensions/Smokeping.md | 4 ++-- doc/Extensions/Syslog.md | 3 +-- doc/Extensions/Varnish.md | 4 ++-- doc/General/Welcome-to-Observium-users.md | 2 +- doc/Installation/Install-LibreNMS.md | 17 ++++++++--------- .../Installation-CentOS-6-Apache-Nginx.md | 7 +++---- .../Installation-CentOS-7-Apache.md | 18 ++++++++---------- .../Installation-CentOS-7-Nginx.md | 17 ++++++++--------- .../Installation-Debian-10-Nginx.md | 17 ++++++++--------- .../Installation-Ubuntu-1604-Apache.md | 14 +++++++------- .../Installation-Ubuntu-1604-Nginx.md | 17 ++++++++--------- .../Installation-Ubuntu-1804-Apache.md | 17 ++++++++--------- .../Installation-Ubuntu-1804-Nginx.md | 17 ++++++++--------- doc/Support/FAQ.md | 11 ++++------- doc/Support/Performance.md | 6 +++--- mkdocs.yml | 2 +- 28 files changed, 95 insertions(+), 111 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/New-Device.md b/.github/ISSUE_TEMPLATE/New-Device.md index 169aee88ce..d1217ce90a 100644 --- a/.github/ISSUE_TEMPLATE/New-Device.md +++ b/.github/ISSUE_TEMPLATE/New-Device.md @@ -10,7 +10,7 @@ about: To request support for a new device type or add additional data Please confirm each of the sections below by putting an `x` in the box like `[x]`. -- [ ] Please provide **ALL** info asked for [here](http://docs.librenms.org/Support/FAQ/#faq20). +- [ ] Please provide **ALL** info asked for [here](https://docs.librenms.org/Support/FAQ/#faq20). - [ ] Please provide as much detail as possible. - [ ] Please do NOT post more than 10 lines of debug information here, use a pastebin service or GitHub Gists. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index d09f26a928..7f49c80f77 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -6,7 +6,7 @@ DO NOT DELETE THE UNDERLYING TEXT > Please read this information carefully. You can run `./lnms dev:check` to check your code before submitting. -- [ ] Have you followed our [code guidelines?](http://docs.librenms.org/Developing/Code-Guidelines/) +- [ ] Have you followed our [code guidelines?](https://docs.librenms.org/Developing/Code-Guidelines/) - [ ] If my Pull Request does some changes/fixes/enhancements in the WebUI, I have inserted a screenshot of it. #### Testers diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 4c314f7edb..a61ddf391d 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1 +1 @@ -Please see [our code of conduct policy](http://docs.librenms.org/General/CODE_OF_CONDUCT/). +Please see [our code of conduct policy](https://docs.librenms.org/General/CODE_OF_CONDUCT/). diff --git a/README.md b/README.md index 04ad301a5b..6e35370ccb 100644 --- a/README.md +++ b/README.md @@ -94,9 +94,9 @@ exception): [11]: http://www.librenms.org/#downloads [13]: http://freenode.net/philosophy.shtml "Freenode philosophy" [14]: https://github.com/librenms/librenms/tree/master/LICENSE.txt -[15]: http://docs.librenms.org/General/Contributing/ -[16]: http://docs.librenms.org/ -[17]: http://docs.librenms.org/General/Acknowledgement/ +[15]: https://docs.librenms.org/General/Contributing/ +[16]: https://docs.librenms.org/ +[17]: https://docs.librenms.org/General/Acknowledgement/ [19]: https://github.com/librenms/librenms/pulls diff --git a/doc/Developing/Code-Structure.md b/doc/Developing/Code-Structure.md index d38ed32af8..7f28e92265 100644 --- a/doc/Developing/Code-Structure.md +++ b/doc/Developing/Code-Structure.md @@ -41,7 +41,7 @@ directories that will be most interesting during development: ### doc/ This is the location of all the documentation for LibreNMS, this is in -GitHub markdown format and can be viewed [online](http://docs.librenms.org/) +GitHub markdown format and can be viewed [online](@= config.site_url =@) ### app/ diff --git a/doc/Developing/Validating-Code.md b/doc/Developing/Validating-Code.md index 8a730d50c3..7037d5ac6e 100644 --- a/doc/Developing/Validating-Code.md +++ b/doc/Developing/Validating-Code.md @@ -4,7 +4,7 @@ path: blob/master/doc/ #### Validating Code As part of the pull request process with GitHub we run some automated -build tests to ensure that the code is error free, standards [compliant](http://docs.librenms.org/Developing/Code-Guidelines/) +build tests to ensure that the code is error free, standards [compliant](../Developing/Code-Guidelines.md) and our test suite builds successfully. Rather than submit a pull request and wait for the results, you can diff --git a/doc/Extensions/Agent-Setup.md b/doc/Extensions/Agent-Setup.md index bb36d2ccd3..dff360828d 100644 --- a/doc/Extensions/Agent-Setup.md +++ b/doc/Extensions/Agent-Setup.md @@ -15,8 +15,7 @@ Make sure that systemd or xinetd is installed on the host you want to run the agent on. The agent uses TCP-Port 6556, please allow access from the **LibreNMS -host** and **poller nodes** if you're using the [Distributed -Polling](http://docs.librenms.org/Extensions/Distributed-Poller/) +host** and **poller nodes** if you're using the [Distributed Polling](Distributed-Poller.md) setup. On each of the hosts you would like to use the agent on, you need to do the following: diff --git a/doc/Extensions/Authentication.md b/doc/Extensions/Authentication.md index eb11064a7e..fd2361dfba 100644 --- a/doc/Extensions/Authentication.md +++ b/doc/Extensions/Authentication.md @@ -3,7 +3,7 @@ path: blob/master/doc/ # Authentication modules -LibreNMS supports multiple authentication modules along with [Two Factor Auth](http://docs.librenms.org/Extensions/Two-Factor-Auth/). +LibreNMS supports multiple authentication modules along with [Two Factor Auth](Two-Factor-Auth.md). Here we will provide configuration details for these modules. # Available authentication modules diff --git a/doc/Extensions/Distributed-Poller.md b/doc/Extensions/Distributed-Poller.md index 93c95f8f14..8b749e0746 100644 --- a/doc/Extensions/Distributed-Poller.md +++ b/doc/Extensions/Distributed-Poller.md @@ -93,7 +93,7 @@ running within an OpenStack environment with some commodity hardware for remote pollers. Here's a diagram of how you can scale LibreNMS out: -![Example Setup](http://docs.librenms.org/img/librenms-distributed-diagram.png) +![Example Setup](@= config.site_url =@/img/librenms-distributed-diagram.png) ## Architecture diff --git a/doc/Extensions/Fast-Ping-Check.md b/doc/Extensions/Fast-Ping-Check.md index f6387b2cff..30f3e762b5 100644 --- a/doc/Extensions/Fast-Ping-Check.md +++ b/doc/Extensions/Fast-Ping-Check.md @@ -20,7 +20,7 @@ Collection](../Alerting/Rules.md#alert-rules-collection). ## Setting the ping check to 1 minute -1: If you are using [RRDCached](http://docs.librenms.org/Extensions/RRDCached/), stop the service. +1: If you are using [RRDCached](../Extensions/RRDCached.md), stop the service. - This will flush all pending writes so that the rrdstep.php script can change the steps. @@ -44,7 +44,7 @@ ping checks * * * * * librenms /opt/librenms/ping.php >> /dev/null 2>&1 ``` -5: If applicable: Start the [RRDCached](http://docs.librenms.org/Extensions/RRDCached/) service +5: If applicable: Start the [RRDCached](../Extensions/RRDCached.md) service **NOTE**: If you are using distributed pollers you can restrict a diff --git a/doc/Extensions/Proxmox.md b/doc/Extensions/Proxmox.md index ebaa72b51b..68f2348fbf 100644 --- a/doc/Extensions/Proxmox.md +++ b/doc/Extensions/Proxmox.md @@ -22,7 +22,7 @@ $config['enable_proxmox'] = 1; ``` Then, install git and -[librenms-agent](http://docs.librenms.org/Extensions/Applications/) on +[librenms-agent](Applications.md) on the machines running Proxmox and enable the Proxmox-script using: ```bash diff --git a/doc/Extensions/RRDCached.md b/doc/Extensions/RRDCached.md index 9ea1afbdcc..2ad25c3dcb 100644 --- a/doc/Extensions/RRDCached.md +++ b/doc/Extensions/RRDCached.md @@ -285,7 +285,7 @@ $config['rrdcached'] = "unix:/run/rrdcached.sock"; Check to see if the graphs are being drawn in LibreNMS. This might take a few minutes. After at least one poll cycle (5 mins), check the LibreNMS disk I/O performance delta. Disk I/O can be found under the menu Devices>All Devices>[localhost -hostname]>Health>Disk I/O. +hostname](../Installation/Installation-CentOS-7-Apache.md)>Health>Disk I/O. Depending on many factors, you should see the Ops/sec drop by ~30-40%. @@ -293,5 +293,3 @@ Depending on many factors, you should see the Ops/sec drop by ~30-40%. Please see [RRDCached Security](RRDCached-Security.md) -[1]: http://librenms.readthedocs.org/Installation/Installation-CentOS-7-Apache/ -"Add localhost to LibreNMS" diff --git a/doc/Extensions/Smokeping.md b/doc/Extensions/Smokeping.md index 6fd7d18b55..1e7a9a2569 100644 --- a/doc/Extensions/Smokeping.md +++ b/doc/Extensions/Smokeping.md @@ -184,7 +184,7 @@ You should be able to load the Smokeping web interface at `http://yourhost/cgi-b ### Nginx Configuration - Ubuntu, Debian and alike This section assumes you have configured LibreNMS with Nginx as -specified in [Configure Nginx](https://docs.librenms.org/Installation/Installation-Ubuntu-1804-Nginx/). +specified in [Configure Nginx](../Installation/Installation-Ubuntu-1804-Nginx.md). Add the following configuration to your `/etc/nginx/conf.d/librenms` config file. @@ -327,4 +327,4 @@ commend out the sendmail entry in the configuration: ```diff -sendmail = /usr/sbin/sendmail +#sendmail = /usr/sbin/sendmail -``` \ No newline at end of file +``` diff --git a/doc/Extensions/Syslog.md b/doc/Extensions/Syslog.md index 00f66284d5..3bf2ca77f7 100644 --- a/doc/Extensions/Syslog.md +++ b/doc/Extensions/Syslog.md @@ -264,8 +264,7 @@ $config['syslog_purge'] = 30; The cleanup is run by daily.sh and any entries over X days old are automatically purged. Values are in days. See here for more Clean Up -Options -[Link](https://docs.librenms.org/Support/Cleanup-options/) +Options [Link](../Support/Cleanup-options.md) # Client configuration diff --git a/doc/Extensions/Varnish.md b/doc/Extensions/Varnish.md index 54e3532efb..03cccfc56c 100644 --- a/doc/Extensions/Varnish.md +++ b/doc/Extensions/Varnish.md @@ -14,13 +14,13 @@ decrease page load times significantly. # Simplified block diagram of an Apache HTTP server with Varnish 4.0 Reverse Proxy -![Block Diagram 1](http://docs.librenms.org/img/varnish_block.png) +![Block Diagram 1](@= config.site_url =@/img/varnish_block.png) # CentOS 7 Varnish Installation In this example we will assume your Apache 2.4.X HTTP server is working and configured to process HTTP requests on port 80. If not, please see -[Installing LibreNMS](http://librenms.readthedocs.org/Installation/Installing-CentOS-7-Apache) +[Installing LibreNMS](../Installation/Installation-CentOS-7-Apache.md) # Install Varnish 4.0 RPM diff --git a/doc/General/Welcome-to-Observium-users.md b/doc/General/Welcome-to-Observium-users.md index 9167370134..ba54a5fd84 100644 --- a/doc/General/Welcome-to-Observium-users.md +++ b/doc/General/Welcome-to-Observium-users.md @@ -58,7 +58,7 @@ Reasons why you might want to use LibreNMS instead of Observium: "Free Software Foundation - what is free software?" [7]: http://libertysys.com.au/blog/observium-and-gpl "Paul's blog on what the GPL offers users" -[8]: https://docs.librenms.org/General/Contributing/ +[8]: ../General/Contributing.md "Contribution guidelines" [9]: https://community.librenms.org "LibreNMS issue database at GitHub" diff --git a/doc/Installation/Install-LibreNMS.md b/doc/Installation/Install-LibreNMS.md index 277267a938..a947dfb38f 100644 --- a/doc/Installation/Install-LibreNMS.md +++ b/doc/Installation/Install-LibreNMS.md @@ -522,7 +522,7 @@ cp /opt/librenms/librenms.nonroot.cron /etc/cron.d/librenms > settings in config.php is possible too. The config.php file will be > created in the upcoming steps. Review the following URL after you > finished librenms install steps: -> +> <@= config.site_url =@/Support/Configuration/#proxy-support> ## Copy logrotate config @@ -580,19 +580,18 @@ site: Now that you've installed LibreNMS, we'd suggest that you have a read of a few other docs to get you going: -- [Performance tuning](http://docs.librenms.org/Support/Performance) -- [Alerting](http://docs.librenms.org/Extensions/Alerting/) -- [Device Groups](http://docs.librenms.org/Extensions/Device-Groups/) -- [Auto discovery](http://docs.librenms.org/Extensions/Auto-Discovery/) +- [Performance tuning](../Support/Performance.md) +- [Alerting](../Extensions/Alerting.md) +- [Device Groups](../Extensions/Device-Groups.md) +- [Auto discovery](../Extensions/Auto-Discovery.md) ## Closing We hope you enjoy using LibreNMS. If you do, it would be great if you would consider opting into the stats system we have, please see [this -page](http://docs.librenms.org/General/Callback-Stats-and-Privacy/) on +page](../General/Callback-Stats-and-Privacy.md) on what it is and how to enable it. If you would like to help make LibreNMS better there are [many ways to -help](http://docs.librenms.org/Support/FAQ/#what-can-i-do-to-help). You -can also [back LibreNMS on Open -Collective](https://t.libren.ms/donations). +help](../Support/FAQ.md#a-namefaq9-what-can-i-do-to-helpa). You +can also [back LibreNMS on Open Collective](https://t.libren.ms/donations). diff --git a/doc/Installation/Installation-CentOS-6-Apache-Nginx.md b/doc/Installation/Installation-CentOS-6-Apache-Nginx.md index 32346b79ac..0f37ddec23 100644 --- a/doc/Installation/Installation-CentOS-6-Apache-Nginx.md +++ b/doc/Installation/Installation-CentOS-6-Apache-Nginx.md @@ -435,7 +435,7 @@ cp librenms.nonroot.cron /etc/cron.d/librenms > settings in config.php is possible too. The config.php file will be > created in the upcoming steps. Review the following URL after you > finished librenms install steps: -> +> <@= config.site_url =@/Support/Configuration/#proxy-support> # Copy logrotate config @@ -468,7 +468,7 @@ $config['update'] = 0; Please allow for 2-3 runs of the poller-wrapper for data to start appearing in the WebUI. If you don't see data after this, please refer -to the [FAQ](http://docs.librenms.org/Support/FAQ/) for assistance. +to the [FAQ](../Support/FAQ.md) for assistance. That's it! You now should be able to log in to . Please note that we have not covered @@ -478,7 +478,6 @@ have configured HTTPS and taken appropriate web server hardening steps. It would be great if you would consider opting into the stats system -we have, please see [this -page](http://docs.librenms.org/General/Callback-Stats-and-Privacy/) on +we have, please see [this page](../General/Callback-Stats-and-Privacy.md) on what it is and how to enable it. diff --git a/doc/Installation/Installation-CentOS-7-Apache.md b/doc/Installation/Installation-CentOS-7-Apache.md index 26e3461ffc..3f66674012 100644 --- a/doc/Installation/Installation-CentOS-7-Apache.md +++ b/doc/Installation/Installation-CentOS-7-Apache.md @@ -286,7 +286,7 @@ cp /opt/librenms/librenms.nonroot.cron /etc/cron.d/librenms > settings in config.php is possible too. The config.php file will be > created in the upcoming steps. Review the following URL after you > finished librenms install steps: -> +> <@= config.site_url =@/Support/Configuration/#proxy-support> # Copy logrotate config @@ -345,20 +345,18 @@ site: Now that you've installed LibreNMS, we'd suggest that you have a read of a few other docs to get you going: -- [Performance tuning](http://docs.librenms.org/Support/Performance) -- [Alerting](http://docs.librenms.org/Extensions/Alerting/) -- [Device Groups](http://docs.librenms.org/Extensions/Device-Groups/) -- [Auto discovery](http://docs.librenms.org/Extensions/Auto-Discovery/) +- [Performance tuning](../Support/Performance.md) +- [Alerting](../Extensions/Alerting.md) +- [Device Groups](../Extensions/Device-Groups.md) +- [Auto discovery](../Extensions/Auto-Discovery.md) # Closing We hope you enjoy using LibreNMS. If you do, it would be great if you would consider opting into the stats system we have, please see [this -page](http://docs.librenms.org/General/Callback-Stats-and-Privacy/) on +page](../General/Callback-Stats-and-Privacy.md) on what it is and how to enable it. If you would like to help make LibreNMS better there are [many ways to -help](http://docs.librenms.org/Support/FAQ/#what-can-i-do-to-help). You -can also [back LibreNMS on Open -Collective](https://t.libren.ms/donations). - +help](../Support/FAQ.md#a-namefaq9-what-can-i-do-to-helpa). You +can also [back LibreNMS on Open Collective](https://t.libren.ms/donations). diff --git a/doc/Installation/Installation-CentOS-7-Nginx.md b/doc/Installation/Installation-CentOS-7-Nginx.md index 3e3a3e514c..dc71012e1a 100644 --- a/doc/Installation/Installation-CentOS-7-Nginx.md +++ b/doc/Installation/Installation-CentOS-7-Nginx.md @@ -272,7 +272,7 @@ cp /opt/librenms/librenms.nonroot.cron /etc/cron.d/librenms > settings in config.php is possible too. The config.php file will be > created in the upcoming steps. Review the following URL after you > finished librenms install steps: -> +> <@= config.site_url =@/Support/Configuration/#proxy-support> # Copy logrotate config @@ -331,19 +331,18 @@ site: Now that you've installed LibreNMS, we'd suggest that you have a read of a few other docs to get you going: -- [Performance tuning](http://docs.librenms.org/Support/Performance) -- [Alerting](http://docs.librenms.org/Extensions/Alerting/) -- [Device Groups](http://docs.librenms.org/Extensions/Device-Groups/) -- [Auto discovery](http://docs.librenms.org/Extensions/Auto-Discovery/) +- [Performance tuning](../Support/Performance.md) +- [Alerting](../Extensions/Alerting.md) +- [Device Groups](../Extensions/Device-Groups.md) +- [Auto discovery](../Extensions/Auto-Discovery.md) # Closing We hope you enjoy using LibreNMS. If you do, it would be great if you would consider opting into the stats system we have, please see [this -page](http://docs.librenms.org/General/Callback-Stats-and-Privacy/) on +page](../General/Callback-Stats-and-Privacy.md) on what it is and how to enable it. If you would like to help make LibreNMS better there are [many ways to -help](http://docs.librenms.org/Support/FAQ/#what-can-i-do-to-help). You -can also [back LibreNMS on Open -Collective](https://t.libren.ms/donations). +help](../Support/FAQ.md#a-namefaq9-what-can-i-do-to-helpa). You +can also [back LibreNMS on Open Collective](https://t.libren.ms/donations). diff --git a/doc/Installation/Installation-Debian-10-Nginx.md b/doc/Installation/Installation-Debian-10-Nginx.md index 9756de6dae..a61e4483da 100644 --- a/doc/Installation/Installation-Debian-10-Nginx.md +++ b/doc/Installation/Installation-Debian-10-Nginx.md @@ -166,7 +166,7 @@ cp /opt/librenms/librenms.nonroot.cron /etc/cron.d/librenms > settings in config.php is possible too. The config.php file will be > created in the upcoming steps. Review the following URL after you > finished librenms install steps: -> +> <@= config.site_url =@/Support/Configuration/#proxy-support> # Copy logrotate config @@ -226,19 +226,18 @@ site: Now that you've installed LibreNMS, we'd suggest that you have a read of a few other docs to get you going: -- [Performance tuning](http://docs.librenms.org/Support/Performance) -- [Alerting](http://docs.librenms.org/Extensions/Alerting/) -- [Device Groups](http://docs.librenms.org/Extensions/Device-Groups/) -- [Auto discovery](http://docs.librenms.org/Extensions/Auto-Discovery/) +- [Performance tuning](../Support/Performance.md) +- [Alerting](../Extensions/Alerting.md) +- [Device Groups](../Extensions/Device-Groups.md) +- [Auto discovery](../Extensions/Auto-Discovery.md) # Closing We hope you enjoy using LibreNMS. If you do, it would be great if you would consider opting into the stats system we have, please see [this -page](http://docs.librenms.org/General/Callback-Stats-and-Privacy/) on +page](../General/Callback-Stats-and-Privacy.md) on what it is and how to enable it. If you would like to help make LibreNMS better there are [many ways to -help](http://docs.librenms.org/Support/FAQ/#what-can-i-do-to-help). You -can also [back LibreNMS on Open -Collective](https://t.libren.ms/donations). +help](../Support/FAQ.md#a-namefaq9-what-can-i-do-to-helpa). You +can also [back LibreNMS on Open Collective](https://t.libren.ms/donations). diff --git a/doc/Installation/Installation-Ubuntu-1604-Apache.md b/doc/Installation/Installation-Ubuntu-1604-Apache.md index 851f68b031..e307a11b3b 100644 --- a/doc/Installation/Installation-Ubuntu-1604-Apache.md +++ b/doc/Installation/Installation-Ubuntu-1604-Apache.md @@ -142,7 +142,7 @@ cp /opt/librenms/librenms.nonroot.cron /etc/cron.d/librenms > settings in config.php is possible too. The config.php file will be > created in the upcoming steps. Review the following URL after you > finished librenms install steps: -> +> <@= config.site_url =@/Support/Configuration/#proxy-support> # Copy logrotate config @@ -209,19 +209,19 @@ site: Now that you've installed LibreNMS, we'd suggest that you have a read of a few other docs to get you going: -- [Performance tuning](http://docs.librenms.org/Support/Performance) -- [Alerting](http://docs.librenms.org/Extensions/Alerting/) -- [Device Groups](http://docs.librenms.org/Extensions/Device-Groups/) -- [Auto discovery](http://docs.librenms.org/Extensions/Auto-Discovery/) +- [Performance tuning](../Support/Performance.md) +- [Alerting](../Extensions/Alerting.md) +- [Device Groups](../Extensions/Device-Groups.md) +- [Auto discovery](../Extensions/Auto-Discovery.md) # Closing We hope you enjoy using LibreNMS. If you do, it would be great if you would consider opting into the stats system we have, please see [this -page](http://docs.librenms.org/General/Callback-Stats-and-Privacy/) on +page](../General/Callback-Stats-and-Privacy.md) on what it is and how to enable it. If you would like to help make LibreNMS better there are [many ways to -help](http://docs.librenms.org/Support/FAQ/#what-can-i-do-to-help). You +help](../Support/FAQ.md#a-namefaq9-what-can-i-do-to-helpa). You can also [back LibreNMS on Open Collective](https://t.libren.ms/donations). diff --git a/doc/Installation/Installation-Ubuntu-1604-Nginx.md b/doc/Installation/Installation-Ubuntu-1604-Nginx.md index c1caed7778..81ce0409df 100644 --- a/doc/Installation/Installation-Ubuntu-1604-Nginx.md +++ b/doc/Installation/Installation-Ubuntu-1604-Nginx.md @@ -148,7 +148,7 @@ cp /opt/librenms/librenms.nonroot.cron /etc/cron.d/librenms > settings in config.php is possible too. The config.php file will be > created in the upcoming steps. Review the following URL after you > finished librenms install steps: -> +> <@= config.site_url =@/Support/Configuration/#proxy-support> # Copy logrotate config @@ -217,19 +217,18 @@ site: Now that you've installed LibreNMS, we'd suggest that you have a read of a few other docs to get you going: -- [Performance tuning](http://docs.librenms.org/Support/Performance) -- [Alerting](http://docs.librenms.org/Extensions/Alerting/) -- [Device Groups](http://docs.librenms.org/Extensions/Device-Groups/) -- [Auto discovery](http://docs.librenms.org/Extensions/Auto-Discovery/) +- [Performance tuning](../Support/Performance.md) +- [Alerting](../Extensions/Alerting.md) +- [Device Groups](../Extensions/Device-Groups.md) +- [Auto discovery](../Extensions/Auto-Discovery.md) # Closing We hope you enjoy using LibreNMS. If you do, it would be great if you would consider opting into the stats system we have, please see [this -page](http://docs.librenms.org/General/Callback-Stats-and-Privacy/) on +page](../General/Callback-Stats-and-Privacy.md) on what it is and how to enable it. If you would like to help make LibreNMS better there are [many ways to -help](http://docs.librenms.org/Support/FAQ/#what-can-i-do-to-help). You -can also [back LibreNMS on Open -Collective](https://t.libren.ms/donations). +help](../Support/FAQ.md#a-namefaq9-what-can-i-do-to-helpa). You +can also [back LibreNMS on Open Collective](https://t.libren.ms/donations). diff --git a/doc/Installation/Installation-Ubuntu-1804-Apache.md b/doc/Installation/Installation-Ubuntu-1804-Apache.md index 0c35af2f8d..f6811f9d90 100644 --- a/doc/Installation/Installation-Ubuntu-1804-Apache.md +++ b/doc/Installation/Installation-Ubuntu-1804-Apache.md @@ -159,7 +159,7 @@ cp /opt/librenms/librenms.nonroot.cron /etc/cron.d/librenms > settings in config.php is possible too. The config.php file will be > created in the upcoming steps. Review the following URL after you > finished librenms install steps: -> +> <@= config.site_url =@/Support/Configuration/#proxy-support> # Copy logrotate config @@ -220,19 +220,18 @@ site: Now that you've installed LibreNMS, we'd suggest that you have a read of a few other docs to get you going: -- [Performance tuning](http://docs.librenms.org/Support/Performance) -- [Alerting](http://docs.librenms.org/Extensions/Alerting/) -- [Device Groups](http://docs.librenms.org/Extensions/Device-Groups/) -- [Auto discovery](http://docs.librenms.org/Extensions/Auto-Discovery/) +- [Performance tuning](../Support/Performance.md) +- [Alerting](../Extensions/Alerting.md) +- [Device Groups](../Extensions/Device-Groups.md) +- [Auto discovery](../Extensions/Auto-Discovery.md) # Closing We hope you enjoy using LibreNMS. If you do, it would be great if you would consider opting into the stats system we have, please see [this -page](http://docs.librenms.org/General/Callback-Stats-and-Privacy/) on +page](../General/Callback-Stats-and-Privacy.md) on what it is and how to enable it. If you would like to help make LibreNMS better there are [many ways to -help](http://docs.librenms.org/Support/FAQ/#what-can-i-do-to-help). You -can also [back LibreNMS on Open -Collective](https://t.libren.ms/donations). +help](../Support/FAQ.md#a-namefaq9-what-can-i-do-to-helpa). You +can also [back LibreNMS on Open Collective](https://t.libren.ms/donations). diff --git a/doc/Installation/Installation-Ubuntu-1804-Nginx.md b/doc/Installation/Installation-Ubuntu-1804-Nginx.md index 59f3dbae92..f3defa99d3 100644 --- a/doc/Installation/Installation-Ubuntu-1804-Nginx.md +++ b/doc/Installation/Installation-Ubuntu-1804-Nginx.md @@ -173,7 +173,7 @@ cp /opt/librenms/librenms.nonroot.cron /etc/cron.d/librenms > settings in config.php is possible too. The config.php file will be > created in the upcoming steps. Review the following URL after you > finished librenms install steps: -> +> <@= config.site_url =@/Support/Configuration/#proxy-support> # Copy logrotate config @@ -241,19 +241,18 @@ site: Now that you've installed LibreNMS, we'd suggest that you have a read of a few other docs to get you going: -- [Performance tuning](http://docs.librenms.org/Support/Performance) -- [Alerting](http://docs.librenms.org/Extensions/Alerting/) -- [Device Groups](http://docs.librenms.org/Extensions/Device-Groups/) -- [Auto discovery](http://docs.librenms.org/Extensions/Auto-Discovery/) +- [Performance tuning](../Support/Performance.md) +- [Alerting](../Extensions/Alerting.md) +- [Device Groups](../Extensions/Device-Groups.md) +- [Auto discovery](../Extensions/Auto-Discovery.md) # Closing We hope you enjoy using LibreNMS. If you do, it would be great if you would consider opting into the stats system we have, please see [this -page](http://docs.librenms.org/General/Callback-Stats-and-Privacy/) on +page](../General/Callback-Stats-and-Privacy.md) on what it is and how to enable it. If you would like to help make LibreNMS better there are [many ways to -help](http://docs.librenms.org/Support/FAQ/#what-can-i-do-to-help). You -can also [back LibreNMS on Open -Collective](https://t.libren.ms/donations). +help](../Support/FAQ.md#a-namefaq9-what-can-i-do-to-helpa). You +can also [back LibreNMS on Open Collective](https://t.libren.ms/donations). diff --git a/doc/Support/FAQ.md b/doc/Support/FAQ.md index 78bf9d63be..f200a06b5a 100644 --- a/doc/Support/FAQ.md +++ b/doc/Support/FAQ.md @@ -55,7 +55,7 @@ path: blob/master/doc/ This is currently well documented within the doc folder of the installation files. -Please see the following [doc](http://docs.librenms.org/Installation/Installing-LibreNMS/) +Please see the following [doc](../Installation/Installing-LibreNMS.md) ## How do I add a device? @@ -140,14 +140,12 @@ bottom of every page that will show you detailed debug information. ## How do I debug the discovery process? -Please see the [Discovery -Support](http://docs.librenms.org/Support/Discovery Support/) document +Please see the [Discovery Support](Discovery%20Support.md) document for further details. ## How do I debug the poller process? -Please see the [Poller -Support](http://docs.librenms.org/Support/Poller Support/) document +Please see the [Poller Support](Poller%20Support.md) document for further details. ## Why do I get a lot apache or rrdtool zombies in my process list? @@ -565,8 +563,7 @@ MySQL/MariaDB. ## My alert templates stopped working You should probably have a look in the documentation concerning the -new template syntax: -. Since version 1.42, +new [template syntax](../Alerting/Templates.md). Since version 1.42, syntax changed, and you basically need to convert your templates to this new syntax (including the titles). diff --git a/doc/Support/Performance.md b/doc/Support/Performance.md index 21ff03ce47..30c07cb3f3 100644 --- a/doc/Support/Performance.md +++ b/doc/Support/Performance.md @@ -9,7 +9,7 @@ The suggestions are in a rough order of how much impact they will have. ## RRDCached -**We absolutely recommend running this, it will save on IO load**. [RRDCached](http://docs.librenms.org/Extensions/RRDCached/) +**We absolutely recommend running this, it will save on IO load**. [RRDCached](../Extensions/RRDCached.md) ## MySQL Optimisation @@ -45,7 +45,7 @@ $config['poller_modules']['ospf'] = false; You can disable modules globally then re-enable the module per device or the opposite way. For a list of modules please see [Poller -modules](http://docs.librenms.org/Support/Poller%20Support/) +modules](../Support/Poller%20Support.md) ## SNMP Max Repeaters @@ -122,7 +122,7 @@ librenms. Usually in `/etc/cron.d/librenms` and changing the "16" ``` */5 * * * * librenms /opt/librenms/cronic /opt/librenms/poller-wrapper.py 16 ``` -Please also see [Dispatcher Service](https://docs.librenms.org/Extensions/Dispatcher-Service/) +Please also see [Dispatcher Service](../Extensions/Dispatcher-Service.md) ## Recursive DNS diff --git a/mkdocs.yml b/mkdocs.yml index b1985a5c13..67f39a9afe 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -10,7 +10,7 @@ theme: code: 'Roboto Mono' feature: null site_dir: out -site_url: http://docs.librenms.org +site_url: https://docs.librenms.org markdown_extensions: - pymdownx.tasklist - pymdownx.tilde