This is a Docker image which is nothing more than the basic test Etherpad setup as described on https://github.com/ether/etherpad-lite.

To download the image from the Docker index, run:

docker pull moss/docker-etherpad

First, initialize a mysql container:

docker run -d -e MYSQL_PASSWORD=password -e MYSQL_DATABASE=etherpad \
    -e MYSQL_USER=etherpaduser -e MYSQL_ROOT_PASSWORD=mysecret \
    --name ep_mysql mysql

Then, to run Etherpad on port 9001, run:

docker run -d --name=ep_moss --link=ep_mysql:mysql -p 9001:9001 \
    moss/etherpad

To run Etherpad on port 80, run:

docker run -d --name=ep_moss --link=ep_mysql:mysql -p 80:9001 moss/etherpad

To edit the Etherpad settings, you can use some environment variables.

EP_TITLE

String for your etherpad title (Default: Etherpad)

EP_PORT

Port to run your etherpad service INSIDE THE CONTAINER (Default: 9001)

ADMIN_PASS

Password for your admin user (Default: admin)

FAVICON_URL

Favicon url to show in your etherpad (Default: ./favicon.ico)

DEBUG_ENTRYPOINT

To debug what is happening on start, set this true. (Default: false)

To persiste with etherpad.log you can use the /data volume.

docker run --rm --name=ep_moss --link=ep_mysql:mysql -v /srv/ether/:/data \
    -e EP_TITLE="YOUR TITLE" -e ADMIN_PASS=password \
    -e FAVICON_URL="http://www.google.com/s2/favicons?domain=www.google.com" \
    -e EP_PORT=9002 -p 9001:9002 moss/etherpad

For external database we have this environments variables:

DB_HOST

Host for your external database.

DB_PORT

Port for your external database.

DB_NAME

External database name.

DB_USER

External database user.

DB_PASS

External database password.

DB_TYPE

Use mysql or postgres

To use an openldap as a authentication server, you need to add variables:

LDAP_ENABLED

Change to True to enable ldap login (Default: false)

LDAP_SERVER

Ldap server address. ie. ldap://ldap.domain or ldaps://ldap.domain

LDAP_BIND_DN

Ldap bind user to execute the search.

LDAP_BIND_PASSWORD

Ldap bind password.

LDAP_SEARCH_BASE

Starting point within LDAP structure to search for login user.

LDAP_SEARCH_PROPERTY

Ldap property used for searching, ie. login username needs to match value in uid property in LDAP (Defaut: uid)

LDAP_NAME_PROPERTY

Ldap property used to show user name.

ANONYMOUS_READONLY

Authorize or not non authenticated users to read the pads. (Default: false)

LDAP_GROUP_SEARCH_BASE

Starting point within LDAP structure to search for user to acquire admin rights on etherpad.

LDAP_GROUP_NAME

Group name search for members to acquire admin rights on etherpad.

In order to keep the images smaller, we do not install many plugins. If you need any plugin, you can inherit the base image that you like, and write your own Dockerfile like this:

FROM moss/etherpad:1.6.0
MAINTAINER Thiago Almeida <[email protected]>

ENV PLUGINS ep_webrtc

RUN npm --silent install \
        $PLUGINS

To use advanced import/export install abiword. For it, create a Dockerfile with:

FROM moss/etherpad

RUN set -x; \
    apt-get update \
    && apt-get install -y --no-install-recommends \
    abiword \
    && rm -rf /var/lib/apt/lists/*

Execute a new build:

docker build -t <YOUR NAME>/etherpad .

And use ABIWORD=true on your run.

docker run --rm --name=moss_ether --link=ep_mysql:mysql -v /srv/ether/:/data \
    -e EP_TITLE="YOUR TITLE" -e ADMIN_PASS=password \
    -e FAVICON_URL="http://www.google.com/s2/favicons?domain=www.google.com" \
    -e ABIWORD=true -p 9001:9001 <yourname>/etherpad