diff --git a/docs/setups-description.md b/docs/setups-description.md index 85c0ca2040bef8ef751ea7f1b60d3d892462388f..f7e0841b5a514b40e3120f3a8f6d8a88f687efd3 100644 --- a/docs/setups-description.md +++ b/docs/setups-description.md @@ -93,18 +93,30 @@ Additional options can be used to facilite the usage (such as multiplexed connec ### Web proxy -Using a proxy auto-connect (PAC) file will allow you to set up tunnels such that you can easily access web resources on the technical network or GPN from outside the GPN (or, if not connected to the technical network, from the GPN). -If you do this, you won't have to individually forward specific ports and then access them via `localhost:<port>`, instead you simply point your browser to the real URL and the proxy you set up with the dynamic forward ensures that the request makes it to the correct machine. -The file [located here](p5.pac) will assume that you have set up the ports as in the examples above. -If not, you should ensure that the port forwards you use match the rules in the PAC file. - -Enabling this in `firefox` is done via the "Preferences" menu. -Inside of "Preferences" menu is an area for "Network settings" click on the "Settings..." button and click on "Automatic proxy configuration URL". -In the text box you can add [this link](p5.pac) or if you customize the PAC file for your environment you can specify the local path on your computer with `file:///path/to/pac/file`. -To enable on a browser that is not Firefox, look up instructions for how to add a "Automatic proxy configuration URL" and add the path to the PAC file there. -It can also be enabled system wide on your linux machine, but the setup is different depending on your exact configuration. -Setup on Mac can be done either through the browser or through the network settings. -Setup on Windows is an exercise left for the reader. +Using a proxy auto-connect (PAC) file will allow you to set up tunnels such +that you can easily access web resources on the CMS network or GPN from outside +the respective network. If you do this, you won't have to individually forward +specific ports and then access them via `localhost:<port>`. Instead you simply +point your browser to the real URL and the proxy you set up with the SSH +dynamic port forwarding (a.k.a. SOCKS proxy) ensures that the request makes it +to the correct machine. The file [located here](p5.pac) will assume that you +have set up the ports as in the examples above. If not, you should ensure that +the port forwards you use match the rules in the PAC file. + +Enabling this in `firefox` is done via the "Preferences" menu. Inside of +"Preferences" menu is an area for "Network settings" click on the "Settings..." +button and click on "Automatic proxy configuration URL". In the text box you +can you can specify the path to a local copy of the PAC file on your computer +with `file:///path/to/pac/file`. Using a direct link the the PAC file may also +work, but is **not recommended** since the provided URL may not be stable over +time. + +To enable on a browser that is not Firefox, look up instructions for how to add +an "Automatic proxy configuration URL" and add the path to the PAC file there. +It can also be enabled system wide on your Linux machine, but the setup is +different depending on your exact configuration. Setup on Mac can be done +either through the browser or through the network settings. Setup on Windows is +an exercise left for the reader. !!! important In order to use the proxy, first enable an SSH tunnel: