Jason Robinson
8f6f4e03c1
Fix a few readme links regarding ESS ( #19070 )
...
Didn't add a changelog, is it needed for this?
### 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.
* [ ] [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 ))
2026-09-24 09:58:57 +00:00
Andrew Morgan
daa4398818
Update Element logo to be an absolute URL, so it will render on PyPI ( #19368 )
2026-01-13 12:03:34 +00:00
Erik Johnston
022e56cce3
Move security note from README into the docs ( #19259 )
...
This is a) to simplify the README and b) so that we can easily link to
the security page from e.g. the installation guide.
Follows on from https://github.com/element-hq/synapse/pull/19228
2025-12-02 14:25:12 +00:00
Patrick Maier
a8e5c319ab
Simplify README and add ESS Getting started section ( #19228 )
...
- Add reference to ESS for getting started easily with
Synapse/Matrix/Element
- Remove details on standalone installations and link to the docs
- Other updates like copyright
2025-12-02 11:09:18 +00:00
Andrew Morgan
8f61bdb470
Note optional Element Commecial License in SPDX specifiers ( #18973 )
2025-09-26 12:43:07 +01:00
Strac Consulting Engineers Pty Ltd
86370979d9
Minor improvements to README.rst ( #18700 )
2025-07-30 15:07:10 +01:00
Andrew Ferrazzutti
f2ca2e31f7
Readme tweaks ( #18218 )
2025-05-02 12:11:48 +02:00
Matthew Hodgson
6fe41d2b47
make dual licensing explicit ( #18134 )
...
Update readme & LICENSE files to make it explicit that you can buy a
commercial license as an AGPL alternative from Element.
2025-02-05 13:40:10 +00:00
Jeremy Wright
1b197752b6
Fix minor misspelling in README.rst. ( #17664 )
2024-09-10 17:33:25 +01:00
Will Lewis
3232bc2982
Upload new logo with white bg and update readme to use it ( #17387 )
2024-07-10 14:59:24 +01:00
Hugh Nimmo-Smith
daeaeb2a7b
Fix links in README ( #17379 )
...
I don't think this warrants a changelog?
### 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.
* [ ] [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-07-05 10:34:02 +00:00
Till
b924a8e1a9
Fix uploading packages to PyPi ( #17363 )
...
As per
https://github.com/sphinx-doc/sphinx/issues/3921#issuecomment-315581557 ,
we need double underscores.
Running `rst2html README.rst > /dev/null` found some more warnings.
2024-06-26 18:01:39 +02:00
Andrew Morgan
ef7fbdfebd
Fixes to the table of contents in the README ( #17329 )
2024-06-25 15:20:59 +00:00
Andrew Morgan and Hugh Nimmo-Smith
a412a5829d
Update the README with Element branding and a few fixes ( #17324 )
...
Co-authored-by: Hugh Nimmo-Smith <hughns@element.io >
2024-06-19 10:58:22 +01:00
Erik Johnston
0455c40085
Update book location
2023-12-13 16:15:22 +00:00
Erik Johnston
8613f7693e
More renaming
2023-12-13 15:41:11 +00:00
Erik Johnston
230decd5b8
Revert changes to README
2023-12-13 15:02:08 +00:00
Will Lewis
be65a8ec01
Update README.rst
2023-12-13 14:50:56 +00:00
Will Lewis
66fc265578
Update README.rst
2023-12-13 14:47:34 +00:00
Erik Johnston
70c020b532
Update text
2023-12-12 20:32:48 +00:00
Patrick Cloke
e1f8440c89
Update the README pointing to the Element fork.
2023-12-12 20:28:30 +00:00
Niranjan Kurhade
91aa52c911
Clients link fixed in README ( #16569 )
2023-10-30 16:05:34 +00:00
Matthew Hodgson
ad7fc8e92f
fix grammar
2022-09-03 11:08:28 +01:00
David Robertson
82a0752f32
A first pass at pruning the Synapse README ( #13491 )
2022-08-17 16:46:09 +01:00
Richard van der Hoff
873d467976
Fixes to the formatting of README.rst ( #12627 )
...
Fixes a couple of formatting errors which were introduced in #12475 .
2022-05-04 11:02:19 +01:00
DeepBlueV7.X
629aa51743
Add linebreak to pipx install quote in README ( #12579 )
2022-04-28 13:54:46 +01:00
ecef741add
Recommend poetry in docs ( #12475 )
...
* Recommend poetry in docs
- readme
- contributor guide
- upgrade notes
- new dev cheat sheet for poetry
Co-authored-by: Shay <hillerys@element.io >
Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com >
2022-04-20 15:18:21 +01:00
Dirk Klimpel
fbdee86004
Fix a link in README.rst ( #12495 )
...
* Fix a link in `README.rst`
* newsfile
2022-04-19 13:00:41 +00:00
Patrick Cloke
9a0172d49f
Clean-up demo scripts & documentation ( #12143 )
...
* Rewrites the demo documentation to be clearer, accurate, and moves it to our documentation tree.
* Improvements to the demo scripts:
* `clean.sh` now runs `stop.sh` first to avoid zombie processes.
* Uses more modern Synapse configuration (and removes some obsolete configuration).
* Consistently use the HTTP ports for server name, etc.
* Remove the `demo/etc` directory and place everything into the `demo/808x` directories.
2022-03-08 15:02:59 -05:00
Alexander Mnich
06e5a76322
Fix broken link in README to admin API. ( #11955 )
...
From when the documentation was converted from rst -> md.
2022-02-10 14:18:27 +00:00
reivilibre
5e29d417fc
Include the requirements for [mypy,lint] in [dev] ( #11034 )
2021-10-11 16:34:31 +01:00
Max Kratz
6744273f0b
Remove "reference" wording according Synapse homeserver ( #10971 )
2021-10-06 10:05:07 +00:00
Richard van der Hoff
e32b9f44ee
Update installation instructions ( #10919 )
...
Various updates to the install docs.
2021-09-29 10:57:53 +00:00
David Robertson and Andrew Morgan
46ff99ef95
Advertise matrix-org.github.io/synapse docs ( #10595 )
...
Point to the book where possible, and use hyperlinks to github to refer to files not included in the book.
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com >
2021-08-31 11:29:27 +01:00
Erik Johnston
b5d42377bf
Fix README rst
2021-07-09 11:21:41 +01:00
Erik Johnston
100686a069
Fix README rst
2021-07-09 11:16:50 +01:00
Dirk Klimpel
974261cd81
Fix broken links in INSTALL.md ( #10331 )
...
Signed-off-by: Dirk Klimpel dirk@klimpel.org
2021-07-08 15:46:13 +01:00
Felix Kronlage-Dammers
717f73c411
Adjust the URL in the README.rst file to point to LiberaChat instead of freenode ( #10258 )
2021-06-28 11:07:25 +02:00
Andrew Morgan
7f25d73859
Convert UPGRADE.rst to markdown ( #10166 )
...
This PR:
* Converts UPGRADE.rst to markdown and moves the contents into the `docs/` directory.
* Updates the contents of UPGRADE.rst to point to the website instead.
* Updates links around the codebase that point to UPGRADE.rst.
`pandoc` + some manual editing was used to convert from RST to md.
2021-06-23 16:57:57 +01:00
Brendan Abolivier
08c8469322
Remove support for ACME v1 ( #10194 )
...
Fixes #9778
ACME v1 has been fully decommissioned for existing installs on June 1st 2021(see https://community.letsencrypt.org/t/end-of-life-plan-for-acmev1/88430/27 ), so we can now safely remove it from Synapse.
2021-06-17 18:56:48 +01:00
Eric Eastwood
e21c347332
Document how to see logger output when running the twisted tests ( #10148 )
2021-06-11 09:57:34 +01:00
Denis Kasak
d9f44fd0b9
Clarify security note regarding the domain Synapse is hosted on. ( #9221 )
2021-05-27 11:41:16 +00:00
Andrew Morgan
04819239ba
Add a Synapse Module for configuring presence update routing ( #9491 )
...
At the moment, if you'd like to share presence between local or remote users, those users must be sharing a room together. This isn't always the most convenient or useful situation though.
This PR adds a module to Synapse that will allow deployments to set up extra logic on where presence updates should be routed. The module must implement two methods, `get_users_for_states` and `get_interested_users`. These methods are given presence updates or user IDs and must return information that Synapse will use to grant passing presence updates around.
A method is additionally added to `ModuleApi` which allows triggering a set of users to receive the current, online presence information for all users they are considered interested in. This is the equivalent of that user receiving presence information during an initial sync.
The goal of this module is to be fairly generic and useful for a variety of applications, with hard requirements being:
* Sending state for a specific set or all known users to a defined set of local and remote users.
* The ability to trigger an initial sync for specific users, so they receive all current state.
2021-04-06 14:38:30 +01:00
a888cbdd31
Add deprecation policy doc ( #9723 )
...
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com >
Co-authored-by: Patrick Cloke <clokep@users.noreply.github.com >
2021-04-06 13:07:36 +01:00
Leo Bärring
0fc4eb103a
Update reverse proxy to add OpenBSD relayd example configuration. ( #9508 )
...
Update reverse proxy to add OpenBSD relayd example configuration.
Signed-off-by: Leo Bärring <leo.barring@protonmail.com >
2021-03-06 11:49:19 +00:00
Patrick Cloke
4c37d2acd5
Fix reStructuredText formatting.
2021-01-20 11:10:00 -05:00
Eric Eastwood
20af310889
Add some extra notes for getting Synapse running on macOS. ( #8997 )
2021-01-15 06:58:31 -05:00
Matthew Hodgson
ef0388a648
fix spurious MD in README.rst
2021-01-10 23:40:12 +00:00
Eric Eastwood
a685bbb018
Add link to Synapse dev room to the relevant README section ( #9002 )
2021-01-04 08:59:19 -05:00
chagai95
69147ed158
Updating README.rst ( #8746 )
...
Minor corrections and advice... Should help beginners.
2020-11-13 12:07:09 +00:00