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) ![Working status](https://ci-apps.yunohost.org/ci/badges/etherpad.status.svg) ![Maintenance status](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

Etherpad is a real-time collaborative editor scalable to thousands of simultaneous real time users. It provides full data export capabilities, and runs on your server, under your control.


**Shipped version:** 1.9.1~ynh1

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

## Screenshots

![Screenshot of Etherpad](./doc/screenshots/etherpad.gif)

## Documentation and resources

* Official app website: <https://etherpad.org/>
* Official admin documentation: <http://etherpad.org/doc/v1.9.1>
* 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.

``` bash
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
Auto-update README 2023-06-27 09:46:05 +02:00			`[![Integration level](https://dash.yunohost.org/integration/etherpad.svg)](https://dash.yunohost.org/appci/app/etherpad) ![Working status](https://ci-apps.yunohost.org/ci/badges/etherpad.status.svg) ![Maintenance status](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-09-30 10:58:34 +02:00			`Etherpad is a real-time collaborative editor scalable to thousands of simultaneous real time users. It provides full data export capabilities, and runs on your server, under your control.`

Repackage 2020-10-20 13:46:23 +02:00
Auto-update README 2023-06-27 09:55:01 +02:00			`Shipped version: 1.9.1~ynh1`
Repackage 2020-10-20 13:46:23 +02:00
Auto-update README 2023-08-17 19:36:49 +02:00			`Demo: https://video.etherpad.com/`
Repackage 2020-10-20 13:46:23 +02:00
Auto-update README 2023-08-17 19:36:49 +02:00			`## Screenshots`
Auto-update README 2021-07-18 18:08:45 +02:00
Auto-update README 2023-08-17 19:36:49 +02:00			`![Screenshot of Etherpad](./doc/screenshots/etherpad.gif)`
Auto-update README 2021-07-18 18:08:45 +02:00
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 2023-06-27 09:46:05 +02:00			`* Official app website: <https://etherpad.org/>`
Auto-update README 2023-06-27 09:55:01 +02:00			`* Official admin documentation: <http://etherpad.org/doc/v1.9.1>`
Auto-update README 2023-06-27 09:46:05 +02:00			`* 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.`
Auto-update README 2023-06-27 09:46:05 +02:00
			``` bash
Repackage 2020-10-20 13:46:23 +02:00			`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
Auto-update README 2023-06-27 09:46:05 +02:00			`More info regarding app packaging: <https://yunohost.org/packaging_apps>`