Skip to content

Commit

Permalink
Remove hardcoded URLs to doc (#12364)
Browse files Browse the repository at this point in the history
Co-authored-by: CrazyMax <crazy-max@users.noreply.github.com>
  • Loading branch information
crazy-max and crazy-max committed Nov 27, 2020
1 parent 2a98076 commit a0062aa
Show file tree
Hide file tree
Showing 28 changed files with 95 additions and 111 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/New-Device.md
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion 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/).
6 changes: 3 additions & 3 deletions README.md
Expand Up @@ -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


Expand Down
2 changes: 1 addition & 1 deletion doc/Developing/Code-Structure.md
Expand Up @@ -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/

Expand Down
2 changes: 1 addition & 1 deletion doc/Developing/Validating-Code.md
Expand Up @@ -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
Expand Down
3 changes: 1 addition & 2 deletions doc/Extensions/Agent-Setup.md
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion doc/Extensions/Authentication.md
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/Extensions/Distributed-Poller.md
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions doc/Extensions/Fast-Ping-Check.md
Expand Up @@ -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.

Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/Extensions/Proxmox.md
Expand Up @@ -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
Expand Down
4 changes: 1 addition & 3 deletions doc/Extensions/RRDCached.md
Expand Up @@ -285,13 +285,11 @@ $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%.

# Securing RRCached

Please see [RRDCached Security](RRDCached-Security.md)

[1]: http://librenms.readthedocs.org/Installation/Installation-CentOS-7-Apache/
"Add localhost to LibreNMS"
4 changes: 2 additions & 2 deletions doc/Extensions/Smokeping.md
Expand Up @@ -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.

Expand Down Expand Up @@ -327,4 +327,4 @@ commend out the sendmail entry in the configuration:
```diff
-sendmail = /usr/sbin/sendmail
+#sendmail = /usr/sbin/sendmail
```
```
3 changes: 1 addition & 2 deletions doc/Extensions/Syslog.md
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions doc/Extensions/Varnish.md
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion doc/General/Welcome-to-Observium-users.md
Expand Up @@ -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"
Expand Down
17 changes: 8 additions & 9 deletions doc/Installation/Install-LibreNMS.md
Expand Up @@ -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:
> <https://docs.librenms.org/Support/Configuration/#proxy-support>
> <@= config.site_url =@/Support/Configuration/#proxy-support>
## Copy logrotate config

Expand Down Expand Up @@ -580,19 +580,18 @@ site: <https://www.librenms.org/#support>
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).
7 changes: 3 additions & 4 deletions doc/Installation/Installation-CentOS-6-Apache-Nginx.md
Expand Up @@ -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:
> <https://docs.librenms.org/Support/Configuration/#proxy-support>
> <@= config.site_url =@/Support/Configuration/#proxy-support>
# Copy logrotate config

Expand Down Expand Up @@ -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
<http://librenms.example.com/>. Please note that we have not covered
Expand All @@ -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.

18 changes: 8 additions & 10 deletions doc/Installation/Installation-CentOS-7-Apache.md
Expand Up @@ -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:
> <https://docs.librenms.org/Support/Configuration/#proxy-support>
> <@= config.site_url =@/Support/Configuration/#proxy-support>
# Copy logrotate config

Expand Down Expand Up @@ -345,20 +345,18 @@ site: <https://www.librenms.org/#support>
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).
17 changes: 8 additions & 9 deletions doc/Installation/Installation-CentOS-7-Nginx.md
Expand Up @@ -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:
> <https://docs.librenms.org/Support/Configuration/#proxy-support>
> <@= config.site_url =@/Support/Configuration/#proxy-support>
# Copy logrotate config

Expand Down Expand Up @@ -331,19 +331,18 @@ site: <https://www.librenms.org/#support>
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).
17 changes: 8 additions & 9 deletions doc/Installation/Installation-Debian-10-Nginx.md
Expand Up @@ -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:
> <https://docs.librenms.org/Support/Configuration/#proxy-support>
> <@= config.site_url =@/Support/Configuration/#proxy-support>
# Copy logrotate config

Expand Down Expand Up @@ -226,19 +226,18 @@ site: <https://www.librenms.org/#support>
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).
14 changes: 7 additions & 7 deletions doc/Installation/Installation-Ubuntu-1604-Apache.md
Expand Up @@ -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:
> <https://docs.librenms.org/Support/Configuration/#proxy-support>
> <@= config.site_url =@/Support/Configuration/#proxy-support>
# Copy logrotate config

Expand Down Expand Up @@ -209,19 +209,19 @@ site: <https://www.librenms.org/#support>
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).

0 comments on commit a0062aa

Please sign in to comment.