1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/roundcube_ynh.git synced 2024-09-03 20:16:28 +02:00

Add templates

This commit is contained in:
ericgaspar 2021-05-28 22:06:42 +02:00
parent 5c1d372e33
commit da0849b08e
No known key found for this signature in database
GPG key ID: 574F281483054D44
6 changed files with 184 additions and 2 deletions

55
.github/ISSUE_TEMPLATE.md vendored Normal file
View file

@ -0,0 +1,55 @@
---
name: Bug report
about: When creating a bug report, please use the following template to provide all the relevant information and help debugging efficiently.
---
**How to post a meaningful bug report**
1. *Read this whole template first.*
2. *Determine if you are on the right place:*
- *If you were performing an action on the app from the webadmin or the CLI (install, update, backup, restore, change_url...), you are on the right place!*
- *Otherwise, the issue may be due to the app itself. Refer to its documentation or repository for help.*
- *When in doubt, post here and we will figure it out together.*
3. *Delete the italic comments as you write over them below, and remove this guide.*
---
### Describe the bug
*A clear and concise description of what the bug is.*
### Context
- Hardware: *VPS bought online / Old laptop or computer / Raspberry Pi at home / Internet Cube with VPN / Other ARM board / ...*
- YunoHost version: x.x.x
- I have access to my server: *Through SSH | through the webadmin | direct access via keyboard / screen | ...*
- Are you in a special context or did you perform some particular tweaking on your YunoHost instance?: *no / yes*
- If yes, please explain:
- Using, or trying to install package version/branch:
- If upgrading, current package version: *can be found in the admin, or with `yunohost app info $app_id`*
### Steps to reproduce
- *If you performed a command from the CLI, the command itself is enough. For example:*
```sh
sudo yunohost app install the_app
```
- *If you used the webadmin, please perform the equivalent command from the CLI first.*
- *If the error occurs in your browser, explain what you did:*
1. *Go to '...'*
2. *Click on '...'*
3. *Scroll down to '...'*
4. *See error*
### Expected behavior
*A clear and concise description of what you expected to happen. You can remove this section if the command above is enough to understand your intent.*
### Logs
*When an operation fails, YunoHost provides a simple way to share the logs.*
- *In the webadmin, the error message contains a link to the relevant log page. On that page, you will be able to 'Share with Yunopaste'. If you missed it, the logs of previous operations are also available under Tools > Logs.*
- *In command line, the command to share the logs is displayed at the end of the operation and looks like `yunohost log display [log name] --share`. If you missed it, you can find the log ID of a previous operation using `yunohost log list`.*
*After sharing the log, please copypaste directly the link provided by YunoHost (to help readability, no need to copypaste the entire content of the log here, just the link is enough...)*
*If applicable and useful, add screenshots to help explain your problem.*

16
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View file

@ -0,0 +1,16 @@
## Problem
- *Description of why you made this PR*
## Solution
- *And how do you fix that problem*
## PR Status
- [ ] Code finished and ready to be reviewed/tested
- [ ] The fix/enhancement were manually tested (if applicable)
## Automatic tests
Automatic tests can be triggered on https://ci-apps-dev.yunohost.org/ *after creating the PR*, by commenting "!testme", "!gogogadgetoci" or "By the power of systemd, I invoke The Great App CI to test this Pull Request!". (N.B. : for this to work you need to be a member of the Yunohost-Apps organization)

52
doc/DISCLAIMER.md Normal file
View file

@ -0,0 +1,52 @@
## 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 future upgrades will overwrite it.
## YunoHost specific features
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 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
#### 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/).
##### 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 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*:
```
$ 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:
```
<?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 this case, do not forget to change ownerships of this folder to `roundcube`.

53
doc/DISCLAIMER_fr.md Normal file
View file

@ -0,0 +1,53 @@
## 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.
## 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.
#### 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 ajoutant :
```
<?php
$config['plugins'][] = 'html5_notifier';
```
Notez que vous devez également consulter la page d'accueil du plugin pour connaître les étapes d'installation supplémentaires si nécessaire.
##### Installation manual
Vous pouvez également télécharger le plugin et le placer dans le répertoire `plugins /`. Dans ce cas, n'oubliez pas de changer la propriété de ce dossier en `roundcube`.

View file

@ -8,6 +8,14 @@
},
"version": "1.5.0~ynh1",
"url": "https://roundcube.net/",
"upstream": {
"license": "GPL-3.0-only",
"website": "https://example.com",
"demo": "https://demo.yunohost.org/webmail/",
"admindoc": "https://github.com/roundcube/roundcubemail/wiki",
"userdoc": "https://yunohost.org/en/app_roundcube",
"code": "https://github.com/roundcube/roundcubemail"
},
"license": "GPL-3.0-only",
"maintainer": {
"name": "",

View file

@ -226,8 +226,6 @@ chown $app:$app "$final_path/config/config.inc.php"
# SECURE FILES AND DIRECTORIES
#=================================================
mkdir -p "$final_path/plugins/enigma/home"
#=================================================