diff --git a/README.md b/README.md index 977af9a..bbc195a 100644 --- a/README.md +++ b/README.md @@ -3,14 +3,15 @@ [![Integration level](https://dash.yunohost.org/integration/roundcube.svg)](https://dash.yunohost.org/appci/app/roundcube) ![](https://ci-apps.yunohost.org/ci/badges/roundcube.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/roundcube.maintain.svg) [![Install Roundcube with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=roundcube) +*[Lire ce readme en français.](./README_fr.md)* + > *This package allow you to install Roundcube 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 -[Roundcube](https://roundcube.net/) is a browser-based multilingual IMAP client with -an application-like user interface. +[Roundcube](https://roundcube.net/) is a browser-based multilingual IMAP client with an application-like user interface. -**Shipped version:** 1.4.7 +**Shipped version:** 1.4.9 ## Screenshots @@ -31,21 +32,14 @@ You can extend - or even override - the Roundcube configuration which is coming ## YunoHost specific features -In addition to Roundcube core features, the following are made available with -this package: +In addition to Roundcube core features, the following are made available with this package: * Synchronize your email aliases as identities in Roundcube - * Install the [contextmenu](https://plugins.roundcube.net/packages/johndoh/contextmenu) - and [automatic addressbook](https://plugins.roundcube.net/packages/sblaisot/automatic_addressbook) - plugins by default - * Allow to install the [CardDAV](https://plugins.roundcube.net/packages/roundcube/carddav) - (address book) synchronization plugin at the installation - note that if - you have installed ownCloud or Baïkal, it will automatically add the - corresponding and existing address book. + * Install the [contextmenu](https://plugins.roundcube.net/packages/johndoh/contextmenu) and [automatic addressbook](https://plugins.roundcube.net/packages/sblaisot/automatic_addressbook) plugins by default + * Allow to install the [CardDAV](https://plugins.roundcube.net/packages/roundcube/carddav) (address book) synchronization plugin at the installation - note that if you have installed Nextcloud or Baïkal, it will automatically add the corresponding and existing address book. #### Multi-users support -* Integrate with YunoHost users and SSO - i.e logout button, YunoHost users - search +* Integrate with YunoHost users and SSO - i.e logout button, YunoHost users search #### Supported architectures @@ -60,13 +54,11 @@ this package: #### Plugins -You can also install other plugins - which will not be removed with upgrades. To do so, -you can use the official [Plugin Repository](https://plugins.roundcube.net/). +You can also install other plugins - which will not be removed with upgrades. To do so, you can use the official [Plugin Repository](https://plugins.roundcube.net/). ##### From the Plugin Repository -Let's say for example that we want to install the -[html5_notifier](https://plugins.roundcube.net/packages/kitist/html5_notifier) plugin. +Let's say for example that we want to install the [html5_notifier](https://plugins.roundcube.net/packages/kitist/html5_notifier) plugin. 1. Connect to your server as root using SSH: ``` @@ -74,33 +66,28 @@ Let's say for example that we want to install the $ sudo -i ``` -2. Log in as the `roundcube` user - which owns the roundcube directory - and navigate - in it: +2. Log in as the `roundcube` user - which owns the roundcube directory - and navigate in it: ``` # su -s /bin/bash - roundcube $ cd /var/www/roundcube ``` -3. Install the plugin you want using composer - note that you have to specify - *kitist/html5_notifier* and not only *html5_notifier*: +3. Install the plugin you want using composer - note that you have to specify *kitist/html5_notifier* and not only *html5_notifier*: ``` $ COMPOSER_HOME=./.composer php composer.phar require "kitist/html5_notifier" ``` -4. Enable it in the local configuration file `conf/local.inc.php` using your - favorite text editor by adding: +4. Enable it in the local configuration file `conf/local.inc.php` using your favorite text editor by adding: ``` *Ce package vous permet d'installer Roundcube rapidement et simplement sur un serveur YunoHost. +Si vous n'avez pas YunoHost, consultez [le guide](https://yunohost.org/#/install) pour apprendre comment l'installer.* + +## Overview +[Roundcube](https://roundcube.net/) est un client IMAP multilingue basé sur un navigateur avec une interface utilisateur semblable à une application. + +**Shipped version:** 1.4.9 + +## Screenshots + +![](https://roundcube.net/screens/skins/elastic/desktop/screens/mailbox_widescreen.png) + +## Démo + +* [Démo YunoHost](https://demo.yunohost.org/webmail/) + +## Configuration + +Vous pouvez étendre (ou même remplacer) la configuration de Roundcube fournie avec ce paquet dans le fichier `conf/local.inc.php`. Ne modifiez pas le fichier `conf/config.inc.php` car les futures mises à jour le remplaceront. + +## Documentation + + * Documentation officielle : https://github.com/roundcube/roundcubemail/wiki + * Documentation YunoHost : https://github.com/YunoHost/doc/blob/master/app_roundcube.md: + +## Caractéristiques spécifiques YunoHost + +En plus des fonctionnalités principales de Roundcube, les éléments suivants sont disponibles avec ce paquet : + + * Synchronisez vos alias de messagerie en tant qu'identités dans Roundcube. + * Installation des plugins [contextmenu](https://plugins.roundcube.net/packages/johndoh/contextmenu) + et [automatic addressbook](https://plugins.roundcube.net/packages/sblaisot/automatic_addressbook) par default. + * Permettre d'installer [CardDAV](https://plugins.roundcube.net/packages/roundcube/carddav) (carnet d'adresses) de synchronisation à l'installation - notez que si vous avez installé Nextcloud ou Baïkal, il ajoutera automatiquement le carnet d'adresses correspondant. + +#### Support multi-utilisateur + +* Intégration avec les utilisateurs YunoHost et SSO - c'est-à-dire le bouton de déconnexion, reconnaissance des autres utilisateurs de l'instance YunoHost. + +#### Supported architectures + +* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/roundcube%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/roundcube/) +* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/roundcube%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/roundcube/) + +## Limitations + +* Aucune limitation connue. + +## Additional information + +#### Plugins + +Vous pouvez également installer d'autres plugins (qui ne seront pas supprimés avec les mises à niveau). Pour cela, vous pouvez utiliser le [Plugin Repository](https://plugins.roundcube.net/) officiel. + +##### Depuis le dépôt de plugins + +Si, par exemple, vous voulez installer le plugin [html5_notifier](https://plugins.roundcube.net/packages/kitist/html5_notifier). + +1. Connectez-vous en SSH à votre serveur en tant que root : + ``` + $ ssh admin@1.2.3.4 + $ sudo -i + ``` + +2. Connectez-vous en tant qu'utilisateur `roundcube` (qui possède le répertoire roundcube) et naviguez dedans : + ``` + # su -s /bin/bash - roundcube + $ cd /var/www/roundcube + ``` + +3. Installez le plugin que vous voulez en utilisant Composer - notez que vous devez spécifier + *kitist/html5_notifier* et pas seulement *html5_notifier* : + ``` + $ COMPOSER_HOME=./.composer php composer.phar require "kitist/html5_notifier" + ``` + +4. Activez-le dans le fichier de configuration local `conf/local.inc.php` en utilisant un éditeur de texte en ajoutant : + ``` +