mirror of
https://github.com/YunoHost-Apps/rainloop_ynh.git
synced 2024-09-03 20:16:18 +02:00
Auto-update README
This commit is contained in:
parent
5b0eb0971b
commit
afb905b1d4
2 changed files with 36 additions and 109 deletions
73
README.md
73
README.md
|
@ -1,3 +1,8 @@
|
||||||
|
<!--
|
||||||
|
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.
|
||||||
|
-->
|
||||||
|
|
||||||
# Rainloop for YunoHost
|
# Rainloop for YunoHost
|
||||||
|
|
||||||
[![Integration level](https://dash.yunohost.org/integration/rainloop.svg)](https://dash.yunohost.org/appci/app/rainloop) ![](https://ci-apps.yunohost.org/ci/badges/rainloop.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/rainloop.maintain.svg)
|
[![Integration level](https://dash.yunohost.org/integration/rainloop.svg)](https://dash.yunohost.org/appci/app/rainloop) ![](https://ci-apps.yunohost.org/ci/badges/rainloop.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/rainloop.maintain.svg)
|
||||||
|
@ -5,70 +10,28 @@
|
||||||
|
|
||||||
*[Lire ce readme en français.](./README_fr.md)*
|
*[Lire ce readme en français.](./README_fr.md)*
|
||||||
|
|
||||||
> *This package allow you to install Rainloop quickly and simply on a YunoHost server.
|
> *This package allows you to install Rainloop 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 consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
Rainloop is a lightweight webmail.
|
Lightweight multi-account webmail
|
||||||
|
|
||||||
**Shipped version:** 1.16.0
|
**Shipped version:** 1.16.0~ynh1
|
||||||
|
|
||||||
## Screenshots
|
**Demo:** https://mail.rainloop.net/
|
||||||
|
|
||||||
![](https://www.rainloop.net/static/media/screenshots/v2/12.png)
|
## Documentation and resources
|
||||||
|
|
||||||
## Demo
|
|
||||||
|
|
||||||
* [YunoHost demo](https://demo.yunohost.org/rainloop/app/)
|
|
||||||
* [Official demo](https://mail.rainloop.net/)
|
|
||||||
|
|
||||||
## Configuration
|
|
||||||
|
|
||||||
Go to http://DOMAIN.TLD/rainloop/app/?admin
|
|
||||||
|
|
||||||
- The default login: admin
|
|
||||||
- The default password: password chosen during install
|
|
||||||
|
|
||||||
- If you lost the admin password, you can retrieve it using `sudo yunohost app setting rainloop password`
|
|
||||||
|
|
||||||
Each user can add a remote carddav server from their own parameters interface.
|
|
||||||
|
|
||||||
- If you use Baïkal, the CardDav address is `https://DOMAIN.TLD/baikal/card.php/addressbooks/USER/default/`
|
|
||||||
- If you use Nextcloud, the CardDav address is `https://DOMAIN.TLD/nextcloud/remote.php/carddav/addressbooks/USER/contacts`
|
|
||||||
|
|
||||||
## Documentation
|
|
||||||
|
|
||||||
* Official documentation: https://www.rainloop.net/docs/configuration/
|
|
||||||
* YunoHost documentation: https://yunohost.org/en/app_rainloop
|
|
||||||
|
|
||||||
## YunoHost specific features
|
|
||||||
|
|
||||||
#### Multi-users support
|
|
||||||
|
|
||||||
#### Supported architectures
|
|
||||||
|
|
||||||
* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/rainloop.svg)](https://ci-apps.yunohost.org/ci/apps/rainloop/)
|
|
||||||
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/rainloop.svg)](https://ci-apps-arm.yunohost.org/ci/apps/rainloop/)
|
|
||||||
|
|
||||||
## Limitations
|
|
||||||
|
|
||||||
## Additional information
|
|
||||||
|
|
||||||
* Rainloop saves your PGP private keys in the browser storage. This means that you will loose your private keys if you clear your browser storage (e.g., private browsing, different computer...). This packages integrates [PGPback by chtixof](https://github.com/chtixof/pgpback_ynh) so you can store your PGP private keys on the server securely. Go to **http://DOMAIN.TLD/rainloop/pgpback** to backup your PGP keys on the server or restore them.
|
|
||||||
|
|
||||||
## Links
|
|
||||||
|
|
||||||
|
* Official app website: https://www.rainloop.net/
|
||||||
|
* Official admin documentation: https://www.rainloop.net/docs/configuration/
|
||||||
|
* Upstream app code repository: https://github.com/RainLoop/rainloop-webmail
|
||||||
|
* YunoHost documentation for this app: https://yunohost.org/app_rainloop
|
||||||
* Report a bug: https://github.com/YunoHost-Apps/rainloop_ynh/issues
|
* Report a bug: https://github.com/YunoHost-Apps/rainloop_ynh/issues
|
||||||
* Rainloop website: https://www.rainloop.net/
|
|
||||||
* Rainloop GitHub website: https://github.com/RainLoop/rainloop-webmail
|
|
||||||
* YunoHost website: https://yunohost.org/
|
|
||||||
|
|
||||||
---
|
## Developer info
|
||||||
|
|
||||||
## Developers info
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/rainloop_ynh/tree/testing).
|
||||||
|
|
||||||
Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/rainloop_ynh/tree/testing).
|
|
||||||
|
|
||||||
To try the testing branch, please proceed like that.
|
To try the testing branch, please proceed like that.
|
||||||
```
|
```
|
||||||
|
@ -76,3 +39,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/rainloop_ynh/tree/tes
|
||||||
or
|
or
|
||||||
sudo yunohost app upgrade rainloop -u https://github.com/YunoHost-Apps/rainloop_ynh/tree/testing --debug
|
sudo yunohost app upgrade rainloop -u https://github.com/YunoHost-Apps/rainloop_ynh/tree/testing --debug
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**More info regarding app packaging:** https://yunohost.org/packaging_apps
|
66
README_fr.md
66
README_fr.md
|
@ -1,69 +1,29 @@
|
||||||
# Rainloop pour YunoHost
|
# Rainloop pour YunoHost
|
||||||
|
|
||||||
[![Integration level](https://dash.yunohost.org/integration/rainloop.svg)](https://dash.yunohost.org/appci/app/rainloop) ![](https://ci-apps.yunohost.org/ci/badges/rainloop.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/rainloop.maintain.svg)
|
[![Niveau d'intégration](https://dash.yunohost.org/integration/rainloop.svg)](https://dash.yunohost.org/appci/app/rainloop) ![](https://ci-apps.yunohost.org/ci/badges/rainloop.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/rainloop.maintain.svg)
|
||||||
[![Installer Rainloop avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=rainloop)
|
[![Installer Rainloop avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=rainloop)
|
||||||
|
|
||||||
*[Read this readme in english.](./README.md)*
|
*[Read this readme in english.](./README.md)*
|
||||||
|
*[Lire ce readme en français.](./README_fr.md)*
|
||||||
|
|
||||||
> *Ce package vous permet d'installer Rainloop rapidement et simplement sur un serveur YunoHost.
|
> *Ce package vous permet d'installer Rainloop 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.*
|
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
|
||||||
|
|
||||||
## Vue d'ensemble
|
## Vue d'ensemble
|
||||||
|
|
||||||
Rainloop est un webmail léger.
|
Webmail léger multi-comptes
|
||||||
|
|
||||||
**Version incluse:** 1.16.0
|
**Version incluse :** 1.16.0~ynh1
|
||||||
|
|
||||||
## Captures d'écran
|
**Démo :** https://mail.rainloop.net/
|
||||||
|
|
||||||
![](https://www.rainloop.net/static/media/screenshots/v2/12.png)
|
## Documentations et ressources
|
||||||
|
|
||||||
## Démo
|
* Site officiel de l'app : https://www.rainloop.net/
|
||||||
|
* Documentation officielle de l'admin : https://www.rainloop.net/docs/configuration/
|
||||||
* [Démo YunoHost](https://demo.yunohost.org/rainloop/app/)
|
* Dépôt de code officiel de l'app : https://github.com/RainLoop/rainloop-webmail
|
||||||
* [Démo officielle](https://mail.rainloop.net/)
|
* Documentation YunoHost pour cette app : https://yunohost.org/app_rainloop
|
||||||
|
* Signaler un bug : https://github.com/YunoHost-Apps/rainloop_ynh/issues
|
||||||
## Configuration
|
|
||||||
|
|
||||||
Veuillez vous rendre sur http://DOMAIN.TLD/rainloop/app/?admin
|
|
||||||
|
|
||||||
- Le nom d'utilisateur admin par défaut : admin
|
|
||||||
- Le mot de passe admin par défaut : Mot de passe choisi lors de l'installation
|
|
||||||
- Si vous avez oublié votre mot de passe, vous pouvez le retrouver avec `sudo yunohost app setting rainloop password`
|
|
||||||
|
|
||||||
Chaque utilisateur peut ajouter un carnet d'adresse distant CardDav via leurs propres paramètres.
|
|
||||||
|
|
||||||
- Si vous utilisez Baïkal, l'adresse à renseigner est du type `https://DOMAIN.TLD/baikal/card.php/addressbooks/UTILISATEUR/default`
|
|
||||||
- Si vous utilisez Nextcloud, l'adresse à renseigner est du type `https://DOMAIN.TLD/nextcloud/remote.php/carddav/addressbooks/USER/contacts`
|
|
||||||
|
|
||||||
## Documentation
|
|
||||||
|
|
||||||
* Documentation officielle : https://www.rainloop.net/docs/configuration/
|
|
||||||
* Documentation YunoHost : https://yunohost.org/fr/app_rainloop
|
|
||||||
|
|
||||||
## Caractéristiques spécifiques YunoHost
|
|
||||||
|
|
||||||
#### Support multi-utilisateurs
|
|
||||||
|
|
||||||
#### Supported architectures
|
|
||||||
|
|
||||||
* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/rainloop.svg)](https://ci-apps.yunohost.org/ci/apps/rainloop/)
|
|
||||||
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/rainloop.svg)](https://ci-apps-arm.yunohost.org/ci/apps/rainloop/)
|
|
||||||
|
|
||||||
## Limitations
|
|
||||||
|
|
||||||
## Informations additionnelles
|
|
||||||
|
|
||||||
* Rainloop stocke les clés PGP privées dans le stockage de navigateur. Cela implique que vos clés seront perdues quand vous videz le stockage de navigateur (navigation incognito, changement d'ordinateur...). Ce paquet intègre [PGPback de chtixof](https://github.com/chtixof/pgpback_ynh) pour que vous puissiez stocker vos clés privées PGP de manière sécurisée sur le serveur. Rendez-vous **http://DOMAIN.TLD/rainloop/pgpback** pour stocker vos clés privées PGP sur le serveur ou les restaurer dans un nouveau navigateur.
|
|
||||||
|
|
||||||
## Links
|
|
||||||
|
|
||||||
* Signaler un bug : https://github.com/YunoHost-Apps/rainloop_ynh/issues
|
|
||||||
* Site de Rainloop : https://www.rainloop.net/
|
|
||||||
* GitHub de Rainloop : https://github.com/RainLoop/rainloop-webmail
|
|
||||||
* Site web YunoHost : https://yunohost.org/
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Informations pour les développeurs
|
## Informations pour les développeurs
|
||||||
|
|
||||||
|
@ -75,3 +35,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/rainloop_ynh/tree/tes
|
||||||
ou
|
ou
|
||||||
sudo yunohost app upgrade rainloop -u https://github.com/YunoHost-Apps/rainloop_ynh/tree/testing --debug
|
sudo yunohost app upgrade rainloop -u https://github.com/YunoHost-Apps/rainloop_ynh/tree/testing --debug
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps
|
Loading…
Reference in a new issue