mirror of
https://github.com/YunoHost-Apps/roundcube_ynh.git
synced 2024-09-03 20:16:28 +02:00
81 lines
2.6 KiB
Markdown
81 lines
2.6 KiB
Markdown
Roundcube for YunoHost
|
|
----------------------
|
|
|
|
[Roundcube](https://roundcube.net/) is a browser-based multilingual IMAP client with
|
|
an application-like user interface.
|
|
|
|
**Shipped version:** 1.2.0
|
|
|
|
## Features
|
|
|
|
In addition to Roundcube core features, the following are made available with
|
|
this package:
|
|
|
|
* Integrate with YunoHost users and SSO - i.e. logout button, YunoHost users
|
|
search
|
|
* 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.
|
|
|
|
## Extend and tweak
|
|
|
|
### Configuration
|
|
|
|
You can extend - or even override - the Roundcube configuration which is coming
|
|
with this package in the file `conf/local.inc.php`. Do not edit the file
|
|
`conf/config.inc.php` as it will be overriden with upgrades.
|
|
|
|
### Plugins
|
|
|
|
You can also install other plugins - which will not 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.
|
|
|
|
1. Connect to your server as root using SSH:
|
|
```
|
|
$ ssh admin@1.2.3.4
|
|
$ sudo -i
|
|
```
|
|
|
|
2. Log as the `www-data` user - which owns the roundcube directory - and navigate
|
|
under it:
|
|
```
|
|
# su -s /bin/bash - www-data
|
|
$ 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*:
|
|
```
|
|
$ COMPOSER_HOME=./.composer php composer.phar require "kitist/html5_notifier"
|
|
```
|
|
|
|
4. Enable it in the local configuration file `conf/local.inc.php` using you're
|
|
favorite text editor by adding:
|
|
```
|
|
<?php
|
|
$config['plugins'][] = 'html5_notifier';
|
|
```
|
|
|
|
Note that you should also check the plugin homepage for additional installation
|
|
steps as needed.
|
|
|
|
#### Manual installation
|
|
|
|
You can also download the plugin and put it under the `plugins/` directory. In that
|
|
case, do not forget to change ownerships to this folder to `www-data`.
|
|
|
|
## Links
|
|
|
|
* Report a bug: https://dev.yunohost.org/projects/apps/issues
|
|
* Roundcube website: https://roundcube.net/
|
|
* YunoHost website: https://yunohost.org/
|