YunoHost-Apps/element_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/element_ynh.git synced 2024-09-03 18:36:08 +02:00
Code Issues Activity Actions

Merge branch 'testing'

Browse source
This commit is contained in:
Josué Tille 2020-08-05 23:07:48 +02:00
commit 5286d71679
No known key found for this signature in database
GPG key ID: 716A6C99B04194EF
10 changed files with 68 additions and 55 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.kateproject
View file

@ -1,5 +1,5 @@
{ {
"name": "Riot_ynh" "name": "Element_ynh"
, "files": [ { "git": 1 } ] , "files": [ { "git": 1 } ]
} }

80
README.md
View file

@ -1,10 +1,10 @@
Riot For yunohost Element For yunohost
================= =================
[![Integration level](https://dash.yunohost.org/integration/riot.svg)](https://ci-apps.yunohost.org/ci/apps/riot%20%28Community%29/lastBuild/consoleFull) [![Integration level](https://dash.yunohost.org/integration/element.svg)](https://dash.yunohost.org/appci/app/element) ![](https://ci-apps.yunohost.org/ci/badges/element.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/element.maintain.svg)
[![Install riot with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=riot) [![Install Element with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](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.* If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
Overview 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 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 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.
![](https://about.riot.im/images/home-communication.png) ![](https://element.io/images/homepage-all-platforms-1-p-800.png)
![](https://element.io/images/ios-room-chat-012x-p-500.png)
![](https://element.io/images/pixel4-rooms-light-012x-p-500.png)
#### 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
![](https://about.riot.im/images/home-integrations.png) Group chat, video calls and sharing to stay in touch and coordinate with family and friends.
#### Security ![](https://element.io/images/for-personal.png)
Keep your conversations secret. State of the art end-to-end encryption ensures that private communication stays private. ##### Revolutionise the workplace
![](https://about.riot.im/images/home-security.png) Highly effective teamwork within a company, across a business ecosystem or an entire government.
#### Open Source & Open Standard ![](https://element.io/images/temp-img-pro-use-01.png)
Open source, and built on Matrix. Own your own data by hosting your own server. ##### Host your community
![](https://about.riot.im/images/carousel-open.png) From clubs to social movements, keep everyone together with a platform everyone can use.
![](https://element.io/images/temp-community-image-02.png)
Demo Demo
---- ----
* [Official demo](https://riot.im/app) * [Official demo](https://app.element.io/)
Documentation 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 documentation: There no other documentations, feel free to contribute.
YunoHost specific features 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 ### Supported architectures
* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/riot%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/riot/) * x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/element%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/element/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/riot%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/jenkins/job/riot/) * ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/element%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/element/)
<!--## Limitations <!--## Limitations
@ -75,21 +79,31 @@ Additional informations
### Important Security Note ### 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) 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 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 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.
### 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 Links
----- -----
* Report a bug: https://github.com/YunoHost-Apps/riot_ynh/issues * Report a bug: https://github.com/YunoHost-Apps/element_ynh/issues
* App website: https://riot.im/ * App website: https://element.io/
* YunoHost website: https://yunohost.org/ * YunoHost website: https://yunohost.org/
--- ---
@ -99,31 +113,31 @@ Install
From command line: 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 Upgrade
------- -------
From command line: 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 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. 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 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 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 Todo for official App
--------------------- ---------------------

1
check_process
View file

@ -29,7 +29,6 @@
Level 1=auto Level 1=auto
Level 2=auto Level 2=auto
Level 3=auto Level 3=auto
# https://github.com/YunoHost-Apps/riot_ynh/blob/master/sources/bundle_patch.js
Level 4=1 Level 4=1
Level 5=auto Level 5=auto
Level 6=auto Level 6=auto

4
conf/app.src
View file

@ -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_URL=https://github.com/vector-im/element-web/releases/download/v1.7.2/riot-v1.7.2.tar.gz
SOURCE_SUM=bb8f897733d6ff416f7c1092b4c693ec1e6ee785e3348a07672e61d57bfc4a26 SOURCE_SUM=c3e7a9960b0b6f492b6a3f87ec20821188d3aadbb82a44b87061b022da2d5972
# (Optional) Program to check the integrity (sha256sum, md5sum...) # (Optional) Program to check the integrity (sha256sum, md5sum...)
# default: sha256 # default: sha256
SOURCE_SUM_PRG=sha256sum SOURCE_SUM_PRG=sha256sum

2
conf/config.json
View file

@ -1,7 +1,7 @@
{ {
"default_hs_url": "https://__DEFAULT_SERVER__", "default_hs_url": "https://__DEFAULT_SERVER__",
"default_is_url": "https://vector.im", "default_is_url": "https://vector.im",
"brand": "Riot", "brand": "Element",
"integrations_ui_url": "https://scalar.vector.im/", "integrations_ui_url": "https://scalar.vector.im/",
"integrations_rest_url": "https://scalar.vector.im/api", "integrations_rest_url": "https://scalar.vector.im/api",
"enableLabs": true, "enableLabs": true,

20
manifest.json
View file

@ -1,6 +1,6 @@
{ {
"name": "Riot", "name": "Element",
"id": "riot", "id": "element",
"packaging_format": 1, "packaging_format": 1,
"requirements": { "requirements": {
"yunohost": ">= 3.7.0.6" "yunohost": ">= 3.7.0.6"
@ -9,8 +9,8 @@
"en": "A web client for matrix", "en": "A web client for matrix",
"fr": "Un client web pour matrix" "fr": "Un client web pour matrix"
}, },
"version": "1.6.8~ynh1", "version": "1.7.2~ynh1",
"url": "https://riot.im", "url": "https://element.im",
"license": "Apache-2.0", "license": "Apache-2.0",
"maintainer": { "maintainer": {
"name": "Josué Tille", "name": "Josué Tille",
@ -26,8 +26,8 @@
"name": "domain", "name": "domain",
"type": "domain", "type": "domain",
"ask": { "ask": {
"en": "Choose a domain for Riot", "en": "Choose a domain for Element",
"fr": "Choisissez un domaine pour Riot" "fr": "Choisissez un domaine pour Element"
}, },
"example": "domain.org" "example": "domain.org"
}, },
@ -35,11 +35,11 @@
"name": "path", "name": "path",
"type": "path", "type": "path",
"ask": { "ask": {
"en": "Choose a path for Riot", "en": "Choose a path for Element",
"fr": "Choisissez un chemin pour Riot" "fr": "Choisissez un chemin pour Element"
}, },
"example": "/riot", "example": "/element",
"default": "/riot" "default": "/element"
}, },
{ {
"name": "default_home_server", "name": "default_home_server",

2
scripts/_common.sh
View file

@ -11,7 +11,7 @@ final_path="/var/www/$app"
# DEFINE ALL COMMON FONCTIONS # DEFINE ALL COMMON FONCTIONS
#================================================= #=================================================
config_riot() { config_element() {
cp ../conf/config.json $final_path/config.json 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 ynh_replace_string --match_string __DEFAULT_SERVER__ --replace_string $default_home_server --target_file $final_path/config.json
} }

2
scripts/backup
View file

@ -27,7 +27,7 @@ ynh_script_progression --message="Backing configuration..."
# Copy Nginx config # Copy Nginx config
ynh_backup --src_path "/etc/nginx/conf.d/${domain}.d/${app}.conf" 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_script_progression --message="Backing up the main app directory..."
ynh_backup --src_path "/var/www/$app" ynh_backup --src_path "/var/www/$app"

4
scripts/install
View file

@ -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 ynh_script_progression --message="Installing sources files..." --weight=10
install_source install_source
# Update Riot config # Update Element config
config_riot config_element
# Config nginx # Config nginx
ynh_add_nginx_config ynh_add_nginx_config

4
scripts/upgrade
View file

@ -33,8 +33,8 @@ install_source
ynh_script_progression --message="Configuring application..." ynh_script_progression --message="Configuring application..."
# Update Riot config # Update Element config
config_riot config_element
# Remove the dedicated php-fpm config # Remove the dedicated php-fpm config
ynh_remove_fpm_config ynh_remove_fpm_config