Skip to content

Latest commit

 

History

History
77 lines (49 loc) · 4.35 KB

etherpad.md

File metadata and controls

77 lines (49 loc) · 4.35 KB

Etherpad

The playbook can install and configure Etherpad, an open source collaborative text editor, for you.

The Ansible role for Etherpad is developed and maintained by the MASH project. For details about configuring Etherpad, you can check them via:

Dependencies

This service requires the following other services:

Adjusting the playbook configuration

To enable this service, add the following configuration to your vars.yml file and re-run the installation process:

########################################################################
#                                                                      #
# etherpad                                                             #
#                                                                      #
########################################################################

etherpad_enabled: true

etherpad_hostname: etherpad.example.com

########################################################################
#                                                                      #
# /etherpad                                                            #
#                                                                      #
########################################################################

As the most of the necessary settings for the role have been taken care of by the playbook, you can enable Etherpad on your server with this minimum configuration.

See the role's documentation for details about configuring Etherpad per your preference (such as the name of the instance and the default pad text).

Create admin user (optional)

You probably might want to enable authentication to disallow anonymous access to your Etherpad.

It is possible to enable HTTP basic authentication by creating an admin user with etherpad_admin_username and etherpad_admin_password variables. The admin user account is also used by plugins for authentication and authorization.

See this section on the role's documentation for details about how to create the admin user.

Control Etherpad's availability on Jitsi conferences (optional)

If a Jitsi video-conferencing platform (see our docs on Jitsi) is enabled on your server, you can configure it so to make Etherpad available on conferences.

See this section on the Jitsi role's documentation for details about how to set it up.

Usage

By default, the Etherpad UI should be available at https://etherpad.example.com, while the admin UI (if enabled) should then be available at https://etherpad.example.com/admin.

💡 For more information about usage, take a look at this section on the role's documentation.

Troubleshooting

See this section on the role's documentation for details.