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

Jump to bottom
Merged
merged 5 commits into from
May 2, 2022
Merged

SQSERVICES-1504-doc-1-3 #2340

merged 5 commits into from
May 2, 2022

Conversation

battermann
Copy link
Contributor

@battermann battermann commented Apr 29, 2022 •
edited
Loading

@battermann battermann temporarily deployed to cachix April 29, 2022 12:53 Inactive
@battermann battermann temporarily deployed to cachix April 29, 2022 12:55 Inactive
@battermann battermann changed the title updated docs SQSERVICES-1504-doc-1-3 Apr 29, 2022
@battermann
Copy link
Contributor Author

I am not completely sure on this documentation. I put it together from ticket description and comments. Also, I found nothing on how to configure this for linux. Please review this carefully and feel free to push updates @mythsunwind

supersven
supersven approved these changes Apr 29, 2022
View reviewed changes
Copy link
Contributor

@supersven supersven left a comment

Choose a reason for hiding this comment

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

Thanks a lot for writing this up! Yesterday, Paul had questions about exactly this topic ... So, it'll be useful 😄

Only two smaller remarks.

docs/src/how-to/associate/custom-backend-for-desktop-client.rst

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.

@battermann battermann temporarily deployed to cachix April 29, 2022 13:05 Inactive
@supersven
Copy link
Contributor

I am not completely sure on this documentation. I put it together from ticket description and comments. Also, I found nothing on how to configure this for linux. Please review this carefully and feel free to push updates @mythsunwind

Ups, I saw your comment too late. In this case please ignore my approval. I've only checked if the text is reasonable, not that the described procedure really works.

@battermann battermann temporarily deployed to cachix April 29, 2022 13:07 Inactive
@battermann battermann requested review from comawill and fisx May 2, 2022 07:20
fisx
fisx approved these changes May 2, 2022
View reviewed changes
Copy link
Contributor

@fisx fisx left a comment

Choose a reason for hiding this comment

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

I added a few details, but I'm sure this is correct! :)

docs/src/how-to/associate/custom-backend-for-desktop-client.rst Outdated
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.

docs/src/how-to/associate/custom-backend-for-desktop-client.rst

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

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.

@battermann battermann temporarily deployed to cachix May 2, 2022 08:40 Inactive
@battermann battermann merged commit 53a0cb1 into develop May 2, 2022
@battermann battermann deleted the SQSERVICES-1504-doc-1-3 branch May 2, 2022 08:45
@zebot zebot mentioned this pull request May 4, 2022
Merged
@zebot zebot mentioned this pull request May 18, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@supersven supersven supersven approved these changes

@fisx fisx fisx approved these changes

@comawill comawill Awaiting requested review from comawill

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@battermann @supersven @fisx