YunoHost-Apps/synapse_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/synapse_ynh.git synced 2024-09-03 20:26:38 +02:00
Code Issues Activity Actions

Add licence comment

Browse source
This commit is contained in:
Josue-T 2017-10-13 14:57:26 +02:00 • committed by Josué Tille
parent dc4de2633b
commit 3b4a42a1d0
1 changed files with 18 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
README.md
View file

@ -1,11 +1,14 @@
Synapse for YunoHost Synapse for YunoHost
================== ====================
Yunohost chattroom with matrix : [https://riot.im/app/#/room/#yunohost:matrix.org](https://riot.im/app/#/room/#yunohost:matrix.org) Yunohost chattroom with matrix : [https://riot.im/app/#/room/#yunohost:matrix.org](https://riot.im/app/#/room/#yunohost:matrix.org)
[Yunohost project](https://yunohost.org/#/) [Yunohost project](https://yunohost.org/#/)
## For ARM arch (or slow arch) Setup
-----
### Install for ARM arch (or slow arch)
If you don't have a dh.pem file in `/etc/yunohost/certs/YOUR DOMAIN/dh.pem` you should built it befor to install the app because it could take a long time. If you don't have a dh.pem file in `/etc/yunohost/certs/YOUR DOMAIN/dh.pem` you should built it befor to install the app because it could take a long time.
You could built it by this cmd : `sudo openssl dhparam -out /etc/yunohost/certs/YOUR DOMAIN/dh.pem 2048 > /dev/null` You could built it by this cmd : `sudo openssl dhparam -out /etc/yunohost/certs/YOUR DOMAIN/dh.pem 2048 > /dev/null`
@ -13,15 +16,15 @@ After that you can install it without problem.
The install use the python virtualenvironement. Everything is built on the install and some package a compiled so it could take a long time if the processor is slow. The install use the python virtualenvironement. Everything is built on the install and some package a compiled so it could take a long time if the processor is slow.
## Package update package ### Package update package
sudo yunohost app upgrade synapse -u https://github.com/YunoHost-Apps/synapse_ynh `sudo yunohost app upgrade synapse -u https://github.com/YunoHost-Apps/synapse_ynh`
## Web client ### Web client
If you want a web client you can also install riot with this package : https://github.com/YunoHost-Apps/riot_ynh . But If you want a web client you can also install riot with this package : https://github.com/YunoHost-Apps/riot_ynh . But
## Access by federation ### 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 this following line in the dns configuration :
@ -32,13 +35,7 @@ for example
``` ```
_matrix._tcp.example.com. 3600 IN SRV 10 0 8448 synapse.example.com. _matrix._tcp.example.com. 3600 IN SRV 10 0 8448 synapse.example.com.
``` ```
### Important Security Note
## About debian package
It's important to know that this package use the debian backport repos. So this app will enable the debian backport repos it will install some package from this repos. If you remove this app you could keep some package form backport on your server.
Important Security Note
=======================
We do not recommend running Riot from the same domain name as your Matrix We do not recommend running Riot from the same domain name as your Matrix
homeserver (synapse). The reason is the risk of XSS (cross-site-scripting) homeserver (synapse). The reason is the risk of XSS (cross-site-scripting)
@ -50,17 +47,20 @@ 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 good practice to do it in the first place. See
https://github.com/vector-im/riot-web/issues/1977 for more details. https://github.com/vector-im/riot-web/issues/1977 for more details.
## To do License
-------
Synapse is published under the Apache License : https://github.com/matrix-org/synapse/blob/master/LICENSE
To do
-----
- Doc (issue about domain) - Doc (issue about domain)
- Test arm - Test arm
- Riot doc - Riot doc
- Test production - Test production
Todo for official App ### Todo for official App
======================
- Improve the upgrade from old version (all feedback is welcome) - Improve the upgrade from old version (all feedback is welcome)
- Improve documentation - Improve documentation