Skip to content

Commit fe425ff

Browse files
authored
update doc forward proxy (#15)
1 parent dd8bc8d commit fe425ff

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

docs/source/forward-proxy.rst

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,18 @@ Then, you can follow the steps below to install the plugin:
4545
sudo mkdir -p /usr/share/scion/caddy-scion
4646
sudo chown -R $USER:$USER /usr/share/scion
4747
48+
- Apply the necessary permissions to the binary:
49+
50+
.. code-block:: bash
51+
52+
chmod +x scion-caddy
53+
54+
- If you intend to configure the proxy to run on well-known ports, add network capabilities to the binary:
55+
56+
.. code-block:: bash
57+
58+
sudo setcap 'cap_net_bind_service=+ep' scion-caddy
59+
4860
- Optionally you can create a systemd service and enable it. You can use the example service file ``scion-caddy.service`` in the `examples <https://github.com/scionproto-contrib/http-proxy/tree/main/_examples>`__.
4961

5062
- You can use the ``forward.json`` file in `examples <https://github.com/scionproto-contrib/http-proxy/blob/main/_examples/scion-caddy-forward-proxy.json>`__ folder as reference configuration file.
@@ -80,6 +92,12 @@ Then, you can follow the steps below to install the plugin:
8092
8193
chmod +x scion-caddy
8294
95+
- If you intend to configure the proxy to run on well-known ports, add network capabilities to the binary:
96+
97+
.. code-block:: bash
98+
99+
sudo setcap 'cap_net_bind_service=+ep' scion-caddy
100+
83101
- Add a data directory for the plugin to store its data:
84102

85103
.. code-block:: bash
@@ -177,7 +195,13 @@ For more information, see the `Caddy TLS configuration <https://caddyserver.com/
177195
Running the SCION HTTP Forward Proxy locally
178196
--------------------------------------------
179197
End users can run the SCION HTTP Forward Proxy locally by following the installation steps above.
180-
To ensure interoperability with their browser navigation, the user is required to add an entry to resolve the configured name for the forward proxy to the local IP address, e.g., by adding the following line to the ``/etc/hosts`` file:
198+
For smooth running experience, grant DAC capabilities to the binary:
199+
200+
.. code-block:: bash
201+
202+
sudo setcap cap_dac_override=+ep scion-caddy
203+
204+
If you do not want to grant those privileges, you can run the binary without them but you will have to manually add the following line to your ``/etc/hosts`` before running the SCION HTTP Forward Proxy:
181205

182206
.. code-block:: bash
183207

0 commit comments

Comments
 (0)