Skip to content
Snippets Groups Projects

Document environment variables, fixes #772

Merged Pea Nut requested to merge document-envs into main
Files
2
+ 15
25
@@ -91,33 +91,23 @@ To force logging:
QT_FORCE_STDERR_LOGGING=1 ./riseup-vpn.exe
We should probably restrict this to non-release versions only.
Ciphersuites and other openvpn params
-------------------------------------
You can specify a custom `openvpn_configuration` block from a local file
(instead of fetching it from `eip-service.json`) via an environment variable:
.. code:: bash
LEAP_OPENVPN_EXTRA_CONFIG=../extra-config.json ./riseup-vpn
Manual Gateway Selection
------------------------
In the same spirit, you can manually override the gateway selection via an
environment variable that contains the hostname of the gateway:
.. code:: bash
LEAP_GW=hostname.riseup.net ./riseup.vpn
Dry run
-------
Environment Variables
~~~~~~~~~~~~~~~~~~~~~
To avoid setting up the routes, you can pass the LEAP_DRYRUN variable:
The envs are only used for debugging and developing. The envs affecting the logging behavior are documented in the logging section in the `README <https://0xacab.org/leap/bitmask-vpn/-/blob/main/README.md?ref_type=heads/>`.
.. code:: bash
- ``SKIP_VERSION_CHECK``: Do not check if there is an update available
- ``LEAP_DRYRUN``: Don't route traffic over VPN (run openvpn with "--pull-filter ignore route" argument) and do not touch firewall rules
- ``MOTD_URL``: Overwrite the MOTD (message of the day) url
- ``SNAP``: If not empty, we expect to be in a Snap environment (client was installed by Snap)
- ``UDP``: If we use UDP, UDP is set to 1. If we use TCP, UDP is set to 0. The value is read by the bitmask-root helper which sets firewall rules on Linux
- ``LEAP_PROVIDER``: Select the provider to use. Must be one of the providers listed in ``gui/providers/providers.json``. File is generated by the Makefile which runs ``./branding/scripts/gen-providers-json``
LEAP_DRYRUN=1 ./riseup.vpn
Only implemented in v3/vpnweb:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
We should probably restrict this to non-release versions only.
- ``LEAP_GW``: Specify the gateway hostname to connect with. It needs to be one of the gateway returned by vpnweb
- ``LEAP_OPENVPN_EXTRA_CONFIG``: Specify a file with extra OpenVPN arguments to use. File should be in json format (in key value format like {"--dev": "tun"} or {"--persist-key": true})
- ``LEAP_KCP``: Enforce the use of KCP in obfsvspn
Loading