summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2019-12-29 11:00:16 +0100
committerChristian Poessinger <christian@poessinger.com>2019-12-29 11:01:29 +0100
commit37a891f7cf0499c958eb6bbff5699455a4ada01a (patch)
tree19c8d65a2165a45e9521b352f85c452d7b015c6c /docs
parent3918aefbeeeac4ab9844e3528995ae689a9bd952 (diff)
downloadvyos-documentation-37a891f7cf0499c958eb6bbff5699455a4ada01a.tar.gz
vyos-documentation-37a891f7cf0499c958eb6bbff5699455a4ada01a.zip
provide common-references file
Spinx references used accross different files should be stored here as a single source reference. Include this file as needed by: .. include:: common-references.rst
Diffstat (limited to 'docs')
-rw-r--r--docs/common-references.rst2
-rw-r--r--docs/services/index.rst2
-rw-r--r--docs/services/ipoe-server.rst9
-rw-r--r--docs/services/pppoe-server.rst6
-rw-r--r--docs/services/references.rst11
-rw-r--r--docs/services/snmp.rst6
-rw-r--r--docs/services/sstp-server.rst6
-rw-r--r--docs/services/webproxy.rst5
8 files changed, 19 insertions, 28 deletions
diff --git a/docs/common-references.rst b/docs/common-references.rst
new file mode 100644
index 00000000..9f0b9b84
--- /dev/null
+++ b/docs/common-references.rst
@@ -0,0 +1,2 @@
+.. _`accel-ppp`: https://accel-ppp.org/
+.. _`Secure Socket Tunneling Protocol`: https://en.wikipedia.org/wiki/Secure_Socket_Tunneling_Protocol
diff --git a/docs/services/index.rst b/docs/services/index.rst
index af3e6cb1..e0773090 100644
--- a/docs/services/index.rst
+++ b/docs/services/index.rst
@@ -1,7 +1,5 @@
.. _services:
-.. include:: references.rst
-
########
Services
########
diff --git a/docs/services/ipoe-server.rst b/docs/services/ipoe-server.rst
index 8e3a88eb..a1144301 100644
--- a/docs/services/ipoe-server.rst
+++ b/docs/services/ipoe-server.rst
@@ -4,9 +4,9 @@ IPoE server
VyOS utilizes `accel-ppp`_ to provide IPoE server functionality. It can be
used with local authentication (mac-address) or a connected RADIUS server.
-.. note:: **Please be aware, due to an upstream bug, config changes/commits
+.. note:: Please be aware, due to an upstream bug, config changes/commits
will restart the ppp daemon and will reset existing IPoE sessions,
- in order to become effective.**
+ in order to become effective.
Configuration
^^^^^^^^^^^^^
@@ -123,7 +123,4 @@ The rate-limit is set in kbit/sec.
-------+------------+-------------------+-------------+-----+--------+------------+--------+----------+------------------
ipoe0 | eth2 | 08:00:27:2f:d8:06 | 192.168.0.2 | | | 500/500 | active | 00:00:05 | dccc870fd31349fb
-
-
-
-.. _`accel-ppp`: https://accel-ppp.org/
+.. include:: ../common-references.rst
diff --git a/docs/services/pppoe-server.rst b/docs/services/pppoe-server.rst
index 481831ba..a229d3f9 100644
--- a/docs/services/pppoe-server.rst
+++ b/docs/services/pppoe-server.rst
@@ -7,9 +7,9 @@ PPPoE Server
VyOS utilizes `accel-ppp`_ to provide PPPoE server functionality. It can be
used with local authentication or a connected RADIUS server.
-.. note:: **Please be aware, due to an upstream bug, config changes/commits
+.. note:: Please be aware, due to an upstream bug, config changes/commits
will restart the ppp daemon and will reset existing PPPoE connections from
- connected users, in order to become effective.**
+ connected users, in order to become effective.
Configuration
=============
@@ -241,4 +241,4 @@ subnet for the clients internal use.
--------+----------+-------------+--------------------------+---------------------+-------------------+------------+--------+----------+----------+----------
ppp0 | test | 192.168.0.1 | 2001:db8:8002:0:200::/64 | 2001:db8:8003::1/56 | 00:53:00:12:42:eb | | active | 00:00:49 | 875 B | 2.1 KiB
-.. _`accel-ppp`: https://accel-ppp.org/
+.. include:: ../common-references.rst
diff --git a/docs/services/references.rst b/docs/services/references.rst
deleted file mode 100644
index 704f33f7..00000000
--- a/docs/services/references.rst
+++ /dev/null
@@ -1,11 +0,0 @@
-.. _MIB: https://en.wikipedia.org/wiki/Management_information_base
-.. _SNMP: https://en.wikipedia.org/wiki/Simple_Network_Management_Protocol
-.. _SNMPv2: https://en.wikipedia.org/wiki/Simple_Network_Management_Protocol#Version_2
-.. _SNMPv3: https://en.wikipedia.org/wiki/Simple_Network_Management_Protocol#Version_3
-.. _SSH: https://en.wikipedia.org/wiki/Secure_Shell
-.. _Squid3: http://www.squid-cache.org/
-.. _Squidguard: http://www.squidguard.org/
-.. _TFTP: https://en.wikipedia.org/wiki/Trivial_File_Transfer_Protocol
-.. _`arbitrary extension commands`: http://net-snmp.sourceforge.net/docs/man/snmpd.conf.html#lbAZ
-.. _`accel-ppp`: https://accel-ppp.org/
-.. _`Secure Socket Tunneling Protocol`: https://en.wikipedia.org/wiki/Secure_Socket_Tunneling_Protocol
diff --git a/docs/services/snmp.rst b/docs/services/snmp.rst
index c4b8fa32..c27cf02a 100644
--- a/docs/services/snmp.rst
+++ b/docs/services/snmp.rst
@@ -254,4 +254,8 @@ following content:
</Commands>
</Configuration-Management>
-.. include:: references.rst
+.. _MIB: https://en.wikipedia.org/wiki/Management_information_base
+.. _SNMP: https://en.wikipedia.org/wiki/Simple_Network_Management_Protocol
+.. _SNMPv2: https://en.wikipedia.org/wiki/Simple_Network_Management_Protocol#Version_2
+.. _SNMPv3: https://en.wikipedia.org/wiki/Simple_Network_Management_Protocol#Version_3
+
diff --git a/docs/services/sstp-server.rst b/docs/services/sstp-server.rst
index 64a5206b..8e67b95c 100644
--- a/docs/services/sstp-server.rst
+++ b/docs/services/sstp-server.rst
@@ -6,9 +6,9 @@ SSTP server
VyOS utilizes accel-ppp_ to provide SSTP server functionality. It can be
used with local authentication or a connected RADIUS server.
-.. note:: **Please be aware, due to an upstream bug, config changes/commits
+.. note:: Please be aware, due to an upstream bug, config changes/commits
will restart the ppp daemon and will reset existing PPPoE connections from
- connected users, in order to become effective.**
+ connected users, in order to become effective.
Configuration
^^^^^^^^^^^^^
@@ -73,4 +73,4 @@ looks for all files and directories in ``/config/user-data/sstp``.
set sstp-settings ssl-certs server-cert 'server.crt'
set sstp-settings ssl-certs server-key 'server.key'
-.. include:: references.rst
+.. include:: ../common-references.rst
diff --git a/docs/services/webproxy.rst b/docs/services/webproxy.rst
index b4b20ef5..20e1eb73 100644
--- a/docs/services/webproxy.rst
+++ b/docs/services/webproxy.rst
@@ -3,7 +3,7 @@ Webproxy
The proxy service in VyOS is based on Squid3 and some related modules.
-Squid is a caching and forwarding HTTP web proxy. It has a wide variety of
+Squid3_ is a caching and forwarding HTTP web proxy. It has a wide variety of
uses, including speeding up a web server by caching repeated requests,
caching web, DNS and other computer network lookups for a group of people
sharing network resources, and aiding security by filtering traffic. Although
@@ -149,4 +149,5 @@ So sometimes it is useful to bypass a transparent proxy:
(This can be useful when a called service has many and/or often changing
destination addresses - e.g. Netflix.)
-.. include:: references.rst
+.. _Squid3: http://www.squid-cache.org/
+.. _Squidguard: http://www.squidguard.org/