Neil Johnson
16aeb41547
Update README.rst
...
update docker hub url
2018-03-28 16:47:56 +01:00
Jeremy Cline
4102468da9
Note that Synapse is available in Fedora
...
Signed-off-by: Jeremy Cline <jeremy@jcline.org>
2018-01-16 16:14:02 -05:00
Richard van der Hoff
5b527d7ee1
Merge pull request #2674 from her001/readme-sytest
...
Mention SyTest in the README, after Development
2018-01-16 13:18:17 +00:00
Vincent Breitmoser
9419bb5776
mention federation tester more prominently in the readme
2017-12-16 22:09:53 +02:00
Andrew Conrad
053ecae4db
Mention SyTest in the README, after Development
...
Signed-off-by: Andrew Conrad <aconrad103@gmail.com>
2017-11-14 15:11:35 -06:00
Matthew Hodgson
92f680889d
spell out need for libxml2 for lxml to work
2017-10-27 00:02:29 +01:00
Max Dor
e591f7b3f0
Include review feedback
2017-09-25 16:42:26 +02:00
Max Dor
7141f1a5cc
Clarify recommended network setup
2017-09-25 16:20:23 +02:00
Erik Johnston
7afb4e3f54
Update README
2017-07-04 10:00:52 +01:00
Matthew Hodgson
ba502fb89a
add notes on running out of FDs
2017-06-14 02:23:14 +01:00
Erik Johnston
3accee1a8c
Merge branch 'release-v0.21.0' of github.com:matrix-org/synapse
2017-05-18 13:54:27 +01:00
Erik Johnston
bb9246e525
Merge pull request #2131 from matthewjwolff/develop
...
web_client_location documentation fix
2017-04-27 15:46:40 +01:00
Matthew Hodgson
94f36b0273
document how to make IPv6 work ( #2088 )
...
* document how to make IPv6 work
* spell out that pip will install 17.1 by default
2017-04-25 18:37:12 +01:00
Bruno Bigras
51fb884c52
Fix the system requirements list in README.rst
2017-04-19 17:32:00 -04:00
Matthew Hodgson
c02b6a37d6
Merge pull request #2132 from feld/patch-1
...
Update README.rst
2017-04-17 16:18:34 +01:00
Mark Felder
814fb032eb
Update README.rst
...
The FreeBSD port has been moved to the net-im category
2017-04-17 08:26:50 -05:00
Matthew Wolff
8e780b113d
web_server_root documentation fix
...
Signed-off-by: Matthew Wolff <matthewjwolff@gmail.com>
2017-04-17 00:49:11 -05:00
Erik Johnston
ec039e6790
Merge pull request #1984 from RyanBreaker/patch-1
...
Add missing package to CentOS section
2017-03-31 14:39:32 +01:00
Richard van der Hoff
276af7b59b
Merge pull request #2037 from ricco386/fix_readme_centos_issues
...
Fix installation issues
2017-03-29 08:52:39 +02:00
Richard van der Hoff
59358cd3e7
Merge pull request #2005 from kfatehi/docs/readme
...
Update README: specify python2.7 in virtualenv
2017-03-23 09:32:10 +00:00
Richard Kellner
8d1dd7eb30
Removed requirement that is not needed
...
I have removed libsodium from CentOS system requirements, as it is
part PyNaCl.
Signed-off-by: Richard Kellner <richard.kellner@gmail.com>
2017-03-22 22:49:32 +01:00
Richard Kellner
a188056364
Updated user creation section
...
register_new_matrix_user command has one more question, I have updated
the documentation to match the reality.
2017-03-20 19:58:24 +01:00
Richard Kellner
961e242aaf
Added missing system requiremnt and pip upgrade before install
...
When installing on CentOS7 I wans't able to follow README instructions to
install due to errors. I was missing libsodium in order to compile
python dependencies.
Default version of Python pip is really old and therefore setuptools
upgrade ended with error as well. In order to be able to continue I
needed to upgrade pip as well.
2017-03-20 19:57:28 +01:00
Erik Johnston
e0e214556a
Merge branch 'release-v0.19.3' of github.com:matrix-org/synapse
2017-03-20 17:25:41 +00:00
Stefan Majewsky
be20243549
README.md: fix link to client list on matrix.org/docs
2017-03-18 17:16:12 +01:00
Keyvan Fatehi
9adf1991ca
Update README: specify python2.7 in virtualenv
...
Signed-off-by: Keyvan Fatehi <keyvanfatehi@gmail.com>
2017-03-16 16:37:14 -07:00
Ryan Breaker
a175963ba5
Add --upgrade pip
...
Needed before `pip instal --upgrade setuptools` for CentOS 7 and also doesn't hurt for any other distro.
2017-03-13 14:05:31 -05:00
Ryan Breaker
53254551f0
Add missing package to CentOS section
...
Also added Fedora 25 to header as the same packages work for it as well.
2017-03-10 22:09:22 -06:00
Sean Enck
c80439a320
the aur package is no longer there, community package in arch does exist
2017-02-27 10:06:15 -05:00
Richard van der Hoff
6f5e41e420
README.rst: fix formatting
...
Fix formatting blooper introduced in https://github.com/matrix-org/synapse/pull/1672 :/
2017-01-13 12:52:11 +00:00
Johannes Löthberg
1859af9b2a
Update README to use bind_addresses
...
Signed-off-by: Johannes Löthberg <johannes@kyriasis.com>
2016-12-18 22:01:34 +01:00
manuroe
8bb8cc993a
Update prerequisites instructions on Mac OS
2016-12-15 15:30:59 +01:00
Richard van der Hoff
9240948346
Merge remote-tracking branch 'origin/master' into develop
2016-12-12 11:46:46 +00:00
Richard van der Hoff
1233d244ff
fix pythonpath
2016-12-09 17:52:51 +00:00
Richard van der Hoff
2fda8134f1
Update the readme to use trial
2016-12-09 17:15:38 +00:00
Richard van der Hoff
4a9c38bfa3
Fix broken README merge
...
When 546ec1a
was merged into develop, I accidentally overwrote the change
introduced in debbea5
(pr #1657 ). Reintroduce it.
2016-12-09 16:05:12 +00:00
William Leuschner
59bc64328f
Fix incorrect numbering on OpenBSD instructions caused by my own incompetence
...
Signed-off-by: William Leuschner <wel2138@rit.edu>
2016-12-06 11:31:17 -05:00
William Leuschner
39a76b9cba
Update incorrect information in README about ksh and source
...
Signed-off-by: William Leuschner <wel2138@rit.edu>
2016-12-06 11:09:31 -05:00
William Leuschner
12aefb9dfc
Add README instructions for OpenBSD installation
...
Signed-off-by: William Leuschner <wel2138@rit.edu>
2016-12-05 14:16:39 -05:00
Richard van der Hoff
a2849a18a5
README: fix link
2016-12-03 13:18:27 +00:00
Richard van der Hoff
9df84dd22d
README: review comments
...
Minor updates post-review
2016-12-02 17:17:15 +00:00
Richard van der Hoff
3f23154088
README: rewrite federation section
2016-12-02 12:02:33 +00:00
Richard van der Hoff
f6270a8fe2
README: add reverse-proxying section
2016-12-02 12:02:33 +00:00
Richard van der Hoff
235407a78e
README: Rewrite "Identity servers" section
2016-12-02 12:02:33 +00:00
Richard van der Hoff
77bf92e3c6
README: rewrite installation instructions
2016-12-02 12:02:33 +00:00
Richard van der Hoff
bb3d0c270d
README: remove refs to demo client
...
The demo client isn't really fit for purpose, so stop encouraging people to use
it.
2016-12-02 11:54:59 +00:00
Richard van der Hoff
f8c45d428c
README: code quotes
...
Add some syntax highlighting
2016-12-02 11:47:55 +00:00
Richard van der Hoff
153535fc56
README: "About matrix" updates
...
- remove redundant "where's the spec" section: this would belong in "About
matrix", but it's already there.
- E2E is in beta rather than dev
2016-12-02 11:46:00 +00:00
Richard van der Hoff
a8d8225ead
README: Fix links
...
Fix a couple of broken links
2016-12-02 11:43:10 +00:00
Richard van der Hoff
cc03f4c58b
Rearrange the README
...
Move some bits of the README around. No words were changed in the making of
this commit.
2016-12-02 11:42:59 +00:00
Richard van der Hoff
971edd04af
rename CAPTCHA_SETUP
...
this is rst so name it accordingly
2016-12-01 12:08:03 +00:00
Erik Johnston
1b91ff685f
Merge pull request #1053 from Takios/develop
...
Add prerequisites to install on openSUSE to README
2016-08-31 16:00:02 +01:00
Matthew Hodgson
928d337c16
Remove FUD over psql
2016-08-30 15:33:13 +01:00
Fabian Niepelt
b3be9e4376
Add prerequisites to install on openSUSE to README
...
Signed-off-by: Fabian Niepelt <fniepelt@takios.de>
2016-08-30 15:03:03 +02:00
Matthew Hodgson
5acbe09b67
warn people to avoid running a HS media repository on the same domain as another webapp
2016-08-27 00:20:39 +01:00
Matthew Hodgson
d77ef276fa
increase RAM reqs
2016-08-19 18:55:25 +01:00
Erik Johnston
d330d45e2d
Merge branch 'release-v0.17.0' of github.com:matrix-org/synapse
2016-08-08 13:38:13 +01:00
evelynmitchell
e8d212d92e
3PID defined on first mention
2016-07-27 12:20:46 -06:00
Matthew Hodgson
1a54513cf1
federation doesn't work over ipv6 yet thanks to twisted
2016-07-26 10:09:37 +02:00
Erik Johnston
ba0406d10d
Merge branch 'release-v0.16.0' of github.com:matrix-org/synapse
2016-06-09 14:21:23 +01:00
Jimmy Cuadra
8b5dbee47e
Alter phrasing to clarify where info is stored.
...
A user on #matrix:matrix.org was confused by the phrasing of the first
sentence in the paragraph and couldn't tell whether it was saying that
the homeserver stored the data or the clients did. This change splits it
into two sentences to make the subject of each sentence clear.
2016-05-29 02:31:56 -07:00
David
1b45e6a9bc
Fix Typo in README.rst s/Halp/Help/
2016-05-06 02:07:59 +08:00
Matthew Hodgson
b04f81284a
Add more doc
2016-04-08 18:55:27 +01:00
Matthew Hodgson
ec9331f851
Add doc
2016-04-08 18:54:18 +01:00
Matthew Hodgson
7178ab7da0
spell out more packages
2016-03-30 17:29:22 +01:00
Richard van der Hoff
660ae8e0f3
Clarify that we do have reset functionality via the IS
2016-03-16 10:40:38 +00:00
Richard van der Hoff
a877209c8b
Password reset docs and script
...
Replace the bash/perl gen_password script with a python one, and write a note
on how to use it.
2016-03-16 09:45:37 +00:00
Erik Johnston
dda2058d90
Add SYNAPSE_CACHE_FACTOR to README
2016-03-02 14:03:10 +00:00
Florent VIOLLEAU
97b364cb25
Update documentation
...
Signed-off-by: Florent VIOLLEAU <floviolleau@gmail.com>
2016-01-27 14:11:05 +01:00
Richard van der Hoff
430d3d74f6
Merge branch 'release-v0.12.1' into develop
2016-01-14 11:17:47 +00:00
Kubilay Kocak
a8cd1eb996
Add FreeBSD install section & instructions
...
Add FreeBSD installation instructions for both Ports and Packages now that matrix-synapse has landed [1] in the tree.
[1] https://svnweb.freebsd.org/changeset/ports/405527
2016-01-09 04:36:22 +11:00
Erik Johnston
8ce5679813
Update readme to reflect change in signing key name
2016-01-06 11:19:51 +00:00
Mark Haines
f35f8d06ea
Merge remote-tracking branch 'origin/release-v0.12.0'
2016-01-04 14:02:50 +00:00
Oddvar Lovaas
d3ac8fd87d
Added info abou Martin Giess' auto-deployment process with vagrant/ansible
2015-12-14 15:27:27 +00:00
Mark Haines
5a3e4e43d8
SYN-90: We don't need --proccess-dependency-links
...
When installing synapse since all its dependencies are on PyPI
2015-12-11 14:39:46 +00:00
Erik Johnston
03b2a6a8aa
Merge pull request #409 from MadsRC/develop
...
Develop
2015-12-02 10:08:18 +00:00
Mads R. Christensen
3d5c5e8be5
Added a few lines to better explain how to run Synapse on a FQDN that is not part of the UserID
2015-12-02 00:35:45 +01:00
Matthew Hodgson
65a9bf2dd5
various fixes - thanks to Mark White for pointing out you need to run synapse before you try to register a new user
2015-12-01 23:05:12 +00:00
Mads R. Christensen
98ee629d00
Added --report-status=yes|no as Synapse won't generate the config without it
2015-12-01 20:20:53 +01:00
Mads R. Christensen
c533f69d38
Added libffi-devel in CentOS 7 installation requirements and fixed indentation of yum groupinstall. Signed-off-by: Mads Robin Christensen <mads@v42.dk>
2015-12-01 20:00:41 +01:00
Mads R. Christensen
d7739c4e37
Added prerequisite instructions for CentOS 7
...
Signed-off-by: Mads Robin Christensen <mads@v42.dk>
2015-11-20 22:37:23 +01:00
Oddvar Lovaas
2fcd9819ac
Erik pointed out we should advise on the lack of included client
2015-11-18 16:51:26 +00:00
Oddvar Lovaas
8bae98b314
adding link to apt repo
2015-11-18 11:44:35 +00:00
Matthew Hodgson
0da4b11efb
remove references to matrix.org/beta
2015-11-06 11:00:06 +01:00
Mark Haines
3ead04ceef
Add instructions for upgrading setuptools for when people encounter a message "mock requires setuptools>=17.1"
2015-09-07 14:57:00 +01:00
Erik Johnston
aaf319820a
Update README to include RAM requirements
2015-09-02 17:16:39 +01:00
Mark Haines
d5c31e01f2
Merge pull request #237 from matrix-org/markjh/readme-rst-formatting
...
Clean up some of restructured text formatting in the README.rst
2015-08-20 16:08:17 +01:00
Mark Haines
8a951540f6
Further formatting clean ups
2015-08-20 15:22:26 +01:00
Mark Haines
482648123f
Clean up some of restructured text formatting in the README.rst
2015-08-20 15:20:07 +01:00
Mark Haines
bb9611bd46
Add generic update instructions to UPGRADE.rst and add link to them from the README.rst
2015-08-20 15:08:18 +01:00
Matthew Hodgson
c772dffc9f
improve OS X instructions and remove all the leading $'s to make it easier to c+p commands
2015-07-29 09:39:55 +01:00
Matthew Hodgson
11374a77ef
clarify readme a bit more
2015-06-27 16:59:47 +02:00
David Baker
47fb089eb5
Specify python 2.7 in the virtualenv setup (SYN-319) #resolved
2015-05-14 10:23:10 +01:00
Mark Haines
4ad8350607
Update README.rst
2015-04-30 17:48:29 +01:00
Mark Haines
c95480963e
read the pid_file from the config file in synctl
2015-04-30 17:12:15 +01:00
Mark Haines
069296dbb0
Can't specify bind-port on the cmdline anymore
2015-04-30 17:08:07 +01:00
Matthew Hodgson
e3005d3ddb
mention silviof's dockerfile
2015-04-29 00:14:29 +01:00
Matthew Hodgson
cc5d68f4c4
general clean up. s/alpha/beta/g. add intelfx's AUR package for Arch. s/the homeserver/Synapse/g. move installation & running sections closer together.
2015-04-29 00:00:24 +01:00
David Baker
f46eee838a
Add note about updating your signing keys (ie. "the auto thing")
2015-04-24 15:25:28 +01:00
David Baker
a654f3fe49
Matrix ID server is now HTTPS
2015-04-24 15:07:24 +01:00
David Baker
44ccfa6258
Remove ancient history
2015-04-24 15:05:56 +01:00
David Baker
04d1725752
Pedant: OS X has a space
2015-04-24 15:01:14 +01:00
Matthew Hodgson
7f911ef4e3
typo
2015-04-08 10:55:12 +01:00
Matthew Hodgson
8675ea03de
actually tell users /how/ to turn on registration
2015-03-30 12:05:38 -04:00
Erik Johnston
ed4d44d833
Merge pull request #109 from matrix-org/default_registration
...
Disable registration by default. Add script to register new users.
2015-03-18 11:38:52 +00:00
Matthew Hodgson
b677ff6692
add ToC and fix typoe
2015-03-14 00:22:41 +00:00
Erik Johnston
a1abee013c
Add note about disabling registration by default
2015-03-13 17:06:21 +00:00
brabo
596daf6e68
added "cd ~/.synapse" before setup of the homeserver to generate our files in there instead of ~
2015-02-22 18:52:59 +01:00
Matthew Hodgson
2b8903ce2f
we federate on port 8448 nowadays...
2015-02-14 00:16:33 +00:00
Matthew Hodgson
0c0ae2e886
clean up TurnedToDust's ArchLinux notes a bit
2015-02-07 20:24:46 +00:00
TurnedToDust
03c25ebeae
Update to README.rst
...
Added Documentation regarding ArchLinux
2015-02-06 22:28:21 -07:00
Matthew Hodgson
f3a4267757
less obscure xargs
2015-02-02 17:31:58 +00:00
Matthew Hodgson
8c52e6e8a1
fix typo
2015-02-02 17:12:23 +00:00
Matthew Hodgson
e9dfc4cfae
fix OSX stuff and typos
2015-01-31 06:09:59 +01:00
David Baker
68bd7dfbb7
s/homeserver.config/homeserver.yaml/ because that's what synctl looks for.
2015-01-30 17:37:37 +00:00
David Baker
166c2cd4f3
add generate config instruction to the HS setup part
2015-01-30 17:11:29 +00:00
Mark Haines
33cf48118f
Tell people to "source" the activate script for virtualenv, Remove --user from pip install
2015-01-30 17:00:32 +00:00
Mark Haines
e709d61964
Update documentation to recommend virtual env
2015-01-30 16:56:53 +00:00
Matthew Hodgson
bfb198a6eb
don't clobber pythonpath
2015-01-09 18:14:05 +00:00
Matthew Hodgson
28db5dde4c
oops
2015-01-08 20:38:55 +00:00
Matthew Hodgson
80e89772e2
spell out that local libs may need to be explicitly given priority
2015-01-08 20:37:08 +00:00
Matthew Hodgson
0e93e01fcb
spell out that VoIP needs TURN
2014-12-24 19:45:28 +00:00
Matthew Hodgson
d90e586c85
spell out that upgrading is just installing over the top
2014-12-24 16:56:20 +00:00
Kegsay
20923ffd43
Update README.rst
...
Add gotcha: The content repository requires additional cygwin packages.
2014-12-18 14:44:48 +00:00
Kegsay
f8cc8a66b4
Update README.rst
...
Add windows (cygwin) install instructions.
2014-12-18 14:16:31 +00:00
Matthew Hodgson
293e89e2da
re-add OSX troubleshooting instructions (not sure how they got lost)
2014-12-02 18:01:16 +00:00
Tjardick van der Kraan
f9846a27b6
Added the needed libssl-dev package
2014-12-02 11:22:00 +01:00
Matthew Hodgson
d45325b6d7
upgrade script depends on sqlite3 cli
2014-11-26 00:59:01 +00:00
Matthew Hodgson
84b1c9d8c2
rst bugs
2014-11-24 01:41:05 +00:00
Matthew Hodgson
a7f470d1d9
more README fixes
2014-11-18 11:23:17 -08:00
Matthew Hodgson
c571dd4f0e
warn about memory
2014-11-17 11:44:53 -08:00
Matthew Hodgson
94ed41f236
update the README.rst to reflect the develop branch
2014-11-17 11:42:27 -08:00
Matthew Hodgson
b57e9f58fd
yet another installation gotcha
2014-11-17 11:11:35 -08:00
Matthew Hodgson
b80d1925ff
clarify install instructions further still
2014-11-17 10:52:12 -08:00
Matthew Hodgson
c2609b239f
suggest ~/.synapse
2014-11-13 11:59:33 +02:00
Matthew Hodgson
ca386a4b25
various fixes based on truphone feedback
2014-11-12 17:26:50 +02:00
Matthew Hodgson
64bc36304f
typo
2014-11-12 00:18:25 +02:00
Mark Haines
402d080990
Fix installation instructions in README
2014-11-04 15:08:13 +00:00
David Baker
d694619a95
Fix ncorrect ports in documentation and add notes on how generate-config also generates certs bound to whatever hostname you give with --generate-config.
...
SYN-87 #resolved
2014-10-02 14:09:27 +01:00
Mark Haines
45f7677bdc
Trivial formatting fixes for README.
2014-10-02 11:00:21 +01:00
David Baker
7a322b6326
Update README setup instructions to be correct. Make synapse spit out explanatory note when generating config to tell people to look at it and customise it.
2014-10-02 10:43:22 +01:00
Kegan Dougal
fba67ef951
Small formatting fixes
2014-09-19 14:19:02 +01:00
Matthew Hodgson
3b38d2f507
big warning
2014-09-04 02:35:18 +01:00
Matthew Hodgson
822d0e5520
update README to know about synctl
2014-09-04 01:51:01 +01:00
Matthew Hodgson
7819a1010c
general documentation review and editing
2014-09-02 21:15:03 +01:00
Matthew Hodgson
3bffd14b02
fix quickstart slightly
2014-09-02 21:15:03 +01:00
David Baker
772c117e68
Make the intro bit a separate section rather than have a 'quick start' section that only tells you how to get started half way through.
2014-09-02 10:05:26 +01:00
Mark Haines
86fa1138be
Update readme with instructions on how to generate configs for homeservers
2014-09-01 20:22:16 +01:00
Matthew Hodgson
45e70a6b70
point out the non-quick-start guide
2014-08-23 00:50:49 +01:00
Erik Johnston
9521e6758f
Move the 'Upgrade' section to just below the 'Installation' section
2014-08-22 15:23:02 +01:00