diff --git a/changelog.d/4-docs/pr-2340 b/changelog.d/4-docs/pr-2340 new file mode 100644 index 0000000000..7f1779d556 --- /dev/null +++ b/changelog.d/4-docs/pr-2340 @@ -0,0 +1 @@ +Documentation on how to set the instance connection parameters and proxy settings diff --git a/docs/src/how-to/associate/custom-backend-for-desktop-client.rst b/docs/src/how-to/associate/custom-backend-for-desktop-client.rst index 9275f5df38..c13850e7b7 100644 --- a/docs/src/how-to/associate/custom-backend-for-desktop-client.rst +++ b/docs/src/how-to/associate/custom-backend-for-desktop-client.rst @@ -4,7 +4,7 @@ How to connect the desktop application to a custom backend Introduction ------------ -This page explains how to connect the Wire desktop client to a custom Backend. +This page explains how to connect the Wire desktop client to a custom Backend, which can be done either via a start-up parameter or via an initialization file. Prerequisites -------------- @@ -15,15 +15,18 @@ Have a running Wire backend in your infrastructure/cloud. Note down the full URL of the webapp served by that backend (e.g. https://app.custom-wire.com ) +Using start-up parameters +------------------------- + Windows -------- +~~~~~~~ - Create a shortcut to the Wire application - Edit the shortcut ( Right click > Properties ) - Add the following command line parameters to the shortcut: `--env {URL}`, where `{URL}` is the URL of your webapp as noted down above MacOS ------ +~~~~~ To create the application @@ -35,8 +38,53 @@ To create the application - To run the application: Just open the application you created in the first step Linux ------ +~~~~~ - Open a Terminal - Start the application with the command line arguments: `--env {URL}`, where `{URL}` is the URL of your webapp as noted down above +Using an initialization file +---------------------------- + +By providing an initialization file the instance connection parameters plus proxy settings for the Wire desktop application can be pre-configured. This requires Wire version >= 3.27. + +Create a file named ``init.json`` and set ``customWebAppURL`` and ``proxyServerURL`` e.g. as follows: + +.. code-block:: json + + { + "customWebAppURL": "https://app.custom-wire.com", + "env": "CUSTOM", + "proxyServerURL": "http://127.0.0.1:3128", + } + +The ``env`` setting must be set to ``CUSTOM`` for this to work. + +.. note:: + + Consult your site admin to learn what goes into these settings. The value of ``customWebAppURL`` can be found `here `_ or `resp. here `_. The value of ``proxyServerURL`` is your browser proxy. It depends on the configuration of the network your client is running in. + +Windows +~~~~~~~ + +Move the ``init.json`` file to ``%APPDATA%\Wire\config\init.json`` if it does not already exist. Otherwise update it accordingly. + +MacOS +~~~~~ + +Move the ``init.json`` file to + +:: + + ~/Library/Containers/com.wearezeta.zclient.mac/Data/Library/Application\ Support/Wire/config/init.json + +if it does not already exist. Otherwise, update it accordingly. + +Linux +~~~~~ + +On Linux the ``init.json`` file should be located in the following directory: + +:: + + $HOME/.config/Wire/config/init.json