summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/cli.rst3
-rw-r--r--docs/configexamples/autotest/tunnelbroker/_include/vyos-wan_tun0.conf8
-rw-r--r--docs/configexamples/autotest/tunnelbroker/tunnelbroker.rst13
-rw-r--r--docs/configuration/service/ntp.rst8
-rw-r--r--docs/configuration/service/pppoe-server.rst1
5 files changed, 22 insertions, 11 deletions
diff --git a/docs/cli.rst b/docs/cli.rst
index 884971da..79501c66 100644
--- a/docs/cli.rst
+++ b/docs/cli.rst
@@ -872,6 +872,9 @@ be ``config.boot-hostname.YYYYMMDD_HHMMSS``.
* ``tftp://<host>/<dir>``
* ``git+https://<user>:<passwd>@<host>/<path>``
+ Since username and password are part of the URI, they need to be
+ properly url encoded if containing special characters.
+
.. note:: The number of revisions don't affect the commit-archive.
.. note:: You may find VyOS not allowing the secure connection because
diff --git a/docs/configexamples/autotest/tunnelbroker/_include/vyos-wan_tun0.conf b/docs/configexamples/autotest/tunnelbroker/_include/vyos-wan_tun0.conf
index 03889ffd..ab70ccc5 100644
--- a/docs/configexamples/autotest/tunnelbroker/_include/vyos-wan_tun0.conf
+++ b/docs/configexamples/autotest/tunnelbroker/_include/vyos-wan_tun0.conf
@@ -1,8 +1,8 @@
-set interfaces tunnel tun0 address '2001:470:6c:779::2/64' #Tunnelbroker Client IPv6 Address
+set interfaces tunnel tun0 address '2001:470:6c:779::2/64' #Tunnelbroker Client IPv6 address
set interfaces tunnel tun0 description 'HE.NET IPv6 Tunnel'
set interfaces tunnel tun0 encapsulation 'sit'
-set interfaces tunnel tun0 remote '216.66.86.114' #Tunnelbroker Server IPv4 Address
-set interfaces tunnel tun0 source-address '172.29.129.60' # Tunnelbroker Client IPv4 Address or if there is NAT the current WAN interface address
+set interfaces tunnel tun0 remote '216.66.86.114' #Tunnelbroker Server IPv4 address
+set interfaces tunnel tun0 source-address '172.29.129.60' # Tunnelbroker Client IPv4 address. See note below
set protocols static route6 ::/0 interface tun0
@@ -10,4 +10,4 @@ set interface ethernet eth2 address '2001:470:6d:778::1/64' # Tunnelbroker Route
set service router-advert interface eth2 name-server '2001:470:20::2'
set service router-advert interface eth2 prefix 2001:470:6d:778::/64 # Tunnelbroker Routed /64 prefix
-set system name-server 2001:470:20::2 #Tunnelbroker DNS Server \ No newline at end of file
+set system name-server 2001:470:20::2 #Tunnelbroker DNS Server
diff --git a/docs/configexamples/autotest/tunnelbroker/tunnelbroker.rst b/docs/configexamples/autotest/tunnelbroker/tunnelbroker.rst
index 96c2e1af..5bfcb642 100644
--- a/docs/configexamples/autotest/tunnelbroker/tunnelbroker.rst
+++ b/docs/configexamples/autotest/tunnelbroker/tunnelbroker.rst
@@ -48,7 +48,15 @@ Now we are able to setup the tunnel interface.
:language: none
:lines: 1-5
-Setup the ipv6 default route to the tunnel interface
+.. note:: The `source-address` is the Tunnelbroker client IPv4
+ address or if there is NAT the current WAN interface address.
+
+ If `source-address` is dynamic, the tunnel will cease working once
+ the address changes. To avoid having to manually update
+ `source-address` each time the dynamic IP changes, an address of
+ '0.0.0.0' can be specified.
+
+Setup the IPv6 default route to the tunnel interface
.. literalinclude:: _include/vyos-wan_tun0.conf
:language: none
@@ -204,4 +212,5 @@ instead of `set firewall name NAME`, you would use `set firewall ipv6-name
NAME`.
Similarly, to attach the firewall, you would use `set interfaces ethernet eth0
-firewall in ipv6-name` or `et firewall zone LOCAL from WAN firewall ipv6-name`. \ No newline at end of file
+firewall in ipv6-name` or `set firewall zone LOCAL from WAN firewall
+ipv6-name`.
diff --git a/docs/configuration/service/ntp.rst b/docs/configuration/service/ntp.rst
index e7ee392b..266376cf 100644
--- a/docs/configuration/service/ntp.rst
+++ b/docs/configuration/service/ntp.rst
@@ -46,9 +46,9 @@ Configuration
There are 3 default NTP server set. You are able to change them.
- * ``0.pool.ntp.org``
- * ``1.pool.ntp.org``
- * ``2.pool.ntp.org``
+ * ``time1.vyos.net``
+ * ``time2.vyos.net``
+ * ``time3.vyos.net``
.. cfgcmd:: set service ntp server <address> <noselect | nts | pool | prefer>
@@ -85,7 +85,7 @@ Configuration
.. cfgcmd:: set service ntp leap-second [ignore|smear|system|timezone]
- Define how to handle leaf-seonds.
+ Define how to handle leap-seconds.
* `ignore`: No correction is applied to the clock for the leap second. The
clock will be corrected later in normal operation when new measurements are
diff --git a/docs/configuration/service/pppoe-server.rst b/docs/configuration/service/pppoe-server.rst
index b00d941f..d9a16036 100644
--- a/docs/configuration/service/pppoe-server.rst
+++ b/docs/configuration/service/pppoe-server.rst
@@ -24,7 +24,6 @@ Configuring PPPoE Server
set service pppoe-server authentication local-users username test password 'test'
set service pppoe-server client-ip-pool PPPOE-POOL range 192.168.255.2-192.168.255.254
set service pppoe-server default-pool 'PPPOE-POOL'
- set service pppoe-server outside-address 192.0.2.2
set service pppoe-server gateway-address 192.168.255.1
set service pppoe-server interface eth0