etherpad v0.1.0

Notes & docs

Etherpad — a real-time collaborative document editor: multiple people edit the same rich-text pad live in the browser. Uses SQLite. Deployed as a single host-networked Nomad service.

nomad-pack run etherpad --registry nomploy

…or one line (add registry + run)

curl -fsSL https://packs.nomploy.com/install.sh | sh -s -- etherpad

Needs nomad-pack on PATH. The script only adds the nomploy registry and runs this pack.

Source ↗ Project ↗ ★ 18.6k ⚑ Report an issue

2 tasks http 9001 1 volume image etherpad/etherpad:latest tracks :latest image bumped today

Variables 9

values.hcl

Save as values.hcl, edit, then run:

nomad-pack run etherpad -f values.hcl --registry nomploy

# The name of the Nomad job.
job_name = "etherpad"

# The Nomad namespace to deploy into.
namespace = "default"

# The datacenters to deploy to.
datacenters = ["*"]

# The Etherpad container image. Pin a tag in production.
image = "etherpad/etherpad:latest"

# Host port for the Etherpad web UI. Fixed at 9001 inside the image.
port = 9001

# Named volume mounted at /opt/etherpad-lite/var — the SQLite database and uploads.
data_volume = "etherpad_data"

# Password for the /admin settings UI (ADMIN_PASSWORD, user 'admin'). Empty = admin UI disabled.
admin_password = ""

# Placement constraints. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true".
constraints = []

# The task resources.
resources = {
    cpu    = 300
    memory = 256
  }

Name	Type	Default	Description
job_name	string	"etherpad"	The name of the Nomad job.
namespace	string	"default"	The Nomad namespace to deploy into.
datacenters	list	["*"]	The datacenters to deploy to.
image	string	"etherpad/etherpad:latest"	The Etherpad container image. Pin a tag in production.
port	number	9001	Host port for the Etherpad web UI. Fixed at 9001 inside the image.
data_volume	string	"etherpad_data"	Named volume mounted at /opt/etherpad-lite/var — the SQLite database and uploads.
admin_password key	string	""	Password for the /admin settings UI (ADMIN_PASSWORD, user 'admin'). Empty = admin UI disabled.
constraints	list	[]	Placement constraints. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true".
resources	object	{ cpu = 300 memory = 256 }	The task resources.

Back up this pack

This pack stores data in one Docker named volume: etherpad_data

restic

# Run on the node hosting this pack. Point restic at your repo first:
#   export RESTIC_REPOSITORY="s3:https://<account>.r2.cloudflarestorage.com/<bucket>"
#   export RESTIC_PASSWORD="<repo-password>"
#   export AWS_ACCESS_KEY_ID=<key>  AWS_SECRET_ACCESS_KEY=<secret>
restic backup \
  /var/lib/docker/volumes/etherpad_data/_data

rclone (sync to S3/R2)

rclone sync /var/lib/docker/volumes/etherpad_data/_data backup:<bucket>/etherpad_data

Paths assume the default Docker volume location (/var/lib/docker/volumes). Restore by stopping the job, restoring files into the same volume, and re-running the pack.

Readme

etherpad

Etherpad — a real-time collaborative document editor. Several people edit the same rich-text pad together live, with colored authorship, chat, revision history and a huge plugin ecosystem. Share a pad URL and start writing together — no accounts needed.

Single host-networked Nomad service using SQLite on a persistent volume.

Deploy

nomad-pack registry add nomploy https://github.com/Nomploy/nomad-packs
nomad-pack run etherpad --registry=nomploy

Configure

Variable	Default	Description
`port`	`9001`	Web UI port. Fixed at `9001` inside the image.
`admin_password`	`""`	Password for the `/admin` settings UI (`ADMIN_PASSWORD`, user `admin`). Empty = admin UI off.
`image`	`etherpad/etherpad:latest`	Container image. Pin a tag in production.
`data_volume`	`etherpad_data`	`/opt/etherpad-lite/var` — the SQLite database and uploads.
`resources`	`{ cpu = 300, memory = 256 }`	Task resources.

A prestart init task chowns the data volume to uid 5001 (Etherpad runs unprivileged). Set admin_password to manage plugins and settings at /admin. For a large multi-user instance, switch to an external PostgreSQL/MySQL via the DB_* env vars. Pin the job to the node holding the volume with constraints.