Etherpad MyPads for YunoHost

Lire ce readme en français.

This package allows you to install Etherpad MyPads quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide 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.

Features

• Rich Editing - A full rich text WYSIWYG editor.
• Minimalist editor - A minimalist editor that can be embedded within your tool.
• Dark Mode - Theme settings to have Etherpad start in dark mode, ideal for using Etherpad at night or for long durations.
• Images - Plugins to improve provide Image support within a pad.
• Video Chat - Plugins to enable Video and Audio chat in a pad.
• Collaboration++ - Plugins to improve the really-real time collaboration experience, suitable for busy pads.
• Document Analysis - Plugins to improve author and document analysis during and post creation.
• Scale - Etherpad running at scale with pad sharding which allows Etherpad to scale to ∞ number of Active Pads with up to 20,000 edits per second, per pad.

Shipped version: 1.8.18~ynh2

Demo: https://video.etherpad.com

Screenshots

Disclaimers / important information

Configuration

You can access two different admin panels, for Etherpad by accessing domain.tld/admin and for MyPads by domain.tld/mypads/?/admin. You can also find a configuration file for Etherpad at this path /var/www/etherpad_mypads/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_mypads/settings.json.

YunoHost specific features

Multi-users support

• Is LDAP auth supported (for MyPads access only)? Yes
• Can the app be used by multiple users? Yes

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_comments_page - Adds comments on sidebar and link it to the text.
  • ep_countable - Adds paragraphs, words and characters count
  • ep_delete_empty_pads - Delete pads which were never edited
  • ep_font_color - Apply colors to fonts
  • ep_font_size - Add support for Font Sizes
  • 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_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

Documentation and resources

• Official app website: http://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_mypads
• Report a bug: https://github.com/YunoHost-Apps/etherpad_mypads_ynh/issues

Developer info

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that.

sudo yunohost app install https://github.com/YunoHost-Apps/etherpad_mypads_ynh/tree/testing --debug
or
sudo yunohost app upgrade etherpad_mypads -u https://github.com/YunoHost-Apps/etherpad_mypads_ynh/tree/testing --debug

More info regarding app packaging: https://yunohost.org/packaging_apps