mirror of
https://github.com/YunoHost-Apps/etherpad_ynh.git
synced 2024-09-03 18:36:10 +02:00
64 lines
2.7 KiB
Markdown
64 lines
2.7 KiB
Markdown
<!--
|
|
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
|
|
|
|
[](https://dash.yunohost.org/appci/app/etherpad)  
|
|
[](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.8.18~ynh1
|
|
|
|
**Demo:** https://video.etherpad.com/
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
## Disclaimers / important information
|
|
|
|
## Etherpad Lite
|
|
|
|
This version of Etherpad is installed without plugins and uses Redis as database.
|
|
Be aware, Redis database backup and restore is not fully implemented.
|
|
|
|
If you want to install Etherpad with plugins and mysql database: https://github.com/YunoHost-Apps/etherpad_mypads_ynh",
|
|
|
|
## 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 admin documentation: <http://etherpad.org/doc/v1.8.18>
|
|
* 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>
|