Commit graph

60 commits

Author SHA1 Message Date
Erik Johnston
0455c40085 Update book location 2023-12-13 16:15:22 +00:00
Dirk Klimpel
974261cd81
Fix broken links in INSTALL.md ()
Signed-off-by: Dirk Klimpel dirk@klimpel.org
2021-07-08 15:46:13 +01:00
Brendan Abolivier
08c8469322
Remove support for ACME v1 ()
Fixes 

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
Aaron Raimist
f95e7a03fa
Tweak wording of database recommendation in INSTALL.md ()
* Tweak wording of database recommendation in INSTALL.md

Signed-off-by: Aaron Raimist <aaron@raim.ist>
2021-05-26 13:29:02 +01:00
Erik Johnston
a888cbdd31
Add deprecation policy doc ()
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
blakehawkins
7dcf3fd221
Clarify that register_new_matrix_user is present also when installed via non-pip package ()
Signed-off-by: blakehawkins blake.hawkins.11@gmail.com
2021-03-29 17:05:06 +01:00
Serban Constantin
e5801db830
platform specific prerequisites in source install ()
Make it clearer in the source install step that the platform specific
prerequisites must be installed first.

Signed-off-by: Serban Constantin <serban.constantin@gmail.com>
2021-03-25 15:31:26 +00:00
Dan Callahan
5a9cdaa6e9
Update installation instructions on Fedora ()
Signed-off-by: Joseph Arnault <computerdude90042@outlook.com>

Signed-off-by: Dan Callahan <danc@element.io>

Co-authored-by: compu42 <56663749+compu42@users.noreply.github.com>
2021-02-05 14:20:38 +00:00
Eric Eastwood
20af310889
Add some extra notes for getting Synapse running on macOS. () 2021-01-15 06:58:31 -05:00
0xflotus
2fb1c2b6e6
Fix a typo in the install docs. () 2021-01-11 07:42:18 -05:00
Shashank Sabniveesu
b8591899ab
Doc/move database setup instructions in install md () 2020-12-30 11:33:03 +00:00
Patrick Cloke
344ab0b53a
Default to blacklisting reserved IP ranges and add a whitelist. ()
This defaults `ip_range_blacklist` to reserved IP ranges and also adds an
`ip_range_whitelist` setting to override it.
2020-12-09 13:56:06 -05:00
Daniele Sluijters
8ca120df7c
INSTALL: Fix setting content-type on well-known ()
When using `add_header` nginx will literally add a header. If a
`content-type` header is already configured (for example through a
server wide default), this means we end up with 2 content-type headers,
like so:

```
content-type: text/html
content-type: application/json
access-control-allow-origin: *
```

That doesn't make sense. Instead, we want the content type of that
block to only be `application/json` which we can achieve using
`default_type` instead.

Signed-off-by: Daniele Sluijters <daenney@users.noreply.github.com>
2020-11-23 13:01:18 +00:00
Dan Callahan
88e1d0c52b
Note support for Python 3.9 ()
As expected, all tests pass locally without modification.

Signed-off-by: Dan Callahan <danc@element.io>
2020-10-27 23:24:33 +00:00
Patrick Cloke
2aa127c207
Revert pinning of setuptools () 2020-09-03 09:45:36 -04:00
Patrick Cloke
318245eaa6
Do not install setuptools 50.0. ()
This is due to compatibility issues with old Python versions.
2020-09-01 08:16:58 -04:00
Aaron Raimist
2184f61fae
Various improvements to the docs () 2020-07-29 10:35:44 -04:00
Luke Faraone
93c8b077ed
Clearly state built-in ACME no longer works ()
I'm tempted to remove this section entirely, but it's helpful for admins who are trying to figure out why their Synapse is crashing on start with ACME errors.

Signed-off-by: Luke W Faraone <luke@faraone.cc>
2020-07-14 10:49:10 +01:00
Richard van der Hoff
ef5ed5292b Revert "Update the installation docs on apt-transport-https ()"
This reverts commit e0c0129693.

As discussed at
https://github.com/matrix-org/synapse/pull/7801#pullrequestreview-444652786, I
don't think this is an improvement.
2020-07-08 16:57:10 +01:00
Dirk Heinrichs
e0c0129693
Update the installation docs on apt-transport-https ()
* Starting with apt 1.6, https support has moved into the main package and apt-transport-https has become a transitional dummy package.

Signed-off-by: Dirk Heinrichs <dirk.heinrichs@altum.de>
2020-07-08 11:34:13 +01:00
hashashini
91a7c5ff6d
Update OpenBSD installation instructions ()
Synapse was added to the ports tree in Nov, 2019 by Renaud Allard (https://marc.info/?l=openbsd-ports&m=157417848805329).
With the release of OpenBSD 6.7 on May 22, 2020 a pre-compiled binary is available as well.
2020-05-30 17:08:07 +01:00
Andrew Morgan
61bb834364 Merge branch 'master' into develop
* master:
  1.12.1
  Note where bugs were introduced
  1.12.1rc1
  Newsfile
  Rewrite changelog
  Add changelog
  Only import sqlite3 when type checking
  Fix another instance
  Only setdefault for signatures if device has key_json
  Fix starting workers when federation sending not split out.
  Attempt to clarify Python version requirements ()
  Improve the UX of the login fallback when using SSO ()
  Update the wording of the config comment
  Lint
  Changelog
  Regenerate sample config
  Whitelist the login fallback by default for SSO
2020-04-02 16:24:38 +01:00
Richard van der Hoff
e577c5d607
Attempt to clarify Python version requirements ()
In particular, we depend on `typing.TYPE_CHECKING`, which is only present in
3.5.2.

It turns out that Ubuntu Xenial, despite having a package called `python 3
(3.5.1-3)`, actually has python 3.5.2, so I think this is fine.
2020-03-30 13:55:01 +01:00
txt-file
ae219fb411
update debian installation instructions to recommend installing virtualenv instead of python3-virtualenv ()
* change debian package from python3-virtualenv to virtualenv

The virtualenv package is needed for the virtualenv command. The
virtualenv package depends on python3-virtualenv (at least since
debian jessie) so there is no need to specify python3-virtualenv
additionally.

Signed-off-by: Vieno Hakkerinen <vieno@hakkerinen.eu>

* Add changelog

Co-authored-by: Andrew Morgan <andrew@amorgan.xyz>
2020-03-27 15:02:00 +00:00
Andrew Morgan
7bab642707
Various cleanups to INSTALL.md () 2020-03-25 13:56:40 +00:00
Kartikaya Gupta (kats)
e341518f92
Update pre-built package name for FreeBSD (). ()
Signed-off-by: Kartikaya Gupta <kats@trevize.staktrace.com>
2020-03-23 15:31:02 +00:00
Richard von Kellner
6d110ddea4
Update INSTALL.md updated CentOS8 install instructions () 2020-03-17 21:48:23 +00:00
Uday Bansal
e4ffb14d57
Fix last date for ACMEv1 install ()
Support for getting TLS certificates through ACMEv1 ended on November 2019.

Signed-off-by: Uday Bansal <43824981+udaybansal19@users.noreply.github.com>
2020-02-29 23:37:23 +00:00
Andrew Morgan
8f6d9c4cf0
Small grammar fixes to the ACME v1 deprecation notice ()
Some small fixes to the copy in .
2020-02-21 08:53:01 +00:00
Brendan Abolivier
ffe1fc111d
Update INSTALL.md
Co-Authored-By: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
2020-02-13 18:16:48 +00:00
Brendan Abolivier
71cc6bab5f
Update INSTALL.md to recommend reverse proxying and warn about ACMEv1 deprecation 2020-02-13 17:22:44 +00:00
Richard van der Hoff
937dea42e7 update install notes for CentOS 2020-01-09 18:11:04 +00:00
Andrew Morgan
0ad75fd98e
Use python3 packages for Ubuntu () 2019-12-02 15:09:57 +00:00
Matthew Hodgson
9cc168e42e update macOS installation instructions 2019-11-20 18:44:45 +00:00
Richard van der Hoff
c5abb67e43
Python 3.8 for tox ()
... and update INSTALL.md to include py3.8.

We'll also have to update the buildkite pipeline to run it
2019-11-07 17:14:13 +00:00
Andrew Morgan
7e17959984
Update email section of INSTALL.md about account_threepid_delegates () 2019-10-30 11:37:56 +00:00
Brendan Abolivier
baf12bc02a Merge branch 'master' into develop 2019-10-02 14:41:02 +01:00
Pete
a136137b2e Update INSTALL.md with void-linux () 2019-09-19 09:52:59 +01:00
dstipp
379d2a8c39 () Convert rst to markdown ()
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
Aaron Raimist
cee00a3584 Update INSTALL.md to say that Python 2 is no longer supported ()
Signed-off-by: Aaron Raimist <aaron@raim.ist>
2019-09-02 11:27:39 +01:00
Neil Johnson
1016f303e5
make user creation steps clearer 2019-08-08 14:58:21 +01:00
Richard van der Hoff
2d91988799
Improve docs on choosing server_name ()
Fixes 
2019-06-26 15:15:04 +01:00
Neil Johnson
426218323b
Neilj/improve federation docs ()
Add FAQ questions to federate.md. Add a health warning making it clear that the 1711 upgrade FAQ is now out of date.
2019-06-11 12:17:43 +01:00
Neil Johnson
8acde3dc47
remove bloat 2019-06-06 18:00:06 +01:00
Neil Johnson
833c406b9b
Neilj/1.0 upgrade notes ()
1.0 upgrade/install notes
2019-06-06 17:23:02 +01:00
Richard van der Hoff
7ce1f97a13
Stop telling people to install the optional dependencies. ()
* Stop telling people to install the optional dependencies.

They're optional.

Also update the postgres docs a bit for clarity(?)
2019-05-17 12:38:03 +01:00
Richard van der Hoff
84cebb89cc
remove instructions for jessie installation ()
We don't ship jessie packages, so these were a bit misleading.
2019-05-09 22:53:46 +01:00
Richard van der Hoff
3d26eae14a
add gpg key fingerprint 2019-04-22 14:36:51 +01:00
Richard van der Hoff
95c603ae6f
Update debian install docs for new key and repo () 2019-04-17 23:52:00 +01:00
Neil Johnson
ed1ce0333c
convert rst link to md 2019-04-01 12:53:08 +01:00