YunoHost-Apps/etherpad_mypads_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/etherpad_mypads_ynh.git synced 2024-09-03 18:36:09 +02:00
Code Issues Activity Actions

cleaning up

Browse source
This commit is contained in:
ericgaspar 2020-09-05 17:32:15 +02:00
parent dc181f55c6
commit bb450ba302
No known key found for this signature in database
GPG key ID: 574F281483054D44
5 changed files with 65 additions and 67 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
README.md
View file

@ -1,11 +1,11 @@
# Etherpad with mypads plugin for YunoHost # Etherpad with MyPads plugin for YunoHost
[![Integration level](https://dash.yunohost.org/integration/etherpad_mypads.svg)](https://dash.yunohost.org/appci/app/etherpad_mypads) ![](https://ci-apps.yunohost.org/ci/badges/etherpad_mypads.status.svg) [![](https://ci-apps.yunohost.org/ci/badges/etherpad_mypads.maintain.svg)](https://github.com/YunoHost/Apps/#what-to-do-if-i-cant-maintain-my-app-anymore-) [![Integration level](https://dash.yunohost.org/integration/etherpad_mypads.svg)](https://dash.yunohost.org/appci/app/etherpad_mypads) ![](https://ci-apps.yunohost.org/ci/badges/etherpad_mypads.status.svg) [![](https://ci-apps.yunohost.org/ci/badges/etherpad_mypads.maintain.svg)](https://github.com/YunoHost/Apps/#what-to-do-if-i-cant-maintain-my-app-anymore-)
[![Install Etherpad with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=etherpad_mypads) [![Install Etherpad with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=etherpad_mypads)
*[Lire ce readme en français.](./README_fr.md)* *[Lire ce readme en français.](./README_fr.md)*
> *This package allow you to install etherpad quickly and simply on a YunoHost server. > *This package allow you to install Etherpad 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 see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
## Overview ## Overview
@ -16,7 +16,7 @@ This package will install the same plugins than [Framapad](https://framapad.org/
## Screenshots ## Screenshots
![](http://etherpad.org/img/screenshot.png) ![](https://github.com/ether/etherpad-lite/blob/develop/doc/images/etherpad_demo.gif)
## Demo ## Demo
@ -24,25 +24,25 @@ This package will install the same plugins than [Framapad](https://framapad.org/
## Configuration ## Configuration
You can access to 2 different admin panels, for etherpad by accessing `domain.tld/admin` and for mypads by `domain.tld/mypads/?/admin`. You can access two different admin panels, for Etherpad by accessing `domain.tld/admin` and for MyPads by `domain.tld/mypads/?/admin`.
Or, you can find a config file for etherpad at this path `/var/www/etherpad_mypads/settings.json`. You can also find a config file for Etherpad at this path `/var/www/etherpad_mypads/settings.json`.
## Documentation ## Documentation
* Official documentation: http://etherpad.org/doc/v1.7.0 * Official documentation: http://etherpad.org/doc/v1.8.4
* YunoHost documentation: There no other documentations, feel free to contribute. * YunoHost documentation: https://yunohost.org/#/app_etherpad_mypads
## YunoHost specific features ## YunoHost specific features
#### Multi-users support #### Multi-users support
Supported, with LDAP. * Are LDAP and HTTP auth supported? **Yes**
* Can the app be used by multiple users? **Yes**
#### Supported architectures #### Supported architectures
* x86-64b - [![](https://ci-apps.yunohost.org/ci/logs/etherpad_mypads%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/etherpad_mypads/) * x86-64 - [![](https://ci-apps.yunohost.org/ci/logs/etherpad_mypads%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/etherpad_mypads/)
* ARMv8-A - [![](https://ci-apps-arm.yunohost.org/ci/logs/etherpad_mypads%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/etherpad_mypads/) * ARMv8-A - [![](https://ci-apps-arm.yunohost.org/ci/logs/etherpad_mypads%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/etherpad_mypads/)
* Buster x86-64b - [![](https://ci-buster.nohost.me/ci/logs/etherpad_mypads%20%28Apps%29.svg)](https://ci-buster.nohost.me/ci/apps/etherpad_mypads/)
## Limitations ## Limitations
@ -70,14 +70,13 @@ Supported, with LDAP.
* Report a bug: https://github.com/YunoHost-Apps/etherpad_mypads_ynh/issues * Report a bug: https://github.com/YunoHost-Apps/etherpad_mypads_ynh/issues
* Etherpad website: http://etherpad.org/ * Etherpad website: http://etherpad.org/
* Mypads plugin website: https://git.framasoft.org/framasoft/ep_mypads * MyPads plugin website: https://git.framasoft.org/framasoft/ep_mypads
* Upstream app repository: https://github.com/ether/etherpad-lite * Upstream app repository: https://github.com/ether/etherpad-lite
* YunoHost website: https://yunohost.org/ * YunoHost website: https://yunohost.org/
--- ---
Developers infos ## Developers infos
----------------
Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/etherpad_mypads_ynh/tree/testing). Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/etherpad_mypads_ynh/tree/testing).

39
README_fr.md
View file

@ -1,22 +1,22 @@
# Etherpad avec plugin mypads pour YunoHost # Etherpad avec plugin MyPads pour YunoHost
[![Niveau d'intégration](https://dash.yunohost.org/integration/etherpad_mypads.svg)](https://dash.yunohost.org/appci/app/etherpad_mypads) ![](https://ci-apps.yunohost.org/ci/badges/etherpad_mypads.status.svg) [![](https://ci-apps.yunohost.org/ci/badges/etherpad_mypads.maintain.svg)](https://github.com/YunoHost/Apps/#what-to-do-if-i-cant-maintain-my-app-anymore-) [![Niveau d'intégration](https://dash.yunohost.org/integration/etherpad_mypads.svg)](https://dash.yunohost.org/appci/app/etherpad_mypads) ![](https://ci-apps.yunohost.org/ci/badges/etherpad_mypads.status.svg) [![](https://ci-apps.yunohost.org/ci/badges/etherpad_mypads.maintain.svg)](https://github.com/YunoHost/Apps/#what-to-do-if-i-cant-maintain-my-app-anymore-)
[![Installer Etherpad avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=etherpad_mypads) [![Installer Etherpad avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=etherpad_mypads)
*[Read this readme in english.](./README.md)* *[Read this readme in english.](./README.md)*
> *Ce package vous permet d'installer etherpad rapidement et simplement sur un serveur YunoHost. > *Ce package vous permet d'installer Etherpad rapidement et simplement sur un serveur YunoHost.
Si vous n'avez pas YunoHost, merci de regarder [ici](https://yunohost.org/#/install_fr) pour savoir comment l'installer et en profiter.* Si vous n'avez pas YunoHost, merci de regarder [ici](https://yunohost.org/#/install_fr) pour savoir comment l'installer et en profiter.*
## Résumé ## Résumé
Etherpad est un éditeur en ligne Open Source hautement personnalisable qui permet l'édition collaborative en temps réel. Etherpad est un éditeur en ligne Open Source hautement personnalisable qui permet l'édition collaborative en temps réel.
Ce paquet installera les mêmes plugins que [Framapad](https://framapad.org/). Ce paquet installera les mêmes plugins que [Framapad](https://framapad.org/).
**Version embarquée:** 1.8.4 **Version embarquée :** 1.8.4
## Captures d'écran ## Captures d'écran
![](http://etherpad.org/img/screenshot.png) ![](https://github.com/ether/etherpad-lite/blob/develop/doc/images/etherpad_demo.gif)
## Démo ## Démo
@ -24,31 +24,31 @@ Ce paquet installera les mêmes plugins que [Framapad](https://framapad.org/).
## Configuration ## Configuration
Vous pouvez accéder à 2 panneaux d'administration différents, pour etherpad en accédant à `domain.tld/admin` et pour mypads par `domain.tld/mypads/?/admin`. Vous pouvez accéder à deux panneaux d'administration différents, pour Etherpad en accédant à `domain.tld/admin` et pour MyPads par `domain.tld/mypads/?/admin`.
Ou, vous pouvez trouver un fichier de configuration pour etherpad à `/var/www/etherpad_mypads/settings.json`. Vous pouvez également trouver le fichier de configuration pour Etherpad à `/var/www/etherpad_mypads/settings.json`.
## Documentation ## Documentation
* Documentation officielle: http://etherpad.org/doc/v1.7.0 * Documentation officielle : http://etherpad.org/doc/v1.8.4
* Documentation YunoHost: Il n'y a pas d'autre documentation, n'hésitez pas à contribuer. * Documentation YunoHost : https://yunohost.org/#/app_etherpad_mypads_fr
## Fonctionnalités spécifiques à YunoHost ## Fonctionnalités spécifiques à YunoHost
#### Support multi-utilisateurs #### Support multi-utilisateurs
Supportée, avec LDAP. * L'authentification LDAP et HTTP est-elle prise en charge ? **Oui**
* L'application peut-elle être utilisée par plusieurs utilisateurs ? **Oui**
#### Architectures supportées. #### Architectures supportées
* x86-64b - [![](https://ci-apps.yunohost.org/ci/logs/etherpad_mypads%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/etherpad_mypads/) * x86-64 - [![](https://ci-apps.yunohost.org/ci/logs/etherpad_mypads%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/etherpad_mypads/)
* ARMv8-A - [![](https://ci-apps-arm.yunohost.org/ci/logs/etherpad_mypads%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/etherpad_mypads/) * ARMv8-A - [![](https://ci-apps-arm.yunohost.org/ci/logs/etherpad_mypads%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/etherpad_mypads/)
* Buster x86-64b - [![](https://ci-buster.nohost.me/ci/logs/etherpad_mypads%20%28Apps%29.svg)](https://ci-buster.nohost.me/ci/apps/etherpad_mypads/)
## Limitations ## Limitations
## Informations additionnelles ## Informations additionnelles
* Ce paquet installera les plugins suivants: * Ce paquet installera les plugins suivants :
* [ep_align](https://www.npmjs.com/package/ep_align) - *Ajoute Gauche/Centre/Droite/Justifier à des lignes de texte dans un pad* * [ep_align](https://www.npmjs.com/package/ep_align) - *Ajoute Gauche/Centre/Droite/Justifier à des lignes de texte dans un pad*
* [ep_author_hover](https://www.npmjs.com/package/ep_author_hover) - *Ajoute des noms d'auteurs* * [ep_author_hover](https://www.npmjs.com/package/ep_author_hover) - *Ajoute des noms d'auteurs*
@ -68,16 +68,15 @@ Supportée, avec LDAP.
## Liens ## Liens
* Reporter un bug: https://github.com/YunoHost-Apps/etherpad_mypads_ynh/issues * Reporter un bug : https://github.com/YunoHost-Apps/etherpad_mypads_ynh/issues
* Site de etherpad: http://etherpad.org/ * Site d'Etherpad : http://etherpad.org/
* Site du plugin mypads: https://git.framasoft.org/framasoft/ep_mypads * Site du plugin MyPads : https://git.framasoft.org/framasoft/ep_mypads
* Dépôt git de l'app: https://github.com/ether/etherpad-lite * Dépôt GitHub de l'application : https://github.com/ether/etherpad-lite
* Site de YunoHost: https://yunohost.org/ * Site de YunoHost : https://yunohost.org/
--- ---
Informations à l'intention des développeurs ## Informations à l'intention des développeurs
----------------
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/etherpad_mypads_ynh/tree/testing). Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/etherpad_mypads_ynh/tree/testing).

28
config_panel.toml
View file

@ -9,7 +9,7 @@ name = "Etherpad configuration"
name = "Export" name = "Export"
[main.export.export] [main.export.export]
ask = "Use abiword (~260Mo) or libreoffice (~400Mo) (more stable) to expand export possibilities (pdf, doc) ?" ask = "Use AbiWord (~260 Mo) or LibreOffice (~400 Mo) (more stable) to expand export possibilities (PDF, doc)?"
choices = ["none", "abiword", "libreoffice"] choices = ["none", "abiword", "libreoffice"]
default = "none" default = "none"
@ -18,32 +18,32 @@ name = "Etherpad configuration"
name = "Default pad configuration" name = "Default pad configuration"
[main.pad_configuration.pad_config_nocolors] [main.pad_configuration.pad_config_nocolors]
ask = "Hide authorship colors ?" ask = "Hide authorship colors?"
type = "boolean" type = "boolean"
default = false default = false
[main.pad_configuration.pad_config_showlinenumbers] [main.pad_configuration.pad_config_showlinenumbers]
ask = "Show line numbers ?" ask = "Show line numbers?"
type = "boolean" type = "boolean"
default = true default = true
[main.pad_configuration.pad_config_chatandusers] [main.pad_configuration.pad_config_chatandusers]
ask = "Show chat and users ?" ask = "Show chat and users?"
type = "boolean" type = "boolean"
default = false default = false
[main.pad_configuration.pad_config_alwaysshowchat] [main.pad_configuration.pad_config_alwaysshowchat]
ask = "Always show chat ?" ask = "Always show chat?"
type = "boolean" type = "boolean"
default = false default = false
[main.pad_configuration.pad_config_show_markdown] [main.pad_configuration.pad_config_show_markdown]
ask = "Show markdown syntax ?" ask = "Show markdown syntax?"
type = "boolean" type = "boolean"
default = false default = false
[main.pad_configuration.pad_config_pageview] [main.pad_configuration.pad_config_pageview]
ask = "Page view ?" ask = "Page view?"
type = "boolean" type = "boolean"
default = false default = false
@ -63,12 +63,12 @@ name = "Etherpad configuration"
name = "Mypads configuration" name = "Mypads configuration"
[main.mypads_configuration.mypads] [main.mypads_configuration.mypads]
ask = "Enable Mypads plugin ?" ask = "Enable MyPads plugin?"
type = "boolean" type = "boolean"
default = true default = true
[main.mypads_configuration.useldap] [main.mypads_configuration.useldap]
ask = "Use ldap with Mypads ?" ask = "Use LDAP with MyPads?"
type = "boolean" type = "boolean"
default = true default = true
@ -80,32 +80,32 @@ name = "Etherpad configuration"
ask = "Is it a public website?" ask = "Is it a public website?"
type = "boolean" type = "boolean"
default = true default = true
help = "If your etherpad instance is public, everyone will be able to create a pad or see an existing one." help = "If your Etherpad instance is public, everyone will be able to create a pad or see an existing one."
[main.overwrite_files] [main.overwrite_files]
name = "Overwriting config files during an upgrade" name = "Overwriting config files during an upgrade"
[main.overwrite_files.overwrite_settings] [main.overwrite_files.overwrite_settings]
ask = "Overwrite the config file settings.json ?" ask = "Overwrite the config file settings.json?"
type = "boolean" type = "boolean"
default = true default = true
help = "If the file is overwritten, a backup will be created." help = "If the file is overwritten, a backup will be created."
[main.overwrite_files.overwrite_credentials] [main.overwrite_files.overwrite_credentials]
ask = "Overwrite the config file credentials.json ?" ask = "Overwrite the config file credentials.json?"
type = "boolean" type = "boolean"
default = true default = true
help = "If the file is overwritten, a backup will be created." help = "If the file is overwritten, a backup will be created."
[main.overwrite_files.overwrite_nginx] [main.overwrite_files.overwrite_nginx]
ask = "Overwrite the nginx config file ?" ask = "Overwrite the NGINX config file?"
type = "boolean" type = "boolean"
default = true default = true
help = "If the file is overwritten, a backup will be created." help = "If the file is overwritten, a backup will be created."
[main.overwrite_files.overwrite_systemd] [main.overwrite_files.overwrite_systemd]
ask = "Overwrite the systemd config file ?" ask = "Overwrite the systemd config file?"
type = "boolean" type = "boolean"
default = true default = true
help = "If the file is overwritten, a backup will be created." help = "If the file is overwritten, a backup will be created."

32
manifest.json
View file

@ -3,8 +3,8 @@
"id": "etherpad_mypads", "id": "etherpad_mypads",
"packaging_format": 1, "packaging_format": 1,
"description": { "description": {
"en": "Framapad clone, a online editor providing collaborative editing in real-time.", "en": "Online editor providing collaborative editing in real-time. Framapad clone.",
"fr": "Clone de Framapad, un éditeur en ligne fournissant l'édition collaborative en temps réel." "fr": "Éditeur en ligne fournissant l'édition collaborative en temps réel. Clone de Framapad."
}, },
"version": "1.8.4~ynh1", "version": "1.8.4~ynh1",
"url": "https://framapad.org", "url": "https://framapad.org",
@ -31,8 +31,8 @@
"name": "domain", "name": "domain",
"type": "domain", "type": "domain",
"ask": { "ask": {
"en": "Choose a domain for Etherpad Mypads.", "en": "Choose a domain for Etherpad MyPads.",
"fr": "Choisissez un domaine pour Etherpad Mypads." "fr": "Choisissez un domaine pour Etherpad MyPads."
}, },
"example": "sub.domain.org" "example": "sub.domain.org"
}, },
@ -50,8 +50,8 @@
"name": "admin", "name": "admin",
"type": "user", "type": "user",
"ask": { "ask": {
"en": "Choose the Etherpad Mypads administrator (must be an existing YunoHost user)", "en": "Choose the Etherpad MyPads administrator (must be an existing YunoHost user)",
"fr": "Administrateur du site (doit être un utilisateur YunoHost existant)" "fr": "Choisissez l'administrateur Etherpad MyPads (doit être un utilisateur YunoHost existant)"
}, },
"example": "john" "example": "john"
}, },
@ -82,8 +82,8 @@
"fr": "Est-ce un site public ?" "fr": "Est-ce un site public ?"
}, },
"help": { "help": {
"en": "If your etherpad instance is public, everyone will be able to create a pad or see an existing one.", "en": "If your Etherpad instance is public, everyone will be able to create a pad or see an existing one.",
"fr": "Si votre instance etherpad est publique, tout le monde pourra créer un pad ou voir un existant." "fr": "Si votre instance Etherpad est publique, tout le monde pourra créer un pad ou voir un pad existant."
}, },
"default": true "default": true
}, },
@ -91,8 +91,8 @@
"name": "export", "name": "export",
"type": "string", "type": "string",
"ask": { "ask": {
"en": "Use abiword (~260Mo) or libreoffice (~400Mo) (more stable) to expand export possibilities (pdf, doc) ?", "en": "Use AbiWord (~260 Mo) or LibreOffice (~400 Mo) (more stable) to expand export possibilities (PDF, doc)?",
"fr": "Utiliser abiword (~260Mo) ou libre office (~400Mo) (plus stable) pour étendre les possibilités d'export (pdf, doc) ?" "fr": "Utiliser AbiWord (~260 Mo) ou LibreOffice (~400 Mo) (plus stable) pour étendre les possibilités d'export (PDF, doc) ?"
}, },
"choices" : ["none", "abiword", "libreoffice"], "choices" : ["none", "abiword", "libreoffice"],
"default" : "none" "default" : "none"
@ -101,8 +101,8 @@
"name": "mypads", "name": "mypads",
"type": "boolean", "type": "boolean",
"ask": { "ask": {
"en": "Do you want to install mypads plugin ?", "en": "Do you want to install MyPads plugin?",
"fr": "Voulez-vous installer le plugin mypads ?" "fr": "Voulez-vous installer le plugin MyPads ?"
}, },
"help": { "help": {
"en": "<a href=https://git.framasoft.org/framasoft/ep_mypads target=_blank>mypads plugin</a>" "en": "<a href=https://git.framasoft.org/framasoft/ep_mypads target=_blank>mypads plugin</a>"
@ -113,12 +113,12 @@
"name": "useldap", "name": "useldap",
"type": "boolean", "type": "boolean",
"ask": { "ask": {
"en": "Do you want to use ldap with mypads ?", "en": "Do you want to use LDAP with MyPads?",
"fr": "Voulez-vous utiliser ldap avec mypads ?" "fr": "Voulez-vous utiliser LDAP avec MyPads ?"
}, },
"help": { "help": {
"en": "Using ldap won't let you add new user aside from YunoHost users.", "en": "Using LDAP won't let you add new user aside from YunoHost users.",
"fr": "Utiliser ldap ne vous permettra pas d'ajouter un nouvel utilisateur en dehors des utilisateurs de YunoHost." "fr": "Utiliser LDAP ne vous permettra pas d'ajouter un nouvel utilisateur en dehors des utilisateurs de YunoHost."
}, },
"default": true "default": true
} }

8
scripts/_variables
View file

@ -1,16 +1,16 @@
#!/bin/bash #!/bin/bash
# Dependencies for abiword # Dependencies for AbiWord
abiword_app_depencencies="abiword" abiword_app_depencencies="abiword"
# Dependencies for libre office # Dependencies for LibreOffice
libreoffice_app_dependencies="unoconv libreoffice-writer" libreoffice_app_dependencies="unoconv libreoffice-writer"
# NodeJS version # NodeJS version
nodejs_version=12 nodejs_version=12
# Mypads version # MyPads version
# This variable is mostly used to force an upgrade of the package in case of new versions of mypads. # This variable is mostly used to force an upgrade of the package in case of new versions of MyPads.
mypads_version=1.7.17 mypads_version=1.7.17
# Plugin versions # Plugin versions