dandri/synapse
1
0
Fork 0
mirror of https://github.com/element-hq/synapse.git synced 2026-07-16 18:51:58 +00:00
Code Issues Packages Projects Releases Wiki Activity
24,877 Commits 1,145 Branches 838 Tags
b9b8775db7fe4a46463bed1a2db3c33802db6419
Commit Graph
44 Commits
Author SHA1 Message Date
Andrew MorganGitHubanoa's Codex AgentQuentin Gliech
 		be4c95baf1 Replace PyICU with Rust icu_segmenter crate (#18553) 
Co-authored-by: anoa's Codex Agent <codex@amorgan.xyz>
Co-authored-by: Quentin Gliech <quenting@element.io>
 2025-07-03 11:12:12 +01:00
villepehGitHubQuentin Gliech
 		deb09b3836 Add Oracle Linux installation instructions (#17436) 
### Pull Request Checklist

<!-- Please read
https://element-hq.github.io/synapse/latest/development/contributing_guide.html
before submitting your pull request -->

* [X] Pull request is based on the develop branch
* [X] Pull request includes a [changelog
file](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#changelog).
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.
* [X] [Code
style](https://element-hq.github.io/synapse/latest/code_style.html) is
correct
(run the
[linters](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#run-the-linters))

I forgot the guide applies to Oracle Linux as well. In fact, I ran a
small homeserver on OEL a few months back.

I did minimal installations on Rocky and OEL on VirtualBox and noticed
Codeready/Powertools repos aren't required, so I removed those commands
from the guide. I switched `RHEL`-references to `EL`.

#17423 was merged before I remembered about OEL but a new PR shouldn't
hurt :)

---------

Co-authored-by: Quentin Gliech <quenting@element.io>
 2025-02-10 08:17:26 +00:00
jahway603andGitHub 5da7081197 Update Alpine Linux Synapse Package Maintainer within installation.md (#17846) 
Update Alpine Linux Synapse Package Maintainer within installation.md as
it is outdated.

### Pull Request Checklist

<!-- Please read
https://element-hq.github.io/synapse/latest/development/contributing_guide.html
before submitting your pull request -->

* [x] Pull request is based on the develop branch
* [N/A] Pull request includes a [changelog
file](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#changelog).
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.
* [x] [Code
style](https://element-hq.github.io/synapse/latest/code_style.html) is
correct
(run the
[linters](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#run-the-linters))
 2024-12-10 22:24:03 +00:00
Richard van der HoffandGitHub d72843056b Add some documentation about backing up Synapse (#17931) 
Fixes: https://github.com/element-hq/element-meta/issues/2155
Fixes: https://github.com/element-hq/synapse/issues/2046
 2024-11-18 14:05:49 +00:00
Devon HudsonGitHubAndrew Morgan
 		eda735e4bb Remove support for python 3.8 (#17908) 
### Pull Request Checklist

<!-- Please read
https://element-hq.github.io/synapse/latest/development/contributing_guide.html
before submitting your pull request -->

* [X] Pull request is based on the develop branch
* [X] Pull request includes a [changelog
file](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#changelog).
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.
* [X] [Code
style](https://element-hq.github.io/synapse/latest/code_style.html) is
correct
(run the
[linters](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#run-the-linters))

---------

Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
 2024-11-06 19:36:01 +00:00
Erik JohnstonandGitHub f144b4c7e9 Remove spurious TODO in debian install step (#17749) 
This was a note added in the PR to move to AGPL, which we failed to
remove before landing.

(The context for this was that we needed to decide if we were going to
change which debian repository we published too, but decided not to in
the end)
 2024-09-26 13:18:28 +01:00
villepehandGitHub 342f0c35b7 Add Red Hat Enterprise Linux and Rocky Linux installation instructions (#17423) 
Added RHEL/Rocky install instructions (PyPI). Instructions cover
versions 8 and 9 which are the only supported ones - except for RHEL7
which is now on extended life cycle support phase.

Large part of the guide is for installing Python 3.11 or 3.12. RHEL8
ships with Python 3.6 and RHEL9 ships with 3.9. Newer Python versions
can be installed easily as they don't interfere with OS software that
still relies on the default Python version.

I was first planning to add prerequisites part to the prerequisites
section and then install instructions on the top of the page but that
section is for pre-built packages so it just didn't sound right. So I
just dumped everything to the PyPI section of the page. But suggestions
to change are welcome.

I also didn't combine these with Fedora section. I haven't tested those
packages on RHEL and Fedora ships with Python 3.12 out-of-box.
 2024-07-11 14:02:19 +01:00
devonhandGitHub 0fd6b269d3 Fix various typos in docs (#17114) 
### Pull Request Checklist

<!-- Please read
https://element-hq.github.io/synapse/latest/development/contributing_guide.html
before submitting your pull request -->

* [X] Pull request is based on the develop branch
* [X] Pull request includes a [changelog
file](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#changelog).
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.
* [X] [Code
style](https://element-hq.github.io/synapse/latest/code_style.html) is
correct
(run the
[linters](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#run-the-linters))
 2024-04-26 18:10:45 +00:00
EirikandGitHub 159536d525 Update link, in installation guide, for docker hub synapse images (#17001) 2024-03-21 17:05:52 +00:00
kegsayandGitHub 93edd0932e Update docs for MacOS installs (#16854) 
ICU is an optional dependency and also a pain to install. Mention that
you can just not install it and still get a working installation.
 2024-02-06 09:27:38 +00:00
kegsayandGitHub 505cdd044b Fix broken links on docs (#16853) 
Some links seemed to be incorrect (vector-im/sygnal and vector-im/sytest
have never been A Thing iirc) so pointed them back to matrix-org/*).
 2024-02-06 09:26:55 +00:00
Patrick ClokeandErik Johnston 837391cdbb Update documentation to refer to element-hq. 2023-12-13 15:16:48 +00:00
6543andGitHub 39dc5de399 docs: Link to the Alpine Linux community package for Synapse (#16304) 2023-09-14 14:13:48 +01:00
Patrick ClokeandGitHub 5c8870cb28 Fix-up incorrect spellings in docs. (#16282) 2023-09-08 09:47:36 -04:00
SnipeX_andGitHub 05f8dada8b Fix broken Arch Linux package link (#15981) 2023-07-24 09:06:10 -04:00
Eric EastwoodandGitHub 561d06b481 Remove support for Python 3.7 (#15851) 
Fix https://github.com/matrix-org/synapse/issues/15836
 2023-07-05 18:45:42 -05:00
reivilibreandGitHub f11fe931f5 Document that our Docker images are mirrored to GHCR. (#15282) 
Signed-off-by: Olivier Wilkinson (reivilibre) <oliverw@matrix.org>
 2023-03-21 12:51:03 +01:00
reivilibreandGitHub 4eb2f4e02b Fix broken links in the Synapse documentation. (#14744) 
* Fix stale external links

* Fix some internal links

* Fix URLs without trailing / where needed

* Fix more links

* Newsfile

Signed-off-by: Olivier Wilkinson (reivilibre) <oliverw@matrix.org>

* Reapply docs/openid.md fix after conflict

Signed-off-by: Olivier Wilkinson (reivilibre) <oliverw@matrix.org>
 2023-01-05 18:18:00 +00:00
Sean Quah 43c54ba753 Merge branch 'master' into develop 2022-12-20 18:09:30 +00:00
Mathieu VeltenandGitHub eb2defc2f7 Add release note and update doc regarding ICU (#14712) 
Fixes #14704.

Signed-off-by: Mathieu Velten <mathieuv@matrix.org>
 2022-12-20 16:06:26 +00:00
David RobertsonandGitHub d567a8265f Declare support for Python 3.11 (#14673) 
* Declare support for Python 3.11

* Changelog
 2022-12-13 15:36:27 +00:00
David RobertsonandGitHub 7aefc7e9fc Cite launchpad bug that says ubuntu's pkgs are old (#14517) 
* Cite launchpad bug that says ubuntu's pkgs are old

* Add some cross-references while I'm here

* Changelog
 2022-11-30 18:33:35 +00:00
sando38GitHubSaarkoDirk KlimpelreivilibreMoritz Dietz
 		64dd8a9c6e Include additional TURN server example into documentation (#14293) 
* Include eturnal TURN server configuration example

and moving specific configuration examples into sub folders.

* Update docs/turn-howto.md

Co-authored-by: Dirk Klimpel <5740567+dklimpel@users.noreply.github.com>

* Update docs/setup/turn/coturn.md

Co-authored-by: Dirk Klimpel <5740567+dklimpel@users.noreply.github.com>

* Update docs/setup/turn/eturnal.md

Co-authored-by: Dirk Klimpel <5740567+dklimpel@users.noreply.github.com>

* Fix TURN relaying public IP address hint

* lint eturnal installation commands

* Adjust synapse setup to link to existing documentation

..avoid redundant information.

* remove redundant text

* include alpine linux package link

* Create 14293.doc

* Update 14293.doc

add missing dot

* Update docs/setup/turn/eturnal.md

Co-authored-by: reivilibre <olivier@librepush.net>

* Update docs/setup/turn/eturnal.md

Co-authored-by: reivilibre <olivier@librepush.net>

* Update docs/setup/turn/coturn.md

Co-authored-by: Moritz Dietz <moritzdietz@users.noreply.github.com>

* Update docs/setup/turn/coturn.md

Co-authored-by: Moritz Dietz <moritzdietz@users.noreply.github.com>

* Update docs/setup/turn/coturn.md

Co-authored-by: Moritz Dietz <moritzdietz@users.noreply.github.com>

* Update docs/setup/turn/eturnal.md

Co-authored-by: reivilibre <olivier@librepush.net>

* Update docs/setup/turn/coturn.md

Co-authored-by: Moritz Dietz <moritzdietz@users.noreply.github.com>

* Update docs/setup/turn/coturn.md

Co-authored-by: Moritz Dietz <moritzdietz@users.noreply.github.com>

* Update eturnal.md to link to official documentation

... and to simplify some aspects

* Adjust coturn to link to default prefix

* Mention eturnalctl location

* Update docs/turn-howto.md

Co-authored-by: Saarko <sandomir@tutanotal.com>
Co-authored-by: Dirk Klimpel <5740567+dklimpel@users.noreply.github.com>
Co-authored-by: reivilibre <olivier@librepush.net>
Co-authored-by: Moritz Dietz <moritzdietz@users.noreply.github.com>
 2022-11-14 17:55:10 +00:00
enterpriseyandGitHub f34b0bc262 Update NixOS module URL (#13818) 
* Update NixOS module URL

* Create 13818.doc
 2022-09-26 15:26:59 +01:00
Richard van der HoffandGitHub 41df25bbbd installation.md: require libpq on M1 macs (#13480) 2022-09-13 09:01:21 +00:00
Erik JohnstonandGitHub c9b7e97355 Add a stub Rust crate (#12595) 2022-09-06 19:01:37 +01:00
Richard van der HoffandGitHub c4e29b6908 Improve documentation around user registration (#13640) 
Update a bunch of the documentation for user registration, add some cross
links, etc.
 2022-08-26 13:29:31 +00:00
ShayandGitHub 8330fc9953 Cleanup references to sample config in the docs and redirect users to configuration manual (#13077) 2022-06-30 09:21:39 -07:00
jejo86andGitHub cdc0259449 Document the --report-stats argument (#13029) 
Signed-off-by: jejo86 <28619134+jejo86@users.noreply.github.com>
 2022-06-29 10:24:10 +01:00
Richard van der HoffandGitHub 5d6f55959e Update info on downstream debs (#13095) 2022-06-17 12:47:22 +01:00
ShayandGitHub ec07062e31 Update installation docs to indicate that we support Python 3.10 (#11820) 2022-01-26 16:05:29 -08:00
Richard van der HoffandGitHub 56834ab779 installation.md: drop python 3.6 support (#11781) 
#11595 dropped support for python 3.6, but forgot to update this doc.
 2022-01-20 14:37:11 +00:00
Donny JohnsonGitHubreivilibre
 		0715e77b06 Correct Synapse install command for FreeBSD. (#11267) 
Co-authored-by: reivilibre <olivier@librepush.net>
 2022-01-05 10:38:51 +00:00
reivilibreandGitHub 2fffcb24d8 Suggest using /etc/matrix-synapse/conf.d/ for configuration with Debian packages (#11281) 2021-11-12 13:17:06 +00:00
Sean QuahandGitHub 3ed17ff651 Clarify lack of Windows support in documentation (#11198) 2021-10-29 14:03:58 +01:00
Richard van der HoffandGitHub e32b9f44ee Update installation instructions (#10919) 
Various updates to the install docs.
 2021-09-29 10:57:53 +00:00
AzrenbethandGitHub 54aa7047eb Removed page summaries from the top of installation and contributing doc pages (#10711) 
- Removed page summaries from CONTRIBUTING and installation pages as 
this information was already in the table of contents on the right hand side
- Fixed some broken links in CONTRIBUTING
- Added margin-right tag for when table of contents is being shown
(otherwise the text in the page sometimes overlaps with it)
 2021-08-27 14:19:17 +00:00
Dirk KlimpelandGitHub 339c3918e1 support federation queries through http connect proxy (#10475) 
Signed-off-by: Marcus Hoffmann <bubu@bubu1.eu>
Signed-off-by: Dirk Klimpel dirk@klimpel.org
 2021-08-11 15:34:59 +01:00
Dirk KlimpelandGitHub 834cdc3606 Add documentation for configuring a forward proxy. (#10443) 2021-08-05 07:20:05 -04:00
Luke WalshandGitHub 23a90a6a5c Updating install prerequisites for newer macOS & ARM Macs. (#9971) 2021-07-15 13:18:58 +01:00
Andrew MorganandGitHub c141455049 Docs: Use something other than the document name to describe a page (#10399) 
Our documentation has a history of using a document's name as a way to link to it, such as "See [workers.md]() for details". This makes sense when you're traversing a directory of files, but less sense when the files are abstracted away - as they are on the documentation website.

This PR changes the links to various documentation pages to something that fits better into the surrounding sentence, as you would when making any hyperlink on the web.
 2021-07-15 12:47:55 +01:00
Richard van der HoffandGitHub 28ffff73c1 Instructions on installing RC debs (#10396) 2021-07-14 17:12:01 +01:00
Dirk KlimpelandGitHub 974261cd81 Fix broken links in INSTALL.md (#10331) 
Signed-off-by: Dirk Klimpel dirk@klimpel.org
 2021-07-08 15:46:13 +01:00
Andrew MorganandGitHub fd9856e4a9 Compile and render Synapse's docs into a browsable, mobile-friendly and searchable website (#10086) 2021-06-03 17:20:40 +01:00