Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
synapse
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Monitor
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Maunium
synapse
Commits
48264812
Commit
48264812
authored
9 years ago
by
Mark Haines
Browse files
Options
Downloads
Patches
Plain Diff
Clean up some of restructured text formatting in the README.rst
parent
9d720223
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.rst
+32
-30
32 additions, 30 deletions
README.rst
with
32 additions
and
30 deletions
README.rst
+
32
−
30
View file @
48264812
...
@@ -7,7 +7,7 @@ Matrix is an ambitious new ecosystem for open federated Instant Messaging and
...
@@ -7,7 +7,7 @@ Matrix is an ambitious new ecosystem for open federated Instant Messaging and
VoIP. The basics you need to know to get up and running are:
VoIP. The basics you need to know to get up and running are:
- Everything in Matrix happens in a room. Rooms are distributed and do not
- Everything in Matrix happens in a room. Rooms are distributed and do not
exist on any single server. Rooms can be located using convenience aliases
exist on any single server. Rooms can be located using convenience aliases
like ``#matrix:matrix.org`` or ``#test:localhost:8448``.
like ``#matrix:matrix.org`` or ``#test:localhost:8448``.
- Matrix user IDs look like ``@matthew:matrix.org`` (although in the future
- Matrix user IDs look like ``@matthew:matrix.org`` (although in the future
...
@@ -23,7 +23,7 @@ The overall architecture is::
...
@@ -23,7 +23,7 @@ The overall architecture is::
accessed by the web client at http://matrix.org/beta or via an IRC bridge at
accessed by the web client at http://matrix.org/beta or via an IRC bridge at
irc://irc.freenode.net/matrix.
irc://irc.freenode.net/matrix.
Synapse is currently in rapid development, but as of version 0.5 we believe it
Synapse is currently in rapid development, but as of version 0.5 we believe it
is sufficiently stable to be run as an internet-facing service for real usage!
is sufficiently stable to be run as an internet-facing service for real usage!
About Matrix
About Matrix
...
@@ -104,7 +104,7 @@ Installing prerequisites on Ubuntu or Debian::
...
@@ -104,7 +104,7 @@ Installing prerequisites on Ubuntu or Debian::
sudo apt-get install build-essential python2.7-dev libffi-dev \
sudo apt-get install build-essential python2.7-dev libffi-dev \
python-pip python-setuptools sqlite3 \
python-pip python-setuptools sqlite3 \
libssl-dev python-virtualenv libjpeg-dev
libssl-dev python-virtualenv libjpeg-dev
Installing prerequisites on ArchLinux::
Installing prerequisites on ArchLinux::
sudo pacman -S base-devel python2 python-pip \
sudo pacman -S base-devel python2 python-pip \
...
@@ -115,7 +115,7 @@ Installing prerequisites on Mac OS X::
...
@@ -115,7 +115,7 @@ Installing prerequisites on Mac OS X::
xcode-select --install
xcode-select --install
sudo easy_install pip
sudo easy_install pip
sudo pip install virtualenv
sudo pip install virtualenv
To install the synapse homeserver run::
To install the synapse homeserver run::
virtualenv -p python2.7 ~/.synapse
virtualenv -p python2.7 ~/.synapse
...
@@ -180,7 +180,7 @@ The advantages of Postgres include:
...
@@ -180,7 +180,7 @@ The advantages of Postgres include:
* allowing basic active/backup high-availability with a "hot spare" synapse
* allowing basic active/backup high-availability with a "hot spare" synapse
pointing at the same DB master, as well as enabling DB replication in
pointing at the same DB master, as well as enabling DB replication in
synapse itself.
synapse itself.
The only disadvantage is that the code is relatively new as of April 2015 and
The only disadvantage is that the code is relatively new as of April 2015 and
may have a few regressions relative to SQLite.
may have a few regressions relative to SQLite.
...
@@ -190,8 +190,8 @@ For information on how to install and use PostgreSQL, please see
...
@@ -190,8 +190,8 @@ For information on how to install and use PostgreSQL, please see
Running Synapse
Running Synapse
===============
===============
To actually run your new homeserver, pick a working directory for Synapse to
run
To actually run your new homeserver, pick a working directory for Synapse to
(e.g. ``~/.synapse``), and::
run
(e.g. ``~/.synapse``), and::
cd ~/.synapse
cd ~/.synapse
source ./bin/activate
source ./bin/activate
...
@@ -214,13 +214,13 @@ defaults to python 3, but synapse currently assumes python 2.7 by default:
...
@@ -214,13 +214,13 @@ defaults to python 3, but synapse currently assumes python 2.7 by default:
pip may be outdated (6.0.7-1 and needs to be upgraded to 6.0.8-1 )::
pip may be outdated (6.0.7-1 and needs to be upgraded to 6.0.8-1 )::
sudo pip2.7 install --upgrade pip
sudo pip2.7 install --upgrade pip
You also may need to explicitly specify python 2.7 again during the install
You also may need to explicitly specify python 2.7 again during the install
request::
request::
pip2.7 install --process-dependency-links \
pip2.7 install --process-dependency-links \
https://github.com/matrix-org/synapse/tarball/master
https://github.com/matrix-org/synapse/tarball/master
If you encounter an error with lib bcrypt causing an Wrong ELF Class:
If you encounter an error with lib bcrypt causing an Wrong ELF Class:
ELFCLASS32 (x64 Systems), you may need to reinstall py-bcrypt to correctly
ELFCLASS32 (x64 Systems), you may need to reinstall py-bcrypt to correctly
compile it under the right architecture. (This should not be needed if
compile it under the right architecture. (This should not be needed if
...
@@ -228,7 +228,7 @@ installing under virtualenv)::
...
@@ -228,7 +228,7 @@ installing under virtualenv)::
sudo pip2.7 uninstall py-bcrypt
sudo pip2.7 uninstall py-bcrypt
sudo pip2.7 install py-bcrypt
sudo pip2.7 install py-bcrypt
During setup of Synapse you need to call python2.7 directly again::
During setup of Synapse you need to call python2.7 directly again::
cd ~/.synapse
cd ~/.synapse
...
@@ -236,25 +236,27 @@ During setup of Synapse you need to call python2.7 directly again::
...
@@ -236,25 +236,27 @@ During setup of Synapse you need to call python2.7 directly again::
--server-name machine.my.domain.name \
--server-name machine.my.domain.name \
--config-path homeserver.yaml \
--config-path homeserver.yaml \
--generate-config
--generate-config
...substituting your host and domain name as appropriate.
...substituting your host and domain name as appropriate.
Windows Install
Windows Install
---------------
---------------
Synapse can be installed on Cygwin. It requires the following Cygwin packages:
Synapse can be installed on Cygwin. It requires the following Cygwin packages:
- gcc
- gcc
- git
- git
- libffi-devel
- libffi-devel
- openssl (and openssl-devel, python-openssl)
- openssl (and openssl-devel, python-openssl)
- python
- python
- python-setuptools
- python-setuptools
The content repository requires additional packages and will be unable to process
The content repository requires additional packages and will be unable to process
uploads without them:
uploads without them:
- libjpeg8
- libjpeg8-devel
- libjpeg8
- zlib
- libjpeg8-devel
- zlib
If you choose to install Synapse without these packages, you will need to reinstall
If you choose to install Synapse without these packages, you will need to reinstall
``pillow`` for changes to be applied, e.g. ``pip uninstall pillow`` ``pip install
``pillow`` for changes to be applied, e.g. ``pip uninstall pillow`` ``pip install
pillow --user``
pillow --user``
...
@@ -276,8 +278,8 @@ Troubleshooting
...
@@ -276,8 +278,8 @@ Troubleshooting
Troubleshooting Installation
Troubleshooting Installation
----------------------------
----------------------------
Synapse requires pip 1.7 or later, so if your OS provides too old a version and
Synapse requires pip 1.7 or later, so if your OS provides too old a version and
you get errors about ``error: no such option: --process-dependency-links`` you
you get errors about ``error: no such option: --process-dependency-links`` you
may need to manually upgrade it::
may need to manually upgrade it::
sudo pip install --upgrade pip
sudo pip install --upgrade pip
...
@@ -288,9 +290,9 @@ created. To reset the installation::
...
@@ -288,9 +290,9 @@ created. To reset the installation::
rm -rf /tmp/pip_install_matrix
rm -rf /tmp/pip_install_matrix
pip seems to leak *lots* of memory during installation. For instance, a Linux
pip seems to leak *lots* of memory during installation. For instance, a Linux
host with 512MB of RAM may run out of memory whilst installing Twisted. If this
host with 512MB of RAM may run out of memory whilst installing Twisted. If this
happens, you will have to individually install the dependencies which are
happens, you will have to individually install the dependencies which are
failing, e.g.::
failing, e.g.::
pip install twisted
pip install twisted
...
@@ -301,8 +303,8 @@ will need to export CFLAGS=-Qunused-arguments.
...
@@ -301,8 +303,8 @@ will need to export CFLAGS=-Qunused-arguments.
Troubleshooting Running
Troubleshooting Running
-----------------------
-----------------------
If synapse fails with ``missing "sodium.h"`` crypto errors, you may need
If synapse fails with ``missing "sodium.h"`` crypto errors, you may need
to manually upgrade PyNaCL, as synapse uses NaCl (http://nacl.cr.yp.to/) for
to manually upgrade PyNaCL, as synapse uses NaCl (http://nacl.cr.yp.to/) for
encryption and digital signatures.
encryption and digital signatures.
Unfortunately PyNACL currently has a few issues
Unfortunately PyNACL currently has a few issues
(https://github.com/pyca/pynacl/issues/53) and
(https://github.com/pyca/pynacl/issues/53) and
...
@@ -313,7 +315,7 @@ fix try re-installing from PyPI or directly from
...
@@ -313,7 +315,7 @@ fix try re-installing from PyPI or directly from
# Install from PyPI
# Install from PyPI
pip install --user --upgrade --force pynacl
pip install --user --upgrade --force pynacl
# Install from github
# Install from github
pip install --user https://github.com/pyca/pynacl/tarball/master
pip install --user https://github.com/pyca/pynacl/tarball/master
...
@@ -431,7 +433,7 @@ private federation (``localhost:8080``, ``localhost:8081`` and
...
@@ -431,7 +433,7 @@ private federation (``localhost:8080``, ``localhost:8081`` and
http://localhost:8080. Simply run::
http://localhost:8080. Simply run::
demo/start.sh
demo/start.sh
This is mainly useful just for development purposes.
This is mainly useful just for development purposes.
Running The Demo Web Client
Running The Demo Web Client
...
@@ -494,7 +496,7 @@ time.
...
@@ -494,7 +496,7 @@ time.
Where's the spec?!
Where's the spec?!
==================
==================
The source of the matrix spec lives at https://github.com/matrix-org/matrix-doc.
The source of the matrix spec lives at https://github.com/matrix-org/matrix-doc.
A recent HTML snapshot of this lives at http://matrix.org/docs/spec
A recent HTML snapshot of this lives at http://matrix.org/docs/spec
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment