Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Include additional TURN server example into documentation #14293

Merged
merged 23 commits into from
Nov 14, 2022
Merged

Include additional TURN server example into documentation #14293

merged 23 commits into from
Nov 14, 2022

Conversation

sando38
Copy link
Contributor

@sando38 sando38 commented Oct 25, 2022 •
edited
Loading

Hi friends,

I included an additional TURN server (name: eturnal) configuration example. I was not able to run a linter for the markdown documents for now, but that should not hinder the review.

Just let me know what you think. In case of any questions, let me know.

Cheers,
sando

Pull Request Checklist

  • Pull request is based on the develop branch
  • Pull request includes a changelog file. The entry should:
    • Be a short description of your change which makes sense to users. "Fixed a bug that prevented receiving messages from other servers." instead of "Moved X method from EventStore to EventWorkerStore.".
    • Use markdown where necessary, mostly for code blocks.
    • End with either a period (.) or an exclamation mark (!).
    • Start with a capital letter.
    • Feel free to credit yourself, by adding a sentence "Contributed by @github_username." or "Contributed by [Your Name]." to the end of the entry.
  • Pull request includes a sign off
  • Code style is correct
    (run the linters)

@sando38 sando38 requested a review from a team as a code owner October 25, 2022 19:08
dklimpel
dklimpel reviewed Oct 26, 2022
View reviewed changes
docs/setup/turn/coturn.md Outdated Show resolved Hide resolved
docs/setup/turn/coturn.md Outdated Show resolved Hide resolved
docs/setup/turn/eturnal.md Outdated Show resolved Hide resolved
docs/turn-howto.md Outdated Show resolved Hide resolved
docs/turn-howto.md Outdated Show resolved Hide resolved
reivilibre
reivilibre suggested changes Nov 4, 2022
View reviewed changes
Copy link
Contributor

@reivilibre reivilibre left a comment

Choose a reason for hiding this comment

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

This looks really lovely; it's great to have more options for TURN and I'm sure this will be appreciated as TURN is renowned for being hard to set up properly.

Just a few suggestions/comments otherwise this looks good to me

Obvious but maybe I should ask anyway: have you got it working with these instructions? :)

docs/setup/turn/eturnal.md Show resolved Hide resolved
docs/setup/turn/eturnal.md Outdated Show resolved Hide resolved
docs/setup/turn/eturnal.md Outdated Show resolved Hide resolved
docs/setup/turn/eturnal.md Outdated Show resolved Hide resolved
moritzdietz
moritzdietz suggested changes Nov 5, 2022
View reviewed changes
Copy link
Contributor

@moritzdietz moritzdietz left a comment

Choose a reason for hiding this comment

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

Now that you're already redoing the docs around this, I thought it would be a good idea to give the "old" doc a lookover. As the content of the new coturn.md file is just a transfer of the old turn-howto.md.

docs/setup/turn/coturn.md Outdated Show resolved Hide resolved
docs/setup/turn/coturn.md Outdated Show resolved Hide resolved
docs/setup/turn/coturn.md Outdated Show resolved Hide resolved
docs/setup/turn/coturn.md Outdated Show resolved Hide resolved
docs/setup/turn/coturn.md Outdated Show resolved Hide resolved
docs/setup/turn/coturn.md Outdated Show resolved Hide resolved
Saarko and others added 22 commits November 11, 2022 18:04
@sando38
Include eturnal TURN server configuration example
a09aba1 
and moving specific configuration examples into sub folders.
@sando38 @dklimpel
Update docs/turn-howto.md
a9be337 
Co-authored-by: Dirk Klimpel <5740567+dklimpel@users.noreply.github.com>
@sando38 @dklimpel
Update docs/setup/turn/coturn.md
6a903ec 
Co-authored-by: Dirk Klimpel <5740567+dklimpel@users.noreply.github.com>
@sando38 @dklimpel
Update docs/setup/turn/eturnal.md
ea104f0 
Co-authored-by: Dirk Klimpel <5740567+dklimpel@users.noreply.github.com>
@sando38
Fix TURN relaying public IP address hint
86bac4e
@sando38
lint eturnal installation commands
3f3f925
@sando38
Adjust synapse setup to link to existing documentation
d804d26 
..avoid redundant information.
@sando38
remove redundant text
637c381
@sando38
include alpine linux package link
ee5330c
@sando38
Create 14293.doc
863bdf5
@sando38
Update 14293.doc
40519a0 
add missing dot
@sando38 @reivilibre
Update docs/setup/turn/eturnal.md
f1e309b 
Co-authored-by: reivilibre <olivier@librepush.net>
@sando38 @reivilibre
Update docs/setup/turn/eturnal.md
55e719e 
Co-authored-by: reivilibre <olivier@librepush.net>
@sando38 @moritzdietz
Update docs/setup/turn/coturn.md
0574495 
Co-authored-by: Moritz Dietz <moritzdietz@users.noreply.github.com>
@sando38 @moritzdietz
Update docs/setup/turn/coturn.md
3d0e269 
Co-authored-by: Moritz Dietz <moritzdietz@users.noreply.github.com>
@sando38 @moritzdietz
Update docs/setup/turn/coturn.md
56d4ab2 
Co-authored-by: Moritz Dietz <moritzdietz@users.noreply.github.com>
@sando38 @reivilibre
Update docs/setup/turn/eturnal.md
86cdf8a 
Co-authored-by: reivilibre <olivier@librepush.net>
@sando38 @moritzdietz
Update docs/setup/turn/coturn.md
462ba9c 
Co-authored-by: Moritz Dietz <moritzdietz@users.noreply.github.com>
@sando38 @moritzdietz
Update docs/setup/turn/coturn.md
747c56c 
Co-authored-by: Moritz Dietz <moritzdietz@users.noreply.github.com>
@sando38
Update eturnal.md to link to official documentation
91cbad2 
... and to simplify some aspects
@sando38
Adjust coturn to link to default prefix
90c93c0
@sando38
Mention eturnalctl location
b5c994c
reivilibre
reivilibre approved these changes Nov 14, 2022
View reviewed changes
docs/turn-howto.md Outdated Show resolved Hide resolved
@reivilibre
Copy link
Contributor

This looks really good, thanks!

@reivilibre reivilibre merged commit 64dd8a9 into matrix-org:develop Nov 14, 2022
bradtgmurray added a commit to beeper/synapse-legacy-fork that referenced this pull request Nov 22, 2022
@bradtgmurray
Merge tag 'v1.72.0' into merge-v1.72
844c458 
Synapse 1.72.0 (2022-11-22)
===========================

Please note that Synapse now only supports PostgreSQL 11+, because PostgreSQL 10 has reached end-of-life, c.f. our [Deprecation Policy](https://github.com/matrix-org/synapse/blob/develop/docs/deprecation_policy.md).

Bugfixes
--------

- Update forgotten references to legacy metrics in the included Grafana dashboard. ([\matrix-org#14477](matrix-org#14477))

Synapse 1.72.0rc1 (2022-11-16)
==============================

Features
--------

- Add experimental support for [MSC3912](matrix-org/matrix-spec-proposals#3912): Relation-based redactions. ([\matrix-org#14260](matrix-org#14260))
- Build Debian packages for Ubuntu 22.10 (Kinetic Kudu). ([\matrix-org#14396](matrix-org#14396))
- Add an [Admin API](https://matrix-org.github.io/synapse/latest/usage/administration/admin_api/index.html) endpoint for user lookup based on third-party ID (3PID). Contributed by @ashfame. ([\matrix-org#14405](matrix-org#14405))
- Faster joins: include heroes' membership events in the partial join response, for rooms without a name or canonical alias. ([\matrix-org#14442](matrix-org#14442))

Bugfixes
--------

- Faster joins: do not block creation of or queries for room aliases during the resync. ([\matrix-org#14292](matrix-org#14292))
- Fix a bug introduced in Synapse 1.64.0rc1 which could cause log spam when fetching events from other homeservers. ([\matrix-org#14347](matrix-org#14347))
- Fix a bug introduced in 1.66 which would not send certain pushrules to clients. Contributed by Nico. ([\matrix-org#14356](matrix-org#14356))
- Fix a bug introduced in v1.71.0rc1 where the power level event was incorrectly created during initial room creation. ([\matrix-org#14361](matrix-org#14361))
- Fix the refresh token endpoint to be under /r0 and /v3 instead of /v1. Contributed by Tulir @ Beeper. ([\matrix-org#14364](matrix-org#14364))
- Fix a long-standing bug where Synapse would raise an error when encountering an unrecognised field in a `/sync` filter, instead of ignoring it for forward compatibility. ([\matrix-org#14369](matrix-org#14369))
- Fix a background database update, introduced in Synapse 1.64.0, which could cause poor database performance. ([\matrix-org#14374](matrix-org#14374))
- Fix PostgreSQL sometimes using table scans for queries against the `event_search` table, taking a long time and a large amount of IO. ([\matrix-org#14409](matrix-org#14409))
- Fix rendering of some HTML templates (including emails). Introduced in v1.71.0. ([\matrix-org#14448](matrix-org#14448))
- Fix a bug introduced in Synapse 1.70.0 where the background updates to add non-thread unique indexes on receipts could fail when upgrading from 1.67.0 or earlier. ([\matrix-org#14453](matrix-org#14453))

Updates to the Docker image
---------------------------

- Add all Stream Writer worker types to `configure_workers_and_start.py`. ([\matrix-org#14197](matrix-org#14197))
- Remove references to legacy worker types in the multi-worker Dockerfile. ([\matrix-org#14294](matrix-org#14294))

Improved Documentation
----------------------

- Upload documentation PRs to Netlify. ([\matrix-org#12947](matrix-org#12947), [\matrix-org#14370](matrix-org#14370))
- Add addtional TURN server configuration example based on [eturnal](https://github.com/processone/eturnal) and adjust general TURN server doc structure. ([\matrix-org#14293](matrix-org#14293))
- Add example on how to load balance /sync requests. Contributed by [aceArt](https://aceart.de). ([\matrix-org#14297](matrix-org#14297))
- Edit sample Nginx reverse proxy configuration to use HTTP/1.1. Contributed by Brad Jones. ([\matrix-org#14414](matrix-org#14414))

Deprecations and Removals
-------------------------

- Remove support for PostgreSQL 10. ([\matrix-org#14392](matrix-org#14392), [\matrix-org#14397](matrix-org#14397))

Internal Changes
----------------

- Run unit tests against Python 3.11. ([\matrix-org#13812](matrix-org#13812))
- Add TLS support for generic worker endpoints. ([\matrix-org#14128](matrix-org#14128), [\matrix-org#14455](matrix-org#14455))
- Switch to a maintained action for installing Rust in CI. ([\matrix-org#14313](matrix-org#14313))
- Add override ability to `complement.sh` command line script to request certain types of workers. ([\matrix-org#14324](matrix-org#14324))
- Enabling testing of [MSC3874](matrix-org/matrix-spec-proposals#3874) (filtering of `/messages` by relation type) in complement. ([\matrix-org#14339](matrix-org#14339))
- Concisely log a failure to resolve state due to missing `prev_events`. ([\matrix-org#14346](matrix-org#14346))
- Use a maintained Github action to install Rust. ([\matrix-org#14351](matrix-org#14351))
- Cleanup old worker datastore classes. Contributed by Nick @ Beeper (@Fizzadar). ([\matrix-org#14375](matrix-org#14375))
- Test against PostgreSQL 15 in CI. ([\matrix-org#14394](matrix-org#14394))
- Remove unreachable code. ([\matrix-org#14410](matrix-org#14410))
- Clean-up event persistence code. ([\matrix-org#14411](matrix-org#14411))
- Update docstring to clarify that `get_partial_state_events_batch` does not just give you completely arbitrary partial-state events. ([\matrix-org#14417](matrix-org#14417))
- Fix mypy errors introduced by bumping the locked version of `attrs` and `gitpython`. ([\matrix-org#14433](matrix-org#14433))
- Make Dependabot only bump Rust deps in the lock file. ([\matrix-org#14434](matrix-org#14434))
- Fix an incorrect stub return type for `PushRuleEvaluator.run`. ([\matrix-org#14451](matrix-org#14451))
- Improve performance of `/context` in large rooms. ([\matrix-org#14461](matrix-org#14461))
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@dklimpel dklimpel dklimpel left review comments

@moritzdietz moritzdietz moritzdietz requested changes

@reivilibre reivilibre reivilibre approved these changes

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

Successfully merging this pull request may close these issues.

None yet
4 participants
@sando38 @reivilibre @dklimpel @moritzdietz