MirrorHub/synapse
0
0
Fork 1
mirror of https://mau.dev/maunium/synapse.git synced 2024-11-12 04:52:26 +01:00
Code Issues Projects Releases Wiki Activity

Tweaks to the upgrade instructions

Browse source
This commit is contained in:
Richard van der Hoff 2017-08-23 15:15:40 +01:00
parent a4d3bfe3d6
commit fc9878f6a4
1 changed files with 51 additions and 42 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

93
UPGRADE.rst
View file

@ -5,39 +5,48 @@ Before upgrading check if any special steps are required to upgrade from the
what you currently have installed to current version of synapse. The extra what you currently have installed to current version of synapse. The extra
instructions that may be required are listed later in this document. instructions that may be required are listed later in this document.
If synapse was installed in a virtualenv then active that virtualenv before 1. If synapse was installed in a virtualenv then active that virtualenv before
upgrading. If synapse is installed in a virtualenv in ``~/.synapse/`` then run: upgrading. If synapse is installed in a virtualenv in ``~/.synapse/`` then
run:
.. code:: bash
source ~/.synapse/bin/activate
2. If synapse was installed using pip then upgrade to the latest version by
running:
.. code:: bash
pip install --upgrade --process-dependency-links https://github.com/matrix-org/synapse/tarball/master
# restart synapse
synctl restart
If synapse was installed using git then upgrade to the latest version by
running:
.. code:: bash
# Pull the latest version of the master branch.
git pull
# Update the versions of synapse's python dependencies.
python synapse/python_dependencies.py | xargs pip install --upgrade
# restart synapse
./synctl restart
To check whether your update was sucessful, you can check the Server header
returned by the Client-Server API:
.. code:: bash .. code:: bash
source ~/.synapse/bin/activate # replace <host.name> with the hostname of your synapse homeserver.
# You may need to specify a port (eg, :8448) if your server is not
If synapse was installed using pip then upgrade to the latest version by # configured on port 443.
running: curl -kv https://<host.name>/_matrix/client/versions 2>&1 | grep "Server:"
.. code:: bash
pip install --upgrade --process-dependency-links https://github.com/matrix-org/synapse/tarball/master
If synapse was installed using git then upgrade to the latest version by
running:
.. code:: bash
# Pull the latest version of the master branch.
git pull
# Update the versions of synapse's python dependencies.
python synapse/python_dependencies.py | xargs -n1 pip install --upgrade
To check whether your update was sucessfull, run:
.. code:: bash
# replace your.server.domain with ther domain of your synapse homeserver
curl https://<your.server.domain>/_matrix/federation/v1/version
So for the Matrix.org HS server the URL would be: https://matrix.org/_matrix/federation/v1/version.
Upgrading to v0.15.0 Upgrading to v0.15.0
==================== ====================
@ -77,7 +86,7 @@ It has been replaced by specifying a list of application service registrations i
``homeserver.yaml``:: ``homeserver.yaml``::
app_service_config_files: ["registration-01.yaml", "registration-02.yaml"] app_service_config_files: ["registration-01.yaml", "registration-02.yaml"]
Where ``registration-01.yaml`` looks like:: Where ``registration-01.yaml`` looks like::
url: <String> # e.g. "https://my.application.service.com" url: <String> # e.g. "https://my.application.service.com"
@ -166,7 +175,7 @@ This release completely changes the database schema and so requires upgrading
it before starting the new version of the homeserver. it before starting the new version of the homeserver.
The script "database-prepare-for-0.5.0.sh" should be used to upgrade the The script "database-prepare-for-0.5.0.sh" should be used to upgrade the
database. This will save all user information, such as logins and profiles, database. This will save all user information, such as logins and profiles,
but will otherwise purge the database. This includes messages, which but will otherwise purge the database. This includes messages, which
rooms the home server was a member of and room alias mappings. rooms the home server was a member of and room alias mappings.
@ -175,18 +184,18 @@ file and ask for help in #matrix:matrix.org. The upgrade process is,
unfortunately, non trivial and requires human intervention to resolve any unfortunately, non trivial and requires human intervention to resolve any
resulting conflicts during the upgrade process. resulting conflicts during the upgrade process.
Before running the command the homeserver should be first completely Before running the command the homeserver should be first completely
shutdown. To run it, simply specify the location of the database, e.g.: shutdown. To run it, simply specify the location of the database, e.g.:
./scripts/database-prepare-for-0.5.0.sh "homeserver.db" ./scripts/database-prepare-for-0.5.0.sh "homeserver.db"
Once this has successfully completed it will be safe to restart the Once this has successfully completed it will be safe to restart the
homeserver. You may notice that the homeserver takes a few seconds longer to homeserver. You may notice that the homeserver takes a few seconds longer to
restart than usual as it reinitializes the database. restart than usual as it reinitializes the database.
On startup of the new version, users can either rejoin remote rooms using room On startup of the new version, users can either rejoin remote rooms using room
aliases or by being reinvited. Alternatively, if any other homeserver sends a aliases or by being reinvited. Alternatively, if any other homeserver sends a
message to a room that the homeserver was previously in the local HS will message to a room that the homeserver was previously in the local HS will
automatically rejoin the room. automatically rejoin the room.
Upgrading to v0.4.0 Upgrading to v0.4.0
@ -245,7 +254,7 @@ automatically generate default config use::
--config-path homeserver.config \ --config-path homeserver.config \
--generate-config --generate-config
This config can be edited if desired, for example to specify a different SSL This config can be edited if desired, for example to specify a different SSL
certificate to use. Once done you can run the home server using:: certificate to use. Once done you can run the home server using::
$ python synapse/app/homeserver.py --config-path homeserver.config $ python synapse/app/homeserver.py --config-path homeserver.config
@ -266,20 +275,20 @@ This release completely changes the database schema and so requires upgrading
it before starting the new version of the homeserver. it before starting the new version of the homeserver.
The script "database-prepare-for-0.0.1.sh" should be used to upgrade the The script "database-prepare-for-0.0.1.sh" should be used to upgrade the
database. This will save all user information, such as logins and profiles, database. This will save all user information, such as logins and profiles,
but will otherwise purge the database. This includes messages, which but will otherwise purge the database. This includes messages, which
rooms the home server was a member of and room alias mappings. rooms the home server was a member of and room alias mappings.
Before running the command the homeserver should be first completely Before running the command the homeserver should be first completely
shutdown. To run it, simply specify the location of the database, e.g.: shutdown. To run it, simply specify the location of the database, e.g.:
./scripts/database-prepare-for-0.0.1.sh "homeserver.db" ./scripts/database-prepare-for-0.0.1.sh "homeserver.db"
Once this has successfully completed it will be safe to restart the Once this has successfully completed it will be safe to restart the
homeserver. You may notice that the homeserver takes a few seconds longer to homeserver. You may notice that the homeserver takes a few seconds longer to
restart than usual as it reinitializes the database. restart than usual as it reinitializes the database.
On startup of the new version, users can either rejoin remote rooms using room On startup of the new version, users can either rejoin remote rooms using room
aliases or by being reinvited. Alternatively, if any other homeserver sends a aliases or by being reinvited. Alternatively, if any other homeserver sends a
message to a room that the homeserver was previously in the local HS will message to a room that the homeserver was previously in the local HS will
automatically rejoin the room. automatically rejoin the room.