diff --git a/docs/source/forward-proxy.rst b/docs/source/forward-proxy.rst index a0d812c..ad3e26a 100644 --- a/docs/source/forward-proxy.rst +++ b/docs/source/forward-proxy.rst @@ -45,6 +45,18 @@ Then, you can follow the steps below to install the plugin: sudo mkdir -p /usr/share/scion/caddy-scion sudo chown -R $USER:$USER /usr/share/scion +- Apply the necessary permissions to the binary: + + .. code-block:: bash + + chmod +x scion-caddy + +- If you intend to configure the proxy to run on well-known ports, add network capabilities to the binary: + + .. code-block:: bash + + sudo setcap 'cap_net_bind_service=+ep' scion-caddy + - Optionally you can create a systemd service and enable it. You can use the example service file ``scion-caddy.service`` in the `examples `__. - You can use the ``forward.json`` file in `examples `__ folder as reference configuration file. @@ -80,6 +92,12 @@ Then, you can follow the steps below to install the plugin: chmod +x scion-caddy +- If you intend to configure the proxy to run on well-known ports, add network capabilities to the binary: + + .. code-block:: bash + + sudo setcap 'cap_net_bind_service=+ep' scion-caddy + - Add a data directory for the plugin to store its data: .. code-block:: bash @@ -177,7 +195,13 @@ For more information, see the `Caddy TLS configuration