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
Package registry
Container Registry
Model registry
Operate
Terraform modules
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
Timo Ley
synapse
Commits
2fda8134
Commit
2fda8134
authored
8 years ago
by
Richard van der Hoff
Browse files
Options
Downloads
Patches
Plain Diff
Update the readme to use trial
parent
a2849a18
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
+14
-5
14 additions, 5 deletions
README.rst
with
14 additions
and
5 deletions
README.rst
+
14
−
5
View file @
2fda8134
...
@@ -88,7 +88,12 @@ System requirements:
...
@@ -88,7 +88,12 @@ System requirements:
- Python 2.7
- Python 2.7
- At least 1GB of free RAM if you want to join large public rooms like #matrix:matrix.org
- At least 1GB of free RAM if you want to join large public rooms like #matrix:matrix.org
Synapse is written in python but some of the libraries is uses are written in
Installing from source
----------------------
(Prebuilt packages are available for some platforms - see `Platform-Specific
Instructions`_.)
Synapse is written in python but some of the libraries it uses are written in
C. So before we can install synapse itself we need a working C compiler and the
C. So before we can install synapse itself we need a working C compiler and the
header files for python C extensions.
header files for python C extensions.
...
@@ -302,7 +307,7 @@ See https://github.com/vector-im/vector-web/issues/1977 and
...
@@ -302,7 +307,7 @@ See https://github.com/vector-im/vector-web/issues/1977 and
https://developer.github.com/changes/2014-04-25-user-content-security for more details.
https://developer.github.com/changes/2014-04-25-user-content-security for more details.
Platform
Specific Instructions
Platform
-
Specific Instructions
==============================
==============================
Debian
Debian
...
@@ -759,6 +764,10 @@ Then update the `users` table in the database::
...
@@ -759,6 +764,10 @@ Then update the `users` table in the database::
Synapse Development
Synapse Development
===================
===================
Before setting up a development environment for synapse, make sure you have the
system dependencies (such as the python header files) installed - see
`Installing from source`_.
To check out a synapse for development, clone the git repo into a working
To check out a synapse for development, clone the git repo into a working
directory of your choice::
directory of your choice::
...
@@ -770,8 +779,8 @@ to install using pip and a virtualenv::
...
@@ -770,8 +779,8 @@ to install using pip and a virtualenv::
virtualenv env
virtualenv env
source env/bin/activate
source env/bin/activate
python synapse/python_dependencies.py | xargs
-n1
pip install
python synapse/python_dependencies.py | xargs pip install
pip install
setuptools_tria
l mock
pip install
lxm
l mock
This will run a process of downloading and installing all the needed
This will run a process of downloading and installing all the needed
dependencies into a virtual env.
dependencies into a virtual env.
...
@@ -779,7 +788,7 @@ dependencies into a virtual env.
...
@@ -779,7 +788,7 @@ dependencies into a virtual env.
Once this is done, you may wish to run Synapse's unit tests, to
Once this is done, you may wish to run Synapse's unit tests, to
check that everything is installed as it should be::
check that everything is installed as it should be::
python setup.py
test
PYTHONPATH="" trial
test
s
This should end with a 'PASSED' result::
This should end with a 'PASSED' result::
...
...
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