diff --git a/docs/source/backends/vpn/openvpn.rst b/docs/source/backends/openvpn.rst similarity index 99% rename from docs/source/backends/vpn/openvpn.rst rename to docs/source/backends/openvpn.rst index daabf10b0..96a428b0b 100644 --- a/docs/source/backends/vpn/openvpn.rst +++ b/docs/source/backends/openvpn.rst @@ -2,7 +2,7 @@ OpenVPN 2.3 Backend =================== -.. include:: /_github.rst +.. include:: ../_github.rst The ``OpenVpn`` backend allows to generate OpenVPN 2.3.x compatible configurations. diff --git a/docs/source/backends/openwrt.rst b/docs/source/backends/openwrt.rst index 3e9c0b0b6..e104a48c1 100644 --- a/docs/source/backends/openwrt.rst +++ b/docs/source/backends/openwrt.rst @@ -2336,33 +2336,39 @@ The following *configuration dictionary*: .. code-block:: python { - "interfaces": [{ - "name": "wg", - "type": "wireguard", - "private_key": "QFdbnuYr7rrF4eONCAs7FhZwP7BXX/jD/jq2LXCpaXI=", - "port": 51820, - "mtu": 1420, - "nohostroute": false, - "fwmark": "", - "ip6prefix": [], - "addresses": [{ - "proto": "static", - "family": "ipv4", - "address": "10.0.0.5/32", - "mask": 32 - }], - "network": "" - }], - "wireguard_peers": [{ - "interface": "wg", - "public_key": "94a+MnZSdzHCzOy5y2K+0+Xe7lQzaa4v7lEiBZ7elVE=", - "allowed_ips": ["10.0.0.1/32"], - "endpoint_host": "wireguard.test.com", - "endpoint_port": 51820, - "preshared_key": "", - "persistent_keepalive": 60, - "route_allowed_ips": true - }] + "interfaces": [ + { + "name": "wg", + "type": "wireguard", + "private_key": "QFdbnuYr7rrF4eONCAs7FhZwP7BXX/jD/jq2LXCpaXI=", + "port": 51820, + "mtu": 1420, + "nohostroute": false, + "fwmark": "", + "ip6prefix": [], + "addresses": [ + { + "proto": "static", + "family": "ipv4", + "address": "10.0.0.5/32", + "mask": 32, + } + ], + "network": "", + } + ], + "wireguard_peers": [ + { + "interface": "wg", + "public_key": "94a+MnZSdzHCzOy5y2K+0+Xe7lQzaa4v7lEiBZ7elVE=", + "allowed_ips": ["10.0.0.1/32"], + "endpoint_host": "wireguard.test.com", + "endpoint_port": 51820, + "preshared_key": "", + "persistent_keepalive": 60, + "route_allowed_ips": true, + } + ] } Will be rendered as follows: @@ -2393,7 +2399,7 @@ VXLAN over WireGuard This backend includes the schema of the ``VXLAN over Wireguard`` backend, inheriting its features. For details regarding the **VXLAN over WireGuard** schema please see -:doc:`VXLAN over WireGuard backend`. +:doc:`VXLAN over WireGuard backend`. Schema additions ~~~~~~~~~~~~~~~~ @@ -2432,47 +2438,54 @@ The following *configuration dictionary*: .. code-block:: python { - "interfaces": [{ - "name": "wgvxlan", - "type": "wireguard", - "private_key": "QFdbnuYr7rrF4eONCAs7FhZwP7BXX/jD/jq2LXCpaXI=", - "port": 51820, - "mtu": 1420, - "nohostroute": false, - "fwmark": "", - "ip6prefix": [], - "addresses": [{ - "proto": "static", - "family": "ipv4", - "address": "10.0.0.5/32", - "mask": 32 - }], - "network": "" - }, { - "name": "vxlan", - "type": "vxlan", - "vtep": "10.0.0.1", - "port": 4789, - "vni": 1, - "tunlink": "wgvxlan", - "rxcsum": true, - "txcsum": true, - "mtu": 1280, - "ttl": 64, - "mac": "", - "disabled": false, - "network": "" - }], - "wireguard_peers": [{ - "interface": "wgvxlan", - "public_key": "94a+MnZSdzHCzOy5y2K+0+Xe7lQzaa4v7lEiBZ7elVE=", - "allowed_ips": ["10.0.0.1/32"], - "endpoint_host": "wireguard.test.com", - "endpoint_port": 51820, - "preshared_key": "", - "persistent_keepalive": 60, - "route_allowed_ips": true - }] + "interfaces": [ + { + "name": "wgvxlan", + "type": "wireguard", + "private_key": "QFdbnuYr7rrF4eONCAs7FhZwP7BXX/jD/jq2LXCpaXI=", + "port": 51820, + "mtu": 1420, + "nohostroute": false, + "fwmark": "", + "ip6prefix": [], + "addresses": [ + { + "proto": "static", + "family": "ipv4", + "address": "10.0.0.5/32", + "mask": 32, + } + ], + "network": "", + }, + { + "name": "vxlan", + "type": "vxlan", + "vtep": "10.0.0.1", + "port": 4789, + "vni": 1, + "tunlink": "wgvxlan", + "rxcsum": true, + "txcsum": true, + "mtu": 1280, + "ttl": 64, + "mac": "", + "disabled": false, + "network": "", + }, + ], + "wireguard_peers": [ + { + "interface": "wgvxlan", + "public_key": "94a+MnZSdzHCzOy5y2K+0+Xe7lQzaa4v7lEiBZ7elVE=", + "allowed_ips": ["10.0.0.1/32"], + "endpoint_host": "wireguard.test.com", + "endpoint_port": 51820, + "preshared_key": "", + "persistent_keepalive": 60, + "route_allowed_ips": true, + } + ] } Will be rendered as follows: diff --git a/docs/source/backends/vpn.rst b/docs/source/backends/vpn.rst index adc3c5b8a..579aa0d52 100644 --- a/docs/source/backends/vpn.rst +++ b/docs/source/backends/vpn.rst @@ -9,6 +9,6 @@ VPN Backends .. toctree:: :maxdepth: 2 - /backends/vpn/openvpn - /backends/vpn/wireguard - /backends/vpn/vxlan_over_wireguard + /backends/openvpn + /backends/wireguard + /backends/vxlan_over_wireguard diff --git a/docs/source/backends/vpn/vxlan_over_wireguard.rst b/docs/source/backends/vxlan_over_wireguard.rst similarity index 97% rename from docs/source/backends/vpn/vxlan_over_wireguard.rst rename to docs/source/backends/vxlan_over_wireguard.rst index c5660a27d..d2a23517a 100644 --- a/docs/source/backends/vpn/vxlan_over_wireguard.rst +++ b/docs/source/backends/vxlan_over_wireguard.rst @@ -2,9 +2,9 @@ VXLAN over WireGuard Backend ============================ -.. include:: /_github.rst +.. include:: ../_github.rst -The ``VXLAN over WireGuard`` backend extends :doc:`Wireguard backend ` +The ``VXLAN over WireGuard`` backend extends :doc:`Wireguard backend ` to add configurations required for VXLAN. Automatic generation of clients diff --git a/docs/source/backends/vpn/wireguard.rst b/docs/source/backends/wireguard.rst similarity index 99% rename from docs/source/backends/vpn/wireguard.rst rename to docs/source/backends/wireguard.rst index ec1182b6f..5601e5f1e 100644 --- a/docs/source/backends/vpn/wireguard.rst +++ b/docs/source/backends/wireguard.rst @@ -2,7 +2,7 @@ WireGuard Backend ================= -.. include:: /_github.rst +.. include:: ../_github.rst The ``WireGuard`` backend allows to generate WireGuard configurations. diff --git a/docs/source/general/basics.rst b/docs/source/general/basics.rst index f3b178d0c..323f55ae3 100644 --- a/docs/source/general/basics.rst +++ b/docs/source/general/basics.rst @@ -102,9 +102,9 @@ The current implemented backends are: * :doc:`OpenWrt ` * :doc:`OpenWisp ` (based on the ``OpenWrt`` backend) - * :doc:`OpenVpn ` (custom backend implementing only OpenVPN configuration) - * :doc:`WireGuard ` (custom backend implementing only WireGuard configuration) - * :doc:`VXLAN over WireGuard ` (custom backend implementing only VXLAN over WireGuard configuration) + * :doc:`OpenVpn ` (custom backend implementing only OpenVPN configuration) + * :doc:`WireGuard ` (custom backend implementing only WireGuard configuration) + * :doc:`VXLAN over WireGuard ` (custom backend implementing only VXLAN over WireGuard configuration) Example initialization of ``OpenWrt`` backend: