mirror of
https://github.com/YunoHost-Apps/element_ynh.git
synced 2024-09-03 18:36:08 +02:00
Merge branch 'testing'
This commit is contained in:
commit
5286d71679
10 changed files with 68 additions and 55 deletions
|
@ -1,5 +1,5 @@
|
|||
{
|
||||
"name": "Riot_ynh"
|
||||
"name": "Element_ynh"
|
||||
, "files": [ { "git": 1 } ]
|
||||
}
|
||||
|
||||
|
|
80
README.md
80
README.md
|
@ -1,10 +1,10 @@
|
|||
Riot For yunohost
|
||||
Element For yunohost
|
||||
=================
|
||||
|
||||
[](https://ci-apps.yunohost.org/ci/apps/riot%20%28Community%29/lastBuild/consoleFull)
|
||||
[](https://install-app.yunohost.org/?app=riot)
|
||||
[](https://dash.yunohost.org/appci/app/element)  
|
||||
[](https://install-app.yunohost.org/?app=element)
|
||||
|
||||
> *This package allow you to install riot quickly and simply on a YunoHost server.
|
||||
> *This package allow you to install Element 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
|
||||
|
@ -12,46 +12,50 @@ 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 chattroom with matrix : [https://app.element.io/#/room/#yunohost:matrix.org](https://app.element.io/#/room/#yunohost:matrix.org)
|
||||
|
||||
**Shipped version:** 1.6.8
|
||||
**Shipped version:** 1.7.2
|
||||
|
||||
Screenshots
|
||||
-----------
|
||||
|
||||
#### Modern Communication
|
||||
#### Own your conversations
|
||||
|
||||
Organise rooms around whatever team, community purpose you like! Chat, share files, add widgets, and make video/voice calls and conferences.
|
||||
All-in-one secure chat app for teams, friends and organisations. Keeps conversations in your control, safe from data-mining and ads. Talk to everyone through the open global Matrix network, protected by proper end-to-end encryption.
|
||||
|
||||

|
||||

|
||||

|
||||

|
||||
|
||||
#### Integrations
|
||||
**Element gives you the privacy you expect from a conversation in your own home, but with everyone across the globe.**
|
||||
|
||||
Channel data to and from tools you already use and love, even bridging in users and groups from other chat apps.
|
||||
##### Keep it personal
|
||||
|
||||

|
||||
Group chat, video calls and sharing to stay in touch and coordinate with family and friends.
|
||||
|
||||
#### Security
|
||||

|
||||
|
||||
Keep your conversations secret. State of the art end-to-end encryption ensures that private communication stays private.
|
||||
##### Revolutionise the workplace
|
||||
|
||||

|
||||
Highly effective teamwork within a company, across a business ecosystem or an entire government.
|
||||
|
||||
#### Open Source & Open Standard
|
||||

|
||||
|
||||
Open source, and built on Matrix. Own your own data by hosting your own server.
|
||||
##### Host your community
|
||||
|
||||

|
||||
From clubs to social movements, keep everyone together with a platform everyone can use.
|
||||
|
||||

|
||||
|
||||
Demo
|
||||
----
|
||||
|
||||
* [Official demo](https://riot.im/app)
|
||||
* [Official demo](https://app.element.io/)
|
||||
|
||||
Documentation
|
||||
-------------
|
||||
|
||||
* Official documentation: https://about.riot.im/need-help/
|
||||
* Official documentation: https://element.io/help
|
||||
* YunoHost documentation: There no other documentations, feel free to contribute.
|
||||
|
||||
YunoHost specific features
|
||||
|
@ -63,8 +67,8 @@ Now this application support the sso. If you want to use the sso you need to def
|
|||
|
||||
### Supported architectures
|
||||
|
||||
* x86-64b - [](https://ci-apps.yunohost.org/ci/apps/riot/)
|
||||
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/jenkins/job/riot/)
|
||||
* x86-64 - [](https://ci-apps.yunohost.org/ci/apps/element/)
|
||||
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/element/)
|
||||
|
||||
<!--## Limitations
|
||||
|
||||
|
@ -75,21 +79,31 @@ Additional informations
|
|||
|
||||
### Important Security Note
|
||||
|
||||
We do not recommend running Riot from the same domain name as your Matrix
|
||||
We do not recommend running Element 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
|
||||
vulnerabilities that could occur if someone caused Element 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.
|
||||
access to Element (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.
|
||||
|
||||
### Migration from old app name "Riot"
|
||||
|
||||
As this app don't contains any data on the server side no migration was made to migrate from "Riot" to "Element".
|
||||
So you just will need to remove Riot and install Element on the same domain (you can change the path) to be able to keep the data on your web browser.
|
||||
So the process to migrate to element is the following:
|
||||
|
||||
1. Get the domain of "Riot": `yunohost app setting riot domain`
|
||||
2. Remove Riot: `yunohost app remove riot`
|
||||
3. Install Element: `yunohost app install element`
|
||||
|
||||
Links
|
||||
-----
|
||||
|
||||
* Report a bug: https://github.com/YunoHost-Apps/riot_ynh/issues
|
||||
* App website: https://riot.im/
|
||||
* Report a bug: https://github.com/YunoHost-Apps/element_ynh/issues
|
||||
* App website: https://element.io/
|
||||
* YunoHost website: https://yunohost.org/
|
||||
|
||||
---
|
||||
|
@ -99,31 +113,31 @@ Install
|
|||
|
||||
From command line:
|
||||
|
||||
`sudo yunohost app install -l riot https://github.com/YunoHost-Apps/riot_ynh`
|
||||
`sudo yunohost app install -l element https://github.com/YunoHost-Apps/element_ynh`
|
||||
|
||||
Upgrade
|
||||
-------
|
||||
|
||||
From command line:
|
||||
|
||||
`sudo yunohost app upgrade riot -u https://github.com/YunoHost-Apps/riot_ynh`
|
||||
`sudo yunohost app upgrade element -u https://github.com/YunoHost-Apps/element_ynh`
|
||||
|
||||
Developers infos
|
||||
----------------
|
||||
|
||||
Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/riot_ynh/tree/testing).
|
||||
Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/element_ynh/tree/testing).
|
||||
|
||||
To try the testing branch, please proceed like that.
|
||||
```
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/riot_ynh/tree/testing --debug
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/element_ynh/tree/testing --debug
|
||||
or
|
||||
sudo yunohost app upgrade riot -u https://github.com/YunoHost-Apps/riot_ynh/tree/testing --debug
|
||||
sudo yunohost app upgrade element -u https://github.com/YunoHost-Apps/element_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
Riot-Web is published under the Apache License : https://github.com/vector-im/riot-web/blob/master/LICENSE
|
||||
Element-Web is published under the Apache License : https://github.com/vector-im/riot-web/blob/master/LICENSE
|
||||
|
||||
Todo for official App
|
||||
---------------------
|
||||
|
|
|
@ -29,7 +29,6 @@
|
|||
Level 1=auto
|
||||
Level 2=auto
|
||||
Level 3=auto
|
||||
# https://github.com/YunoHost-Apps/riot_ynh/blob/master/sources/bundle_patch.js
|
||||
Level 4=1
|
||||
Level 5=auto
|
||||
Level 6=auto
|
||||
|
@ -39,4 +38,4 @@
|
|||
Level 10=0
|
||||
;;; Upgrade options
|
||||
; commit=f39b77ae010dc6ed197b4b8e92110bede6ed4e07
|
||||
name=Before sso Support and refactoring
|
||||
name=Before sso Support and refactoring
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
SOURCE_URL=https://github.com/vector-im/riot-web/releases/download/v1.6.8/riot-v1.6.8.tar.gz
|
||||
SOURCE_SUM=bb8f897733d6ff416f7c1092b4c693ec1e6ee785e3348a07672e61d57bfc4a26
|
||||
SOURCE_URL=https://github.com/vector-im/element-web/releases/download/v1.7.2/riot-v1.7.2.tar.gz
|
||||
SOURCE_SUM=c3e7a9960b0b6f492b6a3f87ec20821188d3aadbb82a44b87061b022da2d5972
|
||||
# (Optional) Program to check the integrity (sha256sum, md5sum...)
|
||||
# default: sha256
|
||||
SOURCE_SUM_PRG=sha256sum
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
{
|
||||
"default_hs_url": "https://__DEFAULT_SERVER__",
|
||||
"default_is_url": "https://vector.im",
|
||||
"brand": "Riot",
|
||||
"brand": "Element",
|
||||
"integrations_ui_url": "https://scalar.vector.im/",
|
||||
"integrations_rest_url": "https://scalar.vector.im/api",
|
||||
"enableLabs": true,
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "Riot",
|
||||
"id": "riot",
|
||||
"name": "Element",
|
||||
"id": "element",
|
||||
"packaging_format": 1,
|
||||
"requirements": {
|
||||
"yunohost": ">= 3.7.0.6"
|
||||
|
@ -9,8 +9,8 @@
|
|||
"en": "A web client for matrix",
|
||||
"fr": "Un client web pour matrix"
|
||||
},
|
||||
"version": "1.6.8~ynh1",
|
||||
"url": "https://riot.im",
|
||||
"version": "1.7.2~ynh1",
|
||||
"url": "https://element.im",
|
||||
"license": "Apache-2.0",
|
||||
"maintainer": {
|
||||
"name": "Josué Tille",
|
||||
|
@ -26,8 +26,8 @@
|
|||
"name": "domain",
|
||||
"type": "domain",
|
||||
"ask": {
|
||||
"en": "Choose a domain for Riot",
|
||||
"fr": "Choisissez un domaine pour Riot"
|
||||
"en": "Choose a domain for Element",
|
||||
"fr": "Choisissez un domaine pour Element"
|
||||
},
|
||||
"example": "domain.org"
|
||||
},
|
||||
|
@ -35,11 +35,11 @@
|
|||
"name": "path",
|
||||
"type": "path",
|
||||
"ask": {
|
||||
"en": "Choose a path for Riot",
|
||||
"fr": "Choisissez un chemin pour Riot"
|
||||
"en": "Choose a path for Element",
|
||||
"fr": "Choisissez un chemin pour Element"
|
||||
},
|
||||
"example": "/riot",
|
||||
"default": "/riot"
|
||||
"example": "/element",
|
||||
"default": "/element"
|
||||
},
|
||||
{
|
||||
"name": "default_home_server",
|
||||
|
|
|
@ -11,7 +11,7 @@ final_path="/var/www/$app"
|
|||
# DEFINE ALL COMMON FONCTIONS
|
||||
#=================================================
|
||||
|
||||
config_riot() {
|
||||
config_element() {
|
||||
cp ../conf/config.json $final_path/config.json
|
||||
ynh_replace_string --match_string __DEFAULT_SERVER__ --replace_string $default_home_server --target_file $final_path/config.json
|
||||
}
|
||||
|
|
|
@ -27,7 +27,7 @@ ynh_script_progression --message="Backing configuration..."
|
|||
# Copy Nginx config
|
||||
ynh_backup --src_path "/etc/nginx/conf.d/${domain}.d/${app}.conf"
|
||||
|
||||
# Backup riot files
|
||||
# Backup element files
|
||||
ynh_script_progression --message="Backing up the main app directory..."
|
||||
ynh_backup --src_path "/var/www/$app"
|
||||
|
||||
|
|
|
@ -42,8 +42,8 @@ ynh_app_setting_set --app $app --key final_path --value $final_path
|
|||
ynh_script_progression --message="Installing sources files..." --weight=10
|
||||
install_source
|
||||
|
||||
# Update Riot config
|
||||
config_riot
|
||||
# Update Element config
|
||||
config_element
|
||||
|
||||
# Config nginx
|
||||
ynh_add_nginx_config
|
||||
|
|
|
@ -33,8 +33,8 @@ install_source
|
|||
|
||||
ynh_script_progression --message="Configuring application..."
|
||||
|
||||
# Update Riot config
|
||||
config_riot
|
||||
# Update Element config
|
||||
config_element
|
||||
|
||||
# Remove the dedicated php-fpm config
|
||||
ynh_remove_fpm_config
|
||||
|
|
Loading…
Add table
Reference in a new issue