mirror of
https://github.com/YunoHost-Apps/etherpad_ynh.git
synced 2024-09-03 18:36:10 +02:00
Auto-update README
This commit is contained in:
parent
0bf672e6f3
commit
4d6579bedb
2 changed files with 44 additions and 104 deletions
74
README.md
74
README.md
|
@ -1,68 +1,38 @@
|
||||||
# Etherpad-Lite for YunoHost
|
<!--
|
||||||
|
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.
|
||||||
|
-->
|
||||||
|
|
||||||
|
# Etherpad for YunoHost
|
||||||
|
|
||||||
[![Integration level](https://dash.yunohost.org/integration/etherpad.svg)](https://dash.yunohost.org/appci/app/etherpad) ![](https://ci-apps.yunohost.org/ci/badges/etherpad.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/etherpad.maintain.svg)
|
[![Integration level](https://dash.yunohost.org/integration/etherpad.svg)](https://dash.yunohost.org/appci/app/etherpad) ![](https://ci-apps.yunohost.org/ci/badges/etherpad.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/etherpad.maintain.svg)
|
||||||
[![Install Etherpad-Lite with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=etherpad)
|
[![Install Etherpad with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=etherpad)
|
||||||
|
|
||||||
*[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-Lite quickly and simply on a YunoHost server.
|
> *This package allows 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 consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
||||||
|
|
||||||
> :warning: This package installs Etherpad-Lite (without MyPads and plugins). It uses PostgreSQL as database.
|
|
||||||
>If you want to install Etherpad with the MyPads plugin, use the [Etherpad MyPads package](https://github.com/YunoHost-Apps/etherpad_mypads_ynh).
|
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
Etherpad allows you to edit documents collaboratively in real-time, much like a live multi-player editor that runs in your browser. Write articles, press releases, to-do lists, etc. together with your friends, fellow students or colleagues, all working on the same document at the same time.
|
|
||||||
|
|
||||||
**Shipped version:** 1.8.13
|
Online editor providing collaborative editing in real-time.
|
||||||
|
|
||||||
## Screenshots
|
**Shipped version:** 1.8.13~ynh2
|
||||||
|
|
||||||
![](https://etherpad.org/img/etherpad_demo.gif)
|
**Demo:** https://video.etherpad.com/
|
||||||
|
|
||||||
## Demo
|
## Documentation and resources
|
||||||
|
|
||||||
* [Official demo](https://video.etherpad.com/)
|
* Official app website: https://etherpad.org/
|
||||||
|
* Official user documentation: https://yunohost.org/en/app_etherpad
|
||||||
|
* Official admin documentation: http://etherpad.org/doc/v1.8.13
|
||||||
|
* Upstream app code repository: https://github.com/ether/etherpad-lite
|
||||||
|
* YunoHost documentation for this app: https://yunohost.org/app_etherpad
|
||||||
|
* Report a bug: https://github.com/YunoHost-Apps/etherpad_ynh/issues
|
||||||
|
|
||||||
## Configuration
|
## Developer info
|
||||||
|
|
||||||
You can access Etherpad's admin panel at `domain.tld/admin`. The configuration file for Etherpad is at the path `/var/www/etherpad/settings.json`.
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/etherpad_ynh/tree/testing).
|
||||||
|
|
||||||
*Skin Builder* (accessible at this address `domain.tld/pad/p/test#skinvariantsbuilder`) allows you to customize the skin of your pad. It will give you a parameter to copy into your configuration file `/var/www/etherpad/settings.json`.
|
|
||||||
|
|
||||||
## Documentation
|
|
||||||
|
|
||||||
* Official documentation: http://etherpad.org/doc/v1.8.13
|
|
||||||
* YunoHost documentation: https://yunohost.org/en/app_etherpad
|
|
||||||
|
|
||||||
## YunoHost specific features
|
|
||||||
|
|
||||||
#### Multi-users support
|
|
||||||
|
|
||||||
* Is LDAP auth supported? **No**
|
|
||||||
* Can the app be used by multiple users? **Yes**
|
|
||||||
|
|
||||||
#### Supported architectures
|
|
||||||
|
|
||||||
* x86-64 - [![](https://ci-apps.yunohost.org/ci/logs/etherpad.svg)](https://ci-apps.yunohost.org/ci/apps/etherpad/)
|
|
||||||
* ARMv8-A - [![](https://ci-apps-arm.yunohost.org/ci/logs/etherpad.svg)](https://ci-apps-arm.yunohost.org/ci/apps/etherpad/)
|
|
||||||
|
|
||||||
## Limitations
|
|
||||||
|
|
||||||
## Additionnal informations
|
|
||||||
|
|
||||||
## Links
|
|
||||||
|
|
||||||
* Report a bug: https://github.com/YunoHost-Apps/etherpad_ynh/issues
|
|
||||||
* Etherpad website: http://etherpad.org/
|
|
||||||
* Upstream app repository: https://github.com/ether/etherpad-lite
|
|
||||||
* YunoHost website: https://yunohost.org/
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Developers infos
|
|
||||||
|
|
||||||
Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/etherpad_ynh/tree/testing).
|
|
||||||
|
|
||||||
To try the testing branch, please proceed like that.
|
To try the testing branch, please proceed like that.
|
||||||
```
|
```
|
||||||
|
@ -70,3 +40,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/etherpad_ynh/tree/tes
|
||||||
or
|
or
|
||||||
sudo yunohost app upgrade etherpad -u https://github.com/YunoHost-Apps/etherpad_ynh/tree/testing --debug
|
sudo yunohost app upgrade etherpad -u https://github.com/YunoHost-Apps/etherpad_ynh/tree/testing --debug
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**More info regarding app packaging:** https://yunohost.org/packaging_apps
|
74
README_fr.md
74
README_fr.md
|
@ -1,72 +1,40 @@
|
||||||
# Etherpad-Lite pour YunoHost
|
# Etherpad pour YunoHost
|
||||||
|
|
||||||
[![Niveau d'intégration](https://dash.yunohost.org/integration/etherpad.svg)](https://dash.yunohost.org/appci/app/etherpad) ![](https://ci-apps.yunohost.org/ci/badges/etherpad.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/etherpad.maintain.svg)
|
[![Niveau d'intégration](https://dash.yunohost.org/integration/etherpad.svg)](https://dash.yunohost.org/appci/app/etherpad) ![](https://ci-apps.yunohost.org/ci/badges/etherpad.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/etherpad.maintain.svg)
|
||||||
[![Installer Etherpad-Lite avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=etherpad)
|
[![Installer Etherpad avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=etherpad)
|
||||||
|
|
||||||
*[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 Etherpad-Lite rapidement et simplement sur un serveur YunoHost.
|
> *This package allows you to install Etherpad quickly and simply on a YunoHost server.
|
||||||
Si vous n'avez pas YunoHost, merci de regarder [ici](https://yunohost.org/install_fr) pour savoir comment l'installer et en profiter.*
|
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
||||||
|
|
||||||
> :warning: Ce paquet installe Etherpad-Lite (sans MyPads et divers plugins). Il utilise PostgreSQL comme base de données.
|
## Vue d'ensemble
|
||||||
> Si vous souhaitez installer Etherpad avec MyPads, utilisez le paquet [Etherpad MyPads](https://github.com/YunoHost-Apps/etherpad_mypads_ynh).
|
|
||||||
|
|
||||||
## Résumé
|
Éditeur en ligne fournissant l'édition collaborative en temps réel.
|
||||||
Etherpad vous permet d'éditer des documents de manière collaborative en temps réel, un peu comme un éditeur multi-joueurs en direct qui s'exécute dans votre navigateur. Rédigez des articles, des communiqués de presse, des listes de choses à faire, etc. avec vos amis, camarades ou collègues, tous travaillant sur le même document en même temps.
|
|
||||||
|
|
||||||
**Version embarquée :** 1.8.13
|
**Version incluse:** 1.8.13~ynh2
|
||||||
|
|
||||||
## Captures d'écran
|
**Démo :** https://video.etherpad.com/
|
||||||
|
|
||||||
![](https://etherpad.org/img/etherpad_demo.gif)
|
## Documentations et ressources
|
||||||
|
|
||||||
## Démo
|
* Site officiel de l'app : https://etherpad.org/
|
||||||
|
* Documentation officielle utilisateur : https://yunohost.org/en/app_etherpad
|
||||||
|
* Documentation officielle de l'admin : http://etherpad.org/doc/v1.8.13
|
||||||
|
* Dépôt de code officiel de l'app : https://github.com/ether/etherpad-lite
|
||||||
|
* Documentation YunoHost pour cette app : https://yunohost.org/app_etherpad
|
||||||
|
* Signaler un bug: https://github.com/YunoHost-Apps/etherpad_ynh/issues
|
||||||
|
|
||||||
* [Démo officielle](https://video.etherpad.com/)
|
## Informations pour les développeurs
|
||||||
|
|
||||||
## Configuration
|
|
||||||
|
|
||||||
Vous pouvez accéder au panneau d'administration d'Etherpad à l'adresse `domain.tld/admin`. Le fichier de configuration d'Etherpad est `/var/www/etherpad/settings.json`.
|
|
||||||
|
|
||||||
*Skin Builder* (accessible à l'adresse `domain.tld/pad/p/test#skinvariantsbuilder`) vous permet de personnaliser l'apparence de votre pad. Il vous donnera un paramètre à copier dans votre fichier de configuration `/var/www/etherpad/settings.json`.
|
|
||||||
|
|
||||||
## Documentation
|
|
||||||
|
|
||||||
* Documentation officielle : http://etherpad.org/doc/v1.8.13
|
|
||||||
* Documentation YunoHost : https://yunohost.org/fr/app_etherpad
|
|
||||||
|
|
||||||
## Fonctionnalités spécifiques à YunoHost
|
|
||||||
|
|
||||||
#### Support multi-utilisateurs
|
|
||||||
|
|
||||||
* L'authentification LDAP est-elle prise en charge ? **Non**
|
|
||||||
* L'application peut-elle être utilisée par plusieurs utilisateurs ? **Oui**
|
|
||||||
|
|
||||||
#### Architectures supportées
|
|
||||||
|
|
||||||
* x86-64 - [![](https://ci-apps.yunohost.org/ci/logs/etherpad.svg)](https://ci-apps.yunohost.org/ci/apps/etherpad/)
|
|
||||||
* ARMv8-A - [![](https://ci-apps-arm.yunohost.org/ci/logs/etherpad.svg)](https://ci-apps-arm.yunohost.org/ci/apps/etherpad/)
|
|
||||||
|
|
||||||
## Limitations
|
|
||||||
|
|
||||||
## Informations additionnelles
|
|
||||||
|
|
||||||
## Liens
|
|
||||||
|
|
||||||
* Reporter un bug : https://github.com/YunoHost-Apps/etherpad_ynh/issues
|
|
||||||
* Site d'Etherpad : http://etherpad.org/
|
|
||||||
* Dépôt GitHub de l'application : https://github.com/ether/etherpad-lite
|
|
||||||
* Site de YunoHost : https://yunohost.org/
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Informations à l'intention des développeurs
|
|
||||||
|
|
||||||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/etherpad_ynh/tree/testing).
|
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/etherpad_ynh/tree/testing).
|
||||||
|
|
||||||
Pour tester la branche testing, merci de procéder ainsi.
|
Pour essayer la branche testing, procédez comme suit.
|
||||||
```
|
```
|
||||||
sudo yunohost app install https://github.com/YunoHost-Apps/etherpad_ynh/tree/testing --debug
|
sudo yunohost app install https://github.com/YunoHost-Apps/etherpad_ynh/tree/testing --debug
|
||||||
ou
|
or
|
||||||
sudo yunohost app upgrade etherpad -u https://github.com/YunoHost-Apps/etherpad_ynh/tree/testing --debug
|
sudo yunohost app upgrade etherpad -u https://github.com/YunoHost-Apps/etherpad_ynh/tree/testing --debug
|
||||||
```
|
```
|
||||||
|
|
||||||
|
**Plus d'infos sur le packaging d'applications:** https://yunohost.org/packaging_apps
|
Loading…
Reference in a new issue