mirror of
https://github.com/YunoHost-Apps/element_ynh.git
synced 2024-09-03 18:36:08 +02:00
Refactor README
This commit is contained in:
Josué Tille
parent
dfc209799d
commit
54945cea7f
1 changed files with 77 additions and 24 deletions
101
README.md
101
README.md
|
|
@ -1,15 +1,78 @@
|
|||
Riot For yunohost
|
||||
==================
|
||||
|
||||
[](https://ci-apps.yunohost.org/jenkins/job/riot%20%28Community%29/lastBuild/consoleFull)
|
||||
[](https://ci-apps.yunohost.org/jenkins/job/riot%20%28Community%29/lastBuild/consoleFull)
|
||||
[](https://install-app.yunohost.org/?app=riot)
|
||||
|
||||
[](https://install-app.yunohost.org/?app=riot)
|
||||
> *This package allow you to install riot 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
|
||||
--------
|
||||
|
||||
It's a webclient for matrix. For a matrix server you can install synapse on your server : https://github.com/YunoHost-Apps/synapse_ynh
|
||||
|
||||
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/#/)
|
||||
**Shipped version:** 0.16.0
|
||||
|
||||
It's a webclient for matrix. For a matrix server you can install synapse on your server : https://github.com/YunoHost-Apps/synapse_ynh
|
||||
Screenshots
|
||||
-----------
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Demo
|
||||
----
|
||||
|
||||
* [Official demo](https://riot.im/app)
|
||||
|
||||
Documentation
|
||||
-------------
|
||||
|
||||
* Official documentation: https://about.riot.im/need-help/
|
||||
* YunoHost documentation: There no other documentations, feel free to contribute.
|
||||
|
||||
YunoHost specific features
|
||||
--------------------------
|
||||
|
||||
### Multi-users support
|
||||
|
||||
Now this application support the sso. If you want to use the sso you need to define the path to the default homeserver as your homeserver witch is installed on your yunohost instance.
|
||||
|
||||
### Supported architectures
|
||||
|
||||
* x86-64b - [/badge/icon)](https://ci-apps.yunohost.org/jenkins/job/riot%20(Community)/)
|
||||
* ARMv8-A - [%20(%7EARM%7E)/badge/icon)](https://ci-apps-arm.yunohost.org/jenkins/job/riot%20(Community)%20(%7EARM%7E)/)
|
||||
* Jessie x86-64b - [/badge/icon)](https://ci-stretch.nohost.me/jenkins/job/riot%20(Community)/)
|
||||
|
||||
<!--## Limitations
|
||||
|
||||
* Any known limitations.-->
|
||||
|
||||
Additional informations
|
||||
-----------------------
|
||||
|
||||
### Important Security Note
|
||||
|
||||
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)
|
||||
vulnerabilities that could occur if someone caused Riot to load and render
|
||||
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
|
||||
https://github.com/vector-im/riot-web/issues/1977 for more details.
|
||||
|
||||
Links
|
||||
-----
|
||||
|
||||
* Report a bug: https://github.com/YunoHost-Apps/riot_ynh/issues
|
||||
* App website: https://riot.im/
|
||||
* YunoHost website: https://yunohost.org/
|
||||
|
||||
Install
|
||||
-------
|
||||
|
|
@ -25,28 +88,18 @@ From command line:
|
|||
|
||||
`sudo yunohost app upgrade riot -u https://github.com/YunoHost-Apps/riot_ynh`
|
||||
|
||||
Issue
|
||||
-----
|
||||
Developers infos
|
||||
----------------
|
||||
|
||||
Any issue is welcome here : https://github.com/YunoHost-Apps/riot_ynh/issues
|
||||
**Only if you want to use a testing branch for coding, instead of merging directly into master.**
|
||||
Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/riot_ynh/tree/testing).
|
||||
|
||||
SSO support
|
||||
-----------
|
||||
|
||||
Now this application support the sso. If you want to use the sso you need to define the path to the default homeserver as your homeserver witch is installed on your yunohost instance.
|
||||
|
||||
Important Security Note
|
||||
-----------------------
|
||||
|
||||
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)
|
||||
vulnerabilities that could occur if someone caused Riot to load and render
|
||||
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
|
||||
https://github.com/vector-im/riot-web/issues/1977 for more details.
|
||||
To try the testing branch, please proceed like that.
|
||||
```
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/riot_ynh/tree/testing --debug
|
||||
or
|
||||
sudo yunohost app upgrade riot -u https://github.com/YunoHost-Apps/riot_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
License
|
||||
-------
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue