Service: Etherpad Lite - EyevinnOSC/community GitHub Wiki
Etherpad Lite is an open-source real-time collaborative document editor. Multiple users can edit the same document simultaneously, with each contributor's text shown in a different color. Available as an open web service in Eyevinn Open Source Cloud, Etherpad Lite is ideal for teams that need lightweight, self-hosted collaborative writing without sending documents to third-party services.
- If you have not already done so, sign up for an Eyevinn OSC account
By default Etherpad Lite uses an embedded "dirtyDB" file store that is suitable for evaluation only. For any persistent or production use, connect it to a PostgreSQL database.
Navigate to the PostgreSQL service in the Eyevinn OSC web console. Click on "Create psql-db" and fill in:
- Name: a name for your database instance (alphanumeric only)
-
Password: a strong password for the
postgresuser
Once the instance is running, note the IP and port. The connection URL will be:
postgres://postgres:<password>@<IP>:<PORT>/postgres
Navigate to the Etherpad Lite service in the Eyevinn OSC web console. Go to the tab "Service Secrets" and click "New Secret".
Create a secret named dburl containing the PostgreSQL connection URL from Step 1.
Go to the tab "My etherpad-lite" and click "Create etherpad-lite". Fill in:
- Name: a name for your instance (alphanumeric only)
-
DatabaseUrl (optional):
{{secrets.dburl}}— leave empty to use the built-in dirtyDB (development only)
Click the instance card when the status is green and "running" to open Etherpad Lite in your browser.
From the Etherpad Lite home page, enter a name in the "New Pad" field and click "OK". Share the pad URL with your collaborators — anyone with the link can edit in real time with no sign-in required.
To access the admin panel, navigate to /admin. The default credentials are:
-
Username:
admin -
Password:
admin
Change the admin password immediately after first login via the admin settings panel.
# Without a database (development/evaluation only)
npx @osaas/cli create ether-etherpad-lite mypad
# With PostgreSQL
npx @osaas/cli create ether-etherpad-lite mypad \
-o DatabaseUrl="postgres://postgres:mypassword@<IP>:<PORT>/postgres"| Option | Required | Description |
|---|---|---|
DatabaseUrl |
No | PostgreSQL connection string. When omitted, the embedded dirtyDB is used (not suitable for production). |