vyos/vyos-documentation
1
0
Fork 0
mirror of https://github.com/vyos/vyos-documentation.git synced 2025-10-26 08:41:46 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'vyos:equuleus' into equuleus

Browse Source
This commit is contained in:
ekhudiyev 2021-12-13 12:07:55 +04:00 committed by GitHub
commit e81786f258
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 595 additions and 605 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1164
docs/configexamples/autotest/Wireguard/Wireguard.log
View File

File diff suppressed because it is too large Load Diff

17
docs/configexamples/autotest/Wireguard/Wireguard.rst
View File

@ -3,8 +3,9 @@ Wireguard
#########
| Testdate: 2021-11-30
| Testdate: 2021-12-10
| Version: 1.3.0-rc6
| Upgrade Version: 1.4-rolling-202111290926
This simple structure show how to connect two offices. One remote branch and the
@ -46,7 +47,7 @@ After this, the public key can be displayed, to save for later.
vyos@central:~$ generate wireguard default-keypair
vyos@central:~$ show wireguard keypairs pubkey default
EP6GX0Idw+mMlGUtvZheRR4FmYfxjb3a5GPiNVVf9yY=
lDtISsk9LqxSw3WuyU2M7WVltpB/8SAFsdcpNUmvcXY=
After you have each public key. The wireguard interfaces can be setup.
@ -102,11 +103,11 @@ And ping the Branch PC from your central router to check the response.
vyos@central:~$ ping 10.0.2.100 count 4
PING 10.0.2.100 (10.0.2.100) 56(84) bytes of data.
64 bytes from 10.0.2.100: icmp_seq=1 ttl=63 time=0.727 ms
64 bytes from 10.0.2.100: icmp_seq=2 ttl=63 time=0.712 ms
64 bytes from 10.0.2.100: icmp_seq=3 ttl=63 time=0.913 ms
64 bytes from 10.0.2.100: icmp_seq=4 ttl=63 time=0.792 ms
64 bytes from 10.0.2.100: icmp_seq=1 ttl=63 time=0.811 ms
64 bytes from 10.0.2.100: icmp_seq=2 ttl=63 time=0.926 ms
64 bytes from 10.0.2.100: icmp_seq=3 ttl=63 time=0.812 ms
64 bytes from 10.0.2.100: icmp_seq=4 ttl=63 time=0.915 ms
--- 10.0.2.100 ping statistics ---
4 packets transmitted, 4 received, 0% packet loss, time 48ms
rtt min/avg/max/mdev = 0.712/0.786/0.913/0.079 ms
4 packets transmitted, 4 received, 0% packet loss, time 3085ms
rtt min/avg/max/mdev = 0.811/0.866/0.926/0.054 ms

2
docs/configexamples/autotest/Wireguard/_include/branch.conf
View File

@ -7,7 +7,7 @@ set interfaces wireguard wg01 peer central allowed-ips 10.0.1.0/24
set interfaces wireguard wg01 peer central allowed-ips 192.168.0.0/24
set interfaces wireguard wg01 peer central address 198.51.100.1
set interfaces wireguard wg01 peer central port 51820
set interfaces wireguard wg01 peer central pubkey "EP6GX0Idw+mMlGUtvZheRR4FmYfxjb3a5GPiNVVf9yY="
set interfaces wireguard wg01 peer central pubkey "lDtISsk9LqxSw3WuyU2M7WVltpB/8SAFsdcpNUmvcXY="
set interfaces wireguard wg01 port 51820
set protocols static interface-route 10.0.1.0/24 next-hop-interface wg01

2
docs/configexamples/autotest/Wireguard/_include/central.conf
View File

@ -7,7 +7,7 @@ set interfaces wireguard wg01 peer branch allowed-ips 10.0.2.0/24
set interfaces wireguard wg01 peer branch allowed-ips 192.168.0.0/24
set interfaces wireguard wg01 peer branch address 198.51.100.2
set interfaces wireguard wg01 peer branch port 51820
set interfaces wireguard wg01 peer branch pubkey "QjQThdcp2F/pJEXQe4UfOCetML4MMP+aUrUZzjG44xA="
set interfaces wireguard wg01 peer branch pubkey "usqlT92algd21h6Br8SDrPrlptPkArDRSpOY4qo+0zg="
set interfaces wireguard wg01 port 51820
set protocols static interface-route 10.0.2.0/24 next-hop-interface wg01

15
docs/configuration/service/https.rst
View File

@ -4,7 +4,7 @@
HTTP-API
########
VyOS provide a HTTP API. You can use it to execute op-mode commands,
VyOS provides an HTTP API. You can use it to execute op-mode commands,
update VyOS, set or delete config.
Please take a look at the :ref:`vyosapi` page for an detailed how-to.
@ -15,7 +15,7 @@ Configuration
.. cfgcmd:: set service https api keys id <name> key <apikey>
Set an named api key, every key have the same, full permissions
Set a named api key, every key has the same, full permissions
on the system.
.. cfgcmd:: set service https api debug
@ -25,7 +25,7 @@ Configuration
.. cfgcmd:: set service https api port
Set the listen port of the local API, this have non effect of the
Set the listen port of the local API, this has no effect on the
webserver. The default is port 8080
.. cfgcmd:: set service https api strict
@ -46,7 +46,7 @@ Configuration
.. cfgcmd:: set service https api-restrict virtual-host <vhost>
Nginx exposes the local API on all virtual servers, by default
Nginx exposes the local API on all virtual servers, by default.
Use this to restrict nginx to one or more virtual hosts.
.. cfgcmd:: set service https certificates certbot domain-name <text>
@ -71,14 +71,15 @@ Configuration
Example Configuration
*********************
Set an API-KEY is the minimal configuration to get a working API Endpoint.
Setting an API-KEY is the minimal configuration needed to get a working API
Endpoint.
.. code-block:: none
set service https api keys id MY-HTTPS-API-ID key MY-HTTPS-API-PLAINTEXT-KEY
To use this full configuration we asume a publice accessable hostname.
To use this full configuration we asume a globally resolvable hostname.
.. code-block:: none
@ -88,4 +89,4 @@ To use this full configuration we asume a publice accessable hostname.
set service https virtual-host rtr01 listen-address 198.51.100.2
set service https virtual-host rtr01 listen-port 11443
set service https virtual-host rtr01 server-name rtr01.example.com
set service https api-restrict virtual-host rtr01.example.com
set service https api-restrict virtual-host rtr01.example.com