mirror of
https://github.com/nickyeoman/docker-compose-cookbooks.git
synced 2026-09-03 18:36:22 +00:00
Fix etherpad_dev based on AGENTS.md
This commit is contained in:
+69
-4
@@ -1,7 +1,72 @@
|
||||
# etherpad
|
||||
# Etherpad
|
||||
|
||||
[website](https://etherpad.org/)
|
||||
## Overview
|
||||
|
||||
Etherpad is a highly customizable open source online editor providing collaborative editing in really real-time.
|
||||
Etherpad is a highly customizable open source online editor providing collaborative editing in real-time. It's perfect for collaborative work sessions, note-taking, and document creation.
|
||||
|
||||
TODO: this looks like a great project.
|
||||
## Project Details
|
||||
|
||||
- **Project Repository:** https://github.com/etherpad/etherpad-lite
|
||||
- **Container Image:** [Docker Hub](https://hub.docker.com/_/node)
|
||||
- **Compose Example:** [Etherpad Docker Compose](https://github.com/etherpad/etherpad-lite/blob/master/docker-compose.yml)
|
||||
- **Documentation:** [Etherpad Docs](https://etherpad.org/documentation/)
|
||||
- **Reverse Proxy Port:** `9001`
|
||||
|
||||
## Getting Started
|
||||
|
||||
1. Start the container: `docker compose up -d`
|
||||
2. Access Etherpad: `http://localhost:9001`
|
||||
3. Log in with admin/etherpad (default credentials)
|
||||
|
||||
## Environment Variable Notes
|
||||
|
||||
- `ETHERPAD_IMAGE` – Docker image to use (default: `node:18-slim`)
|
||||
- `ETHERPAD_PORT` – Port to expose (default: `9001`)
|
||||
- `ETHERPAD_RESTART` – Restart policy (default: `unless-stopped`)
|
||||
- `TZ` – Timezone for container (default: `UTC`)
|
||||
- `ETHERPAD_DEFAULT_TITLE` – Default title for new pads (default: `Etherpad`)
|
||||
- `ETHERPAD_DEFAULT_TEXT` – Default welcome text for new pads (default: `Welcome to Etherpad!`)
|
||||
- `ETHERPAD_ADMIN_PASSWORD` – Admin password for authentication (default: `admin`)
|
||||
|
||||
## Volume Notes
|
||||
|
||||
- `/data` – Persistent storage for Etherpad configuration and data files
|
||||
|
||||
## Network Notes
|
||||
|
||||
Requires proxy network
|
||||
|
||||
## Docker Run
|
||||
|
||||
```bash
|
||||
docker run -d \
|
||||
--name etherpad \
|
||||
-e ETHERPAD_IMAGE=node:18-slim \
|
||||
-e ETHERPAD_PORT=9001 \
|
||||
-e ETHERPAD_RESTART=unless-stopped \
|
||||
-e TZ=UTC \
|
||||
-e ETHERPAD_DEFAULT_TITLE=Etherpad \
|
||||
-e ETHERPAD_DEFAULT_TEXT=Welcome to Etherpad! \
|
||||
-e ETHERPAD_ADMIN_PASSWORD=admin \
|
||||
-v /data/etherpad:/home/etherpad \
|
||||
-p 9001:9001 \
|
||||
node:18-slim
|
||||
```
|
||||
|
||||
## Additional Notes / Gotchas
|
||||
|
||||
- Etherpad requires curl and git to be installed in the container for initial setup
|
||||
- After container starts, you can access the WebSocket port at 9001 for real-time collaboration
|
||||
- Change the admin password immediately after first login
|
||||
- The docker image installs Etherpad from GitHub source
|
||||
|
||||
## Dockhand Stack, Deploy from Git
|
||||
|
||||
Cookbooks Repository
|
||||
stackname: etherpad
|
||||
Compose file path: etherpad_dev/compose.yaml
|
||||
Additional env file (optional): etherpad_dev/sample.env
|
||||
|
||||
Then "Load" etherpad_dev/sample.env into the Environmental variables in dockhand
|
||||
|
||||
Create the Stack
|
||||
|
||||
@@ -0,0 +1,28 @@
|
||||
services:
|
||||
etherpad:
|
||||
image: ${ETHERPAD_IMAGE:-node:18-slim}
|
||||
restart: ${ETHERPAD_RESTART:-unless-stopped}
|
||||
command:
|
||||
- docker-entrypoint.sh
|
||||
- /bin/bash
|
||||
- -c
|
||||
- "npm install -g git+https://github.com/etherpad/etherpad-lite.git && cp -r /usr/local/lib/node_modules/etherpad-lite/* /home/etherpad/ && chmod -R 775 /home/etherpad/ && ls -la /home/etherpad/"
|
||||
environment:
|
||||
- TZ=${TZ:-UTC}
|
||||
- ETHERPAD_DEFAULT_TITLE=${ETHERPAD_DEFAULT_TITLE:-Etherpad}
|
||||
- ETHERPAD_DEFAULT_TEXT=${ETHERPAD_DEFAULT_TEXT:-Welcome to Etherpad!}
|
||||
- ETHERPAD_ADMIN_PASSWORD=${ETHERPAD_ADMIN_PASSWORD:-admin}
|
||||
ports:
|
||||
- "${ETHERPAD_PORT:-9001}:9001"
|
||||
volumes:
|
||||
- ${VOL_PATH:-/data}/etherpad:/home/etherpad
|
||||
- /etc/localtime:/etc/localtime:ro
|
||||
networks:
|
||||
- proxy
|
||||
- internal
|
||||
|
||||
networks:
|
||||
proxy:
|
||||
external: true
|
||||
internal:
|
||||
internal: true
|
||||
@@ -1 +0,0 @@
|
||||
services:
|
||||
+11
-1
@@ -1 +1,11 @@
|
||||
# Global
|
||||
COOKBOOK=/git/docker-compose-cookbooks #HELP: cookbooks
|
||||
VOL_PATH=/data
|
||||
TZ=UTC
|
||||
|
||||
# etherpad
|
||||
ETHERPAD_IMAGE=node:18-slim
|
||||
ETHERPAD_PORT=9001
|
||||
ETHERPAD_RESTART=unless-stopped
|
||||
ETHERPAD_DEFAULT_TITLE=Etherpad
|
||||
ETHERPAD_DEFAULT_TEXT=Welcome to Etherpad!
|
||||
ETHERPAD_ADMIN_PASSWORD=admin
|
||||
Reference in New Issue
Block a user