mirror of
https://github.com/YunoHost-Apps/element_ynh.git
synced 2024-09-03 18:36:08 +02:00
Auto-update README
This commit is contained in:
Yunohost-Bot
Yunohost-Bot
parent
23c19d79e9
commit
7a94a0cfdc
2 changed files with 104 additions and 93 deletions
121
README.md
121
README.md
|
|
@ -1,81 +1,40 @@
|
|||
Element For yunohost
|
||||
=================
|
||||
<!--
|
||||
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
||||
It shall NOT be edited by hand.
|
||||
-->
|
||||
|
||||
# Element for YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/element)  
|
||||
[](https://install-app.yunohost.org/?app=element)
|
||||
|
||||
> *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.*
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
Overview
|
||||
--------
|
||||
> *This package allows you to install Element quickly and simply on a YunoHost server.
|
||||
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
||||
|
||||
It's a webclient for matrix. For a matrix server you can install synapse on your server : https://github.com/YunoHost-Apps/synapse_ynh
|
||||
## Overview
|
||||
|
||||
Yunohost chattroom with matrix : [https://app.element.io/#/room/#yunohost:matrix.org](https://app.element.io/#/room/#yunohost:matrix.org)
|
||||
Element is a new type of messaging app. You choose where your messages are stored, putting you in control of your data. It gives you access to the Matrix open network, so you can talk to anyone. Element provides a new level of security, adding cross-signed device verification to default end-to-end encryption.
|
||||
|
||||
**Shipped version:** 1.8.4
|
||||
**Shipped version:** 1.8.4~ynh1
|
||||
|
||||
Screenshots
|
||||
-----------
|
||||
**Demo:** https://app.element.io/
|
||||
|
||||
#### Own your conversations
|
||||
## Screenshots
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Disclaimers / important information
|
||||
|
||||
**Element gives you the privacy you expect from a conversation in your own home, but with everyone across the globe.**
|
||||
|
||||
##### Keep it personal
|
||||
|
||||
Group chat, video calls and sharing to stay in touch and coordinate with family and friends.
|
||||
|
||||
|
||||
|
||||
##### Revolutionise the workplace
|
||||
|
||||
Highly effective teamwork within a company, across a business ecosystem or an entire government.
|
||||
|
||||
|
||||
|
||||
##### Host your community
|
||||
|
||||
From clubs to social movements, keep everyone together with a platform everyone can use.
|
||||
|
||||
|
||||
|
||||
Demo
|
||||
----
|
||||
|
||||
* [Official demo](https://app.element.io/)
|
||||
|
||||
Documentation
|
||||
-------------
|
||||
|
||||
* Official documentation: https://element.io/help
|
||||
* YunoHost documentation: There no other documentations, feel free to contribute.
|
||||
|
||||
YunoHost specific features
|
||||
--------------------------
|
||||
## 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.
|
||||
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-64 - [](https://ci-apps.yunohost.org/ci/apps/element/)
|
||||
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/element/)
|
||||
|
||||
<!--## Limitations
|
||||
|
||||
* Any known limitations.-->
|
||||
|
||||
Additional informations
|
||||
-----------------------
|
||||
## Additional informations
|
||||
|
||||
### Important Security Note
|
||||
|
||||
|
|
@ -99,33 +58,17 @@ So the process to migrate to element is the following:
|
|||
2. Remove Riot: `yunohost app remove riot`
|
||||
3. Install Element: `yunohost app install element`
|
||||
|
||||
Links
|
||||
-----
|
||||
## Documentation and resources
|
||||
|
||||
* Report a bug: https://github.com/YunoHost-Apps/element_ynh/issues
|
||||
* App website: https://element.io/
|
||||
* YunoHost website: https://yunohost.org/
|
||||
* Official app website: https://element.io
|
||||
* Official admin documentation: https://element.io/help
|
||||
* Upstream app code repository: https://github.com/vector-im/element-web/
|
||||
* YunoHost documentation for this app: https://yunohost.org/app_element
|
||||
* Report a bug: https://github.com/YunoHost-Apps/element_ynh/issues
|
||||
|
||||
---
|
||||
## Developer info
|
||||
|
||||
Install
|
||||
-------
|
||||
|
||||
From command line:
|
||||
|
||||
`sudo yunohost app install -l element https://github.com/YunoHost-Apps/element_ynh`
|
||||
|
||||
Upgrade
|
||||
-------
|
||||
|
||||
From command line:
|
||||
|
||||
`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/element_ynh/tree/testing).
|
||||
Please send 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.
|
||||
```
|
||||
|
|
@ -134,12 +77,4 @@ or
|
|||
sudo yunohost app upgrade element -u https://github.com/YunoHost-Apps/element_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
Element-Web is published under the Apache License : https://github.com/vector-im/riot-web/blob/master/LICENSE
|
||||
|
||||
Todo for official App
|
||||
---------------------
|
||||
|
||||
- Improve documentation
|
||||
**More info regarding app packaging:** https://yunohost.org/packaging_apps
|
||||
76
README_fr.md
Normal file
76
README_fr.md
Normal file
|
|
@ -0,0 +1,76 @@
|
|||
# Element pour YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/element)  
|
||||
[](https://install-app.yunohost.org/?app=element)
|
||||
|
||||
*[Read this readme in english.](./README.md)*
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
> *Ce package vous permet d'installer Element rapidement et simplement sur un serveur YunoHost.
|
||||
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
|
||||
|
||||
## Vue d'ensemble
|
||||
|
||||
Element is a new type of messaging app. You choose where your messages are stored, putting you in control of your data. It gives you access to the Matrix open network, so you can talk to anyone. Element provides a new level of security, adding cross-signed device verification to default end-to-end encryption.
|
||||
|
||||
**Version incluse :** 1.8.4~ynh1
|
||||
|
||||
**Démo :** https://app.element.io/
|
||||
|
||||
## Captures d'écran
|
||||
|
||||
|
||||
|
||||
## Avertissements / informations importantes
|
||||
|
||||
|
||||
## 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.
|
||||
|
||||
## Additional informations
|
||||
|
||||
### Important Security Note
|
||||
|
||||
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 Element to load and render
|
||||
malicious user generated content from a Matrix API which then had trusted
|
||||
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`
|
||||
|
||||
## Documentations et ressources
|
||||
|
||||
* Site officiel de l'app : https://element.io
|
||||
* Documentation officielle de l'admin : https://element.io/help
|
||||
* Dépôt de code officiel de l'app : https://github.com/vector-im/element-web/
|
||||
* Documentation YunoHost pour cette app : https://yunohost.org/app_element
|
||||
* Signaler un bug : https://github.com/YunoHost-Apps/element_ynh/issues
|
||||
|
||||
## Informations pour les développeurs
|
||||
|
||||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/element_ynh/tree/testing).
|
||||
|
||||
Pour essayer la branche testing, procédez comme suit.
|
||||
```
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/element_ynh/tree/testing --debug
|
||||
ou
|
||||
sudo yunohost app upgrade element -u https://github.com/YunoHost-Apps/element_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps
|
||||
Loading…
Add table
Reference in a new issue