mirror of
https://github.com/YunoHost-Apps/synapse_ynh.git
synced 2024-09-03 20:26:38 +02:00
Some English proof-reading :-)
This commit is contained in:
Jimmy Monin
parent
5636980dc4
commit
56186c16a7
3 changed files with 35 additions and 35 deletions
58
README.md
58
README.md
|
|
@ -6,7 +6,7 @@ Synapse for YunoHost
|
|||
[](https://ci-apps.yunohost.org/jenkins/job/synapse%20%28Community%29/lastBuild/consoleFull)
|
||||
[](https://install-app.yunohost.org/?app=synapse)
|
||||
|
||||
> *This package allow you to install synapse quickly and simply on a YunoHost server.
|
||||
> *This package allows you to install synapse quickly and simply on a YunoHost server.
|
||||
If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
|
||||
|
||||
Overview
|
||||
|
|
@ -14,7 +14,7 @@ Overview
|
|||
|
||||
Instant messaging server matrix network.
|
||||
|
||||
Yunohost chattroom with matrix : [https://riot.im/app/#/room/#yunohost:matrix.org](https://riot.im/app/#/room/#yunohost:matrix.org)
|
||||
Yunohost chatroom with matrix : [https://riot.im/app/#/room/#yunohost:matrix.org](https://riot.im/app/#/room/#yunohost:matrix.org)
|
||||
|
||||
**Shipped version:** 0.26.0
|
||||
|
||||
|
|
@ -23,20 +23,20 @@ Configuration
|
|||
|
||||
### Install for ARM arch (or slow arch)
|
||||
|
||||
For all slow or arm architecture it's recommended to build the dh file before the install to have quicker install.
|
||||
You could built it by this cmd : `mkdir -p /etc/matrix-synapse && openssl dhparam -out /etc/matrix-synapse/dh.pem 2048 > /dev/null`
|
||||
For all slow or arm architecture it's recommended to build the dh file before the install to have a quicker install.
|
||||
You could build it by this cmd : `mkdir -p /etc/matrix-synapse && openssl dhparam -out /etc/matrix-synapse/dh.pem 2048 > /dev/null`
|
||||
After that you can install it without problem.
|
||||
|
||||
The package use a prebuild python virtualenvironnement. The binary are taken from this repos : https://github.com/Josue-T/synapse_python_build
|
||||
The package uses a prebuilt python virtual environnement. The binary are taken from this repository: https://github.com/Josue-T/synapse_python_build
|
||||
The script to build the binary is also available.
|
||||
|
||||
### Web client
|
||||
|
||||
If you want a web client you can also install riot with this package : https://github.com/YunoHost-Apps/riot_ynh .
|
||||
If you want a web client you can also install riot with this package: https://github.com/YunoHost-Apps/riot_ynh .
|
||||
|
||||
### Access by federation
|
||||
|
||||
To be accessible by the federation you need to put this following line in the dns configuration :
|
||||
To be accessible by the federation you need to put the following line in the dns configuration:
|
||||
|
||||
```
|
||||
_matrix._tcp.<yourdomain.com> <ttl> IN SRV 10 0 <port> <synapse.server.name>
|
||||
|
|
@ -45,19 +45,19 @@ for example
|
|||
```
|
||||
_matrix._tcp.example.com. 3600 IN SRV 10 0 SYNAPSE_PORT synapse.example.com.
|
||||
```
|
||||
You need to replace SYNAPSE_PORT by the real port. This port could be got by the command : `yunohost app setting SYNAPSE_INSTANCE_NAME synapse_tls_port`
|
||||
You need to replace SYNAPSE_PORT by the real port. This port can be obtained by the command: `yunohost app setting SYNAPSE_INSTANCE_NAME synapse_tls_port`
|
||||
|
||||
If it is not automatically done, you need to open this in our ISP box.
|
||||
If it is not automatically done, you need to open this in your ISP box.
|
||||
|
||||
### Turnserver
|
||||
|
||||
For Voip and video conferencing a turnserver is also installed (and configured). The turnserver listen on two UDP and TCP ports. You can get it by these command :
|
||||
For Voip and video conferencing a turnserver is also installed (and configured). The turnserver listens on two UDP and TCP ports. You can get them with these commands:
|
||||
```
|
||||
yunohost app setting synapse turnserver_tls_port
|
||||
yunohost app setting synapse turnserver_alt_tls_port
|
||||
|
||||
```
|
||||
To have a full functional turnserver you need to open theses ports (if it is not autocratically done) in your ISP box.
|
||||
To have a fully functional turnserver you need to open these ports (if it is not automatically done) on your ISP box.
|
||||
|
||||
### Important Security Note
|
||||
|
||||
|
|
@ -68,14 +68,14 @@ malicious user generated content from a Matrix API which then had trusted
|
|||
access to Riot (or other apps) due to sharing the same domain.
|
||||
|
||||
We have put some coarse mitigations into place to try to protect against this
|
||||
situation, but it's still not good practice to do it in the first place. See
|
||||
situation, but it's still not a good practice to do it in the first place. See
|
||||
https://github.com/vector-im/riot-web/issues/1977 for more details.
|
||||
|
||||
Documentation
|
||||
-------------
|
||||
|
||||
- Official documentation: https://github.com/matrix-org/synapse
|
||||
- YunoHost documentation: to be created ; feel free to help!
|
||||
- YunoHost documentation: to be created; feel free to help!
|
||||
|
||||
YunoHost specific features
|
||||
--------------------------
|
||||
|
|
@ -92,9 +92,9 @@ Supported with LDAP.
|
|||
Limitations
|
||||
-----------
|
||||
|
||||
Synapse take a lot of ressurce. So in slow architecture (like small ARM board), this app could take a lot of CPU and RAM.
|
||||
Synapse uses a lot of ressource. So on slow architecture (like small ARM board), this app could take a lot of CPU and RAM.
|
||||
|
||||
This app don't contains any real good web interface. So it's recommended to use Riot client to connect to this app. This app is available [here](https://github.com/YunoHost-Apps/riot_ynh)
|
||||
This app doesn't provide any real good web interface. So it's recommended to use Riot client to connect to this app. This app is available [here](https://github.com/YunoHost-Apps/riot_ynh)
|
||||
|
||||
Links
|
||||
-----
|
||||
|
|
@ -103,7 +103,7 @@ Links
|
|||
- Matrix website: https://matrix.org/
|
||||
- YunoHost website: https://yunohost.org/
|
||||
|
||||
Additionnal informations
|
||||
Additional information
|
||||
-----
|
||||
|
||||
|
||||
|
|
@ -111,7 +111,7 @@ Additionnal informations
|
|||
Administation
|
||||
-------------
|
||||
|
||||
**All documentation of this section is not warranted. A bad use of command could broke the app and all the data. So use theses command at your own risk.**
|
||||
**All documentation of this section is not warranted. A bad use of command could break the app and all the data. So use these commands at your own risk.**
|
||||
|
||||
Before any manipulation it's recommended to do a backup by this following command :
|
||||
|
||||
|
|
@ -119,46 +119,46 @@ Before any manipulation it's recommended to do a backup by this following comman
|
|||
|
||||
### Set user as admin
|
||||
|
||||
Actually there are no function in the client interface to set a user as admin. So it's possible to enable it manually in the database.
|
||||
Actually there are no functions in the client interface to set a user as admin. So it's possible to enable it manually in the database.
|
||||
|
||||
This following command will enable the admin access to the specified user :
|
||||
The following command will grant admin privilege to the specified user:
|
||||
```
|
||||
su --command="psql matrix_synapse" postgres <<< "UPDATE users SET admin = 1 WHERE name = '@user_to_be_admin:domain.tld'"
|
||||
```
|
||||
|
||||
### Disable backup in upgrade
|
||||
|
||||
To solve the issue [#30](https://github.com/YunoHost-Apps/synapse_ynh/issues/30) you can disable the upgrade in the upgrade by setting to true the key `disable_backup_before_upgrade` in the app setting. You can set it by this command :
|
||||
To solve the issue [#30](https://github.com/YunoHost-Apps/synapse_ynh/issues/30) you can disable the backup in the upgrade by setting to true the key `disable_backup_before_upgrade` in the app setting. You can set it by this command :
|
||||
|
||||
`yunohost app setting synapse disable_backup_before_upgrade -v 1`
|
||||
|
||||
### Multi instance support
|
||||
|
||||
To give a possiblity to have multiple domain you can use synapse in multiple instance. In this case all instance will run on differents port so it's really important to use put a SRV record in your domain. You can get the port that your need to put in your SRV record by this following command :
|
||||
To give a possibility to have multiple domains you can use multiple instances of synapse. In this case all instances will run on different ports so it's really important to put a SRV record in your domain. You can get the port that you need to put in your SRV record with this following command:
|
||||
```
|
||||
yunohost app setting synapse__<instancenumber> synapse_tls_port
|
||||
```
|
||||
|
||||
Before to install a second instance of the app it's really recommend to update all instance already installed.
|
||||
Before installing a second instance of the app it's really recommended to update all existing instances.
|
||||
|
||||
### Migration from old package
|
||||
|
||||
The old synapse package had some problem, the package has been reviewed in the summer 2017. The old package was made with the debian package with the synapse apt repos. The database used sqlite. To improve the performance and to have a better compatibility the new package use python virtual environment and postgresql as database. The Upgrade was made to make the migration from the old package to the new package. The part of this script is available here : https://github.com/YunoHost-Apps/synapse_ynh/blob/master/scripts/upgrade#L40-L119 .
|
||||
The old synapse package had some problems, the package has been reviewed in the summer 2017. The old package was made with the debian package with the synapse apt repos. The database used sqlite. To improve the performance and to have a better compatibility the new package uses python virtual environment and postgresql as database. The Upgrade was made to make the migration from the old package to the new package. The part of this script is available here : https://github.com/YunoHost-Apps/synapse_ynh/blob/master/scripts/upgrade#L40-L119 .
|
||||
|
||||
This script try to upgrade the app without any problem but it could happen that something fail and in this case it NOT guaranteed that the restored successfully. So it's REALLY recommended to make manually a backup before this big upgrade.
|
||||
This script tries to upgrade the app without any problem but it could happen that something fails and in this case the restoration is NOT guaranteed to be successful. So it's REALLY recommended to make MANUAL a backup before this big upgrade.
|
||||
|
||||
To check if you use the old synapse package type this command :
|
||||
To check if you use the old synapse package type this command:
|
||||
`sudo yunohost app setting synapse synapse_version`
|
||||
- If the command return nothing you are using the old package.
|
||||
- If the command return something like 0.25.1 you are using the new package.
|
||||
- If the command returns nothing you are using the old package.
|
||||
- If the command returns something like 0.25.1 you are using the new package.
|
||||
|
||||
To do a backup before the upgrade use this command : `sudo yunohost backup create --verbose --ignore-system --apps synapse`
|
||||
|
||||
If anything fail while you are doing the upgrade please make an issue here : https://github.com/YunoHost-Apps/synapse_ynh/issues
|
||||
If anything fails while you are doing the upgrade please create an issue here: https://github.com/YunoHost-Apps/synapse_ynh/issues
|
||||
|
||||
### License
|
||||
|
||||
Synapse is published under the Apache License : https://github.com/matrix-org/synapse/blob/master/LICENSE
|
||||
Synapse is published under the Apache License: https://github.com/matrix-org/synapse/blob/master/LICENSE
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -304,14 +304,14 @@ ynh_check_starting "Synapse now listening on port $synapse_tls_port" "/var/log/m
|
|||
# SEND A README FOR THE ADMIN
|
||||
#=================================================
|
||||
|
||||
message="To federate this app you need to add this line in your DNS configuration :
|
||||
message="To federate this app you need to add this line in your DNS configuration:
|
||||
|
||||
_matrix._tcp.$domain. 3600 IN SRV 10 0 $synapse_tls_port $domain.
|
||||
|
||||
You also need to open the TCP port $synapse_tls_port on your ISP box if it's not automatically done.
|
||||
|
||||
Your synapse server also implement a turnserver (for VoIP), to have this fully functional open the TCP and UDP port $turnserver_tls_port and $turnserver_alt_tls_port (if it's not automatically done).
|
||||
Your synapse server also implements a turnserver (for VoIP), to have this fully functional open the TCP and UDP port $turnserver_tls_port and $turnserver_alt_tls_port (if it's not automatically done).
|
||||
|
||||
If you facing an issue or want to improve this app, please open a new issue in this project: https://github.com/YunoHost-Apps/synapse_ynh"
|
||||
If you're facing an issue or want to improve this app, please open a new issue in this project: https://github.com/YunoHost-Apps/synapse_ynh"
|
||||
|
||||
ynh_send_readme_to_admin "$message"
|
||||
|
|
|
|||
|
|
@ -154,14 +154,14 @@ ynh_check_starting "Synapse now listening on port $synapse_tls_port" "/var/log/m
|
|||
# SEND A README FOR THE ADMIN
|
||||
#=================================================
|
||||
|
||||
message="To federate this app you need to add this line in your DNS configuration :
|
||||
message="To federate this app you need to add this line in your DNS configuration:
|
||||
|
||||
_matrix._tcp.$domain. 3600 IN SRV 10 0 $synapse_tls_port $domain.
|
||||
|
||||
You also need to open the TCP port $synapse_tls_port on your ISP box if it's not automatically done.
|
||||
|
||||
Your synapse server also implement a turnserver (for VoIP), to have this fully functional open the TCP and UDP port $turnserver_tls_port and $turnserver_alt_tls_port (if it's not automatically done).
|
||||
Your synapse server also implements a turnserver (for VoIP), to have this fully functional open the TCP and UDP port $turnserver_tls_port and $turnserver_alt_tls_port (if it's not automatically done).
|
||||
|
||||
If you facing an issue or want to improve this app, please open a new issue in this project: https://github.com/YunoHost-Apps/synapse_ynh"
|
||||
If you're facing an issue or want to improve this app, please open a new issue in this project: https://github.com/YunoHost-Apps/synapse_ynh"
|
||||
|
||||
ynh_send_readme_to_admin "$message"
|
||||
|
|
|
|||
Loading…
Reference in a new issue