Skip to content

SQSERVICES-1504-doc-1-3 #2340

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
May 2, 2022
Merged

SQSERVICES-1504-doc-1-3 #2340

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e40a260
updated docs
battermann Apr 29, 2022
65329fc
changelog
battermann Apr 29, 2022
74bfcf6
Update docs/src/how-to/associate/custom-backend-for-desktop-client.rst
battermann Apr 29, 2022
d7ffc24
little fix
battermann Apr 29, 2022
63b8a5e
linux and additional info
battermann May 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 44 additions & 4 deletions docs/src/how-to/associate/custom-backend-for-desktop-client.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------------
Expand All @@ -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

Expand All @@ -35,8 +38,45 @@ 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:
Copy link
Contributor

@supersven supersven Apr 29, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be good to exactly describe what customWebAppURL and proxyServerURL are. How would I get them as a user or administrator?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

| Consult your site admin to learn what goes into these settings. The value of customWebAppURL can be found here resp. here. The value of proxyServerURL is your browser proxy. It depends on the configuration of the network your client is running in.


.. 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.

Windows
~~~~~~~

Move the ``init.json`` file to ``%APPDATA%\Wire\config\init.json`` if it does not already exist. If it exists 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. If it exists update it accordingly.

Linux
~~~~~

TBD
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this resides at $HOME/.config/Wire/config/init.json.