719474cae0
Add useful shields to readme ( #8493 )
...
Added shields directing to synapse-dev room, showing license, latest version on PyPi and supported Python versions.
I've moved substitution definitions to the bottom to improve readability.
Signed-off-by: Mateusz Przybyłowicz <uamfhq@gmail.com>
2020-10-08 11:16:56 +01:00
01f82bfe32
Remove docs/sphinx and related references ( #8480 )
...
https://github.com/matrix-org/synapse/tree/develop/docs/sphinx doesn't seem to really be utilised or changed recently since the initial commit. I like the idea of exportable documentation of the codebase, but at the moment after running through the build instructions the generated website wasn't very useful...
2020-10-07 11:45:31 +01:00
2184f61fae
Various improvements to the docs ( #7899 )
2020-07-29 10:35:44 -04:00
ff22672fd6
Reorder database docs to promote postgresql. ( #7933 )
2020-07-23 07:48:49 -04:00
96bb01d8ec
Change Caddy links (old is deprecated) ( #7789 )
...
* Change Caddy links
Current links points to Caddy v1 which is deprecated.
Signed-off-by: Nicolai Søborg <git@xn--sb-lka.org>
2020-07-08 10:09:16 +01:00
1b1489ff18
Fixed typo by adding a 'g' to PostgreSQL ( #7724 )
2020-06-19 07:19:21 -04:00
3e557447cb
Mention #synapse:matrix.org in README troubleshooting ( #7603 )
...
Just in case people head straight to the troubleshooting section and find themselves at a dead end.
2020-06-01 19:45:39 +01:00
cb6fd280af
Add a section about support to the top of the README ( #7392 )
...
Continuation of #7379
Adds a section in the README telling people to go to #synapse:matrix.org instead of using github issues. I'm not entirely sure about placing it above the install section but then people are likely to first seek support when installing (if something goes boom), and it's probably better to have it as high as possible anyway so people actually see it.
2020-05-01 17:27:22 +02:00
a6b32bad77
Make it clearer that #synapse:matrix.org is our support channel ( #7379 )
...
This PR moves the "support is in #synapse:matrix.org" in the bug report template outside of the comment as some people seem to ignore what's in the comments, and phrase it a bit more like the support request template. It also adds a default issue template that says the same thing. It's also adding a notice about the security disclosure to both the default template and the bug report one.
It also adds a badge to the top of the README with an alt text saying about the same message if the badge doesn't load (e.g. if matrix.org is slow).
Fixes #6826
2020-05-01 13:42:35 +02:00
39c2d26e0b
Add quotes around pip install target (my shell complained without them).
2020-02-05 12:53:18 -05:00
7c6b853558
Update reverse proxy file name ( #6590 )
...
s/reverse_proxy.rst/reverse_proxy.md/
2019-12-22 22:16:56 +00:00
baf12bc02a
Merge branch 'master' into develop
2019-10-02 14:41:02 +01:00
379d2a8c39
( #5849 ) Convert rst to markdown ( #6040 )
...
Converting some of the rst documentation to markdown. Attempted to
preserve whitespace and line breaks to minimize cosmetic change.
2019-09-17 12:55:29 +01:00
9eaa5d6d24
README: link to reverse_proxy.rst ( #6027 )
2019-09-12 21:13:31 +01:00
4d122d295c
Correct pep517 flag in readme ( #5651 )
2019-07-10 13:55:24 +01:00
b36de88066
README.rst: fix header level
2019-06-18 18:32:51 +01:00
047486a384
Improve advice regarding poor performance
...
Signed-off-by: Benjamin Saunders <ben.e.saunders@gmail.com>
2019-06-09 15:20:28 -07:00
afe560b072
Add --no-pep-517 to README instructions
2019-04-25 14:54:54 +01:00
332b60ec68
Merge branch 'master' of github.com:matrix-org/synapse into develop
2019-03-12 17:15:21 +00:00
8b692bf7c2
Neilj/improved delegation doc 2 ( #4832 )
...
Improved federation configuration docs. Specifically detailing .well-known and SRV based delegation methods.
Inspiration Valentin Lab <valentin.lab@kalysto.org> for https://github.com/matrix-org/synapse/pull/4781
2019-03-12 14:23:28 +00:00
d3f270f06a
Remove reference to that no longer exists in README
2019-03-04 15:59:43 +00:00
70ea2f4e1d
switch from google.com to recaptcha.net for reCAPTCHA ( #4731 )
...
* add trivial clarification about jemalloc
* switch from google.com to recaptcha.net
because https://developers.google.com/recaptcha/docs/faq#can-i-use-recaptcha-globally
2019-02-25 11:15:36 -08:00
2418b91bb7
README updates ( #4621 )
...
Lots of updates to the README/INSTALL.md.
Fixes #4601 .
2019-02-12 10:53:28 +00:00
c475275926
Clarifications for reverse proxy docs ( #4607 )
...
Factor out the reverse proxy info to a separate file, add some more info on
reverse-proxying the federation port.
2019-02-11 11:44:28 +00:00
ed8b3289ff
Update README
2019-02-05 16:44:31 +00:00
d75e15edce
Re-add link to ACME docs from README
2019-02-05 15:45:00 +00:00
c433d4c4d2
Merge branch 'release-v0.99.0' of github.com:matrix-org/synapse into anoa/self_signed_upgrade
2019-02-05 15:43:26 +00:00
cbdc01cc3b
Convert ACME docs to md
2019-02-05 15:38:27 +00:00
9793bf366e
Add link to ACME docs from README
2019-02-05 15:34:52 +00:00
08b26afeee
Move ACME docs to docs/ACME.rst and link from UPGRADE.
2019-02-05 15:33:23 +00:00
4561f3baa0
Move things from README.rst to UPDATE.md ( #4569 )
...
The readme was getting pretty unmanageable and hard to grok. This is an attempt to simplify things by moving installation instructions from the README to a separate file. I've tried to resist the temptation to fix too much stuff while I'm here - it mostly just copies-and-pastes from one doc to the other, and changes from rst to md syntax.
2019-02-05 13:55:21 +00:00
da6df65e19
Fix nginx capatilization
2019-02-01 16:59:23 +00:00
57164e17da
Address comments
2019-02-01 16:59:06 +00:00
9e89a420e8
Update README.rst
...
Co-Authored-By: anoadragon453 <1342360+anoadragon453@users.noreply.github.com>
2019-02-01 16:54:47 +00:00
897230f634
Update README.rst
...
Co-Authored-By: anoadragon453 <1342360+anoadragon453@users.noreply.github.com>
2019-02-01 16:54:32 +00:00
14de15eaa4
Actually need to enable it
2019-02-01 16:48:07 +00:00
0d70288c59
Address changes
2019-02-01 15:38:09 +00:00
7f914a2dbf
Remove error and add link to foks fed tester project
2019-02-01 15:05:10 +00:00
57fe91f87b
Clean up portions of docs that talk about reversing fed port
2019-02-01 15:05:10 +00:00
a451d960cc
Add docs for ACME setup
2019-02-01 15:05:10 +00:00
35f544410a
update debian installation instructions ( #4526 )
...
* update debian installation instructions
* docs PR is docs
2019-01-31 10:29:15 +00:00
23b0813599
Require ECDH key exchange & remove dh_params ( #4429 )
...
* remove dh_params and set better cipher string
2019-01-22 21:58:50 +11:00
8c818af38e
Merge pull request #4342 from aaronraimist/new-virtualenv
...
Update README to use new virtualenv (#4328 )
2019-01-10 14:59:33 +00:00
dd3bf40152
README.rst: fix hash_password path
2019-01-02 16:36:29 +00:00
37f8bdc1d5
Update README to not lie about required restart ( #4343 )
...
* Update README to not lie about required restart
Signed-off-by: Aaron Raimist <aaron@raim.ist>
* Add changelog
Signed-off-by: Aaron Raimist <aaron@raim.ist>
2019-01-02 16:32:37 +00:00
0e62fcd0eb
Update README to use new virtualenv ( #4328 )
...
Signed-off-by: Aaron Raimist <aaron@raim.ist>
2019-01-01 15:27:28 -06:00
c26f49a664
Make the dependencies more like a standard Python project and hook up the optional dependencies to setuptools ( #4298 )
2018-12-22 01:37:26 +11:00
df96177ca7
Stop installing Matrix Console by default
...
This is based on the work done by @krombel in #2601 .
2018-12-11 13:20:33 +00:00
4acd1a3549
Notes on upgrading to python3, and README updates.
2018-12-04 12:28:24 +00:00
dd27e47b5c
Merge pull request #4210 from axelsimon/patch-1
...
Replace mentions of Vector with Riot
2018-12-04 12:08:07 +01:00
Mateusz Przybyłowicz