# Etherpad with mypads plugin for YunoHost

[![Integration level](https://dash.yunohost.org/integration/etherpad_mypads.svg)](https://ci-apps.yunohost.org/jenkins/job/etherpad_mypads%20%28Community%29/lastBuild/consoleFull)  
[![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)*

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

## Overview
Etherpad is a highly customizable Open Source online editor providing collaborative editing in really real-time.  
This package will install the same plugins than [Framapad](https://framapad.org/).

**Shipped version:** 1.6.2

## Screenshots

![](http://etherpad.org/img/screenshot.png)

## Configuration

You can access to 2 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`.

## Documentation

 * Official documentation: http://etherpad.org/doc/v1.6.2
 * YunoHost documentation: There no other documentations, feel free to contribute.

## YunoHost specific features

#### Multi-users support

Supported, **without LDAP nor SSO**.

#### Supported architectures

* Tested on x86_64

## Limitations

* If you ask to install the plugin mypads, you have to install in the root of a dedicated domain or a sub domain. Else, mypads will be inaccessible.

## Additionnal informations

* This package will install the following plugins:

  * ep_align - *Add Left/Center/Right/Justify to lines of text in a pad*
  * ep_author_hover - *Adds author names to span titles*
  * ep_automatic_logut - *Automatically disconnects user after some period of time (Prevent server overload)*
  * ep_comments_page - *Adds comments on sidebar and link it to the text.*
  * ep_countable - *Displays paragraphs, sentences, words and characters counts.*
  * ep_delete_empty_pads - *Delete pads which were never edited*
  * ep_font_color - *Apply colors to fonts*
  * ep_headings2 - *Adds heading support to Etherpad Lite.*
  * ep_markdown - *Edit and Export as Markdown in Etherpad*
  * ep_mypads - *Groups and private pads for etherpad*
  * ep_page_view - *Add support to do 'page view', with a toggle on/off option in Settings, also Page Breaks with Control Enter*
  * ep_spellcheck - *Add support to do 'Spell checking'*
  * ep_subscript_and_superscript - *Add support for Subscript and Superscript*
  * ep_table_of_contents - *View a table of contents for your pad*
  * ep_user_font_size - *User Pad Contents font size can be set in settings, this does not effect other peoples views*

* Because there's no ldap support with mypads plugin, no user is created at the installation.  
You have to connect to the admin panel to create the first users.  
Login and password are those you chose during the installation.

## Links

 * Report a bug: https://github.com/YunoHost-Apps/etherpad_mypads_ynh/issues
 * Etherpad website: http://etherpad.org/
 * Mypads plugin website: https://git.framasoft.org/framasoft/ep_mypads
 * YunoHost website: https://yunohost.org/

---

Developers infos
----------------

Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/etherpad_mypads_ynh/tree/testing).

To try the testing branch, please proceed like that.
```
sudo yunohost app install https://github.com/YunoHost-Apps/etherpad_mypads_ynh/tree/testing --verbose
or
sudo yunohost app upgrade etherpad_mypads -u https://github.com/YunoHost-Apps/etherpad_mypads_ynh/tree/testing --verbose
```