etherpad_ynh/README.md

<!--
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)  
[![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)*

> *This package allows you to install Etherpad quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*

## Overview

Online editor providing collaborative editing in real-time.

**Shipped version:** 1.8.13~ynh2

**Demo:** https://video.etherpad.com/

## Disclaimers / important information

## Configuration

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`.

*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 and resources

* 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

## Developer info

Please send 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.
```
sudo yunohost app install https://github.com/YunoHost-Apps/etherpad_ynh/tree/testing --debug
or
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
Auto-update README 2021-05-29 12:24:16 +02:00			`<!--`
			`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`
updated package for yunohost, to be tested updated manifest updated install and remove script variable, multi-instance updated nginx conf added readme 2016-07-10 13:11:55 +02:00
Repackage 2020-10-20 13:46:23 +02:00			`[![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)`
Auto-update README 2021-05-29 12:24:16 +02:00			`[![Install Etherpad with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=etherpad)`
Repackage 2020-10-20 13:46:23 +02:00
			`[Lire ce readme en français.](./README_fr.md)`

Auto-update README 2021-05-29 12:24:16 +02:00			`> *This package allows you to install Etherpad quickly and simply on a YunoHost server.`
			`If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*`
Rework README 2020-11-03 19:24:07 +01:00
Repackage 2020-10-20 13:46:23 +02:00			`## Overview`

Auto-update README 2021-05-29 12:24:16 +02:00			`Online editor providing collaborative editing in real-time.`
Repackage 2020-10-20 13:46:23 +02:00
Auto-update README 2021-05-29 12:24:16 +02:00			`Shipped version: 1.8.13~ynh2`
Repackage 2020-10-20 13:46:23 +02:00
Auto-update README 2021-05-29 12:24:16 +02:00			`Demo: https://video.etherpad.com/`
Repackage 2020-10-20 13:46:23 +02:00
Auto-update README 2021-05-29 12:39:39 +02:00			`## Disclaimers / important information`

			`## Configuration`

			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`.

			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`.

Auto-update README 2021-05-29 12:24:16 +02:00			`## Documentation and resources`
Repackage 2020-10-20 13:46:23 +02:00
Auto-update README 2021-05-29 12:24:16 +02:00			`* 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`
Repackage 2020-10-20 13:46:23 +02:00
Auto-update README 2021-05-29 12:24:16 +02:00			`## Developer info`
Repackage 2020-10-20 13:46:23 +02:00
Auto-update README 2021-05-29 12:24:16 +02:00			`Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/etherpad_ynh/tree/testing).`
Repackage 2020-10-20 13:46:23 +02:00
			`To try the testing branch, please proceed like that.`
			```
			`sudo yunohost app install https://github.com/YunoHost-Apps/etherpad_ynh/tree/testing --debug`
			`or`
			`sudo yunohost app upgrade etherpad -u https://github.com/YunoHost-Apps/etherpad_ynh/tree/testing --debug`
			```
Auto-update README 2021-05-29 12:24:16 +02:00
			`More info regarding app packaging: https://yunohost.org/packaging_apps`