37 lines
1.1 KiB
Markdown
37 lines
1.1 KiB
Markdown
# Etherpad
|
|
|
|
Etherpad is a real-time collaborative document editor. Multiple users can write and edit documents simultaneously.
|
|
|
|
## Dependencies
|
|
|
|
- **PostgreSQL** - Database for storing pads and history
|
|
|
|
## Configuration
|
|
|
|
Key settings in `config.yaml`:
|
|
|
|
- **domain** - Where Etherpad will be accessible
|
|
- **storage** - Persistent volume size (default: `2Gi`)
|
|
- **title** - Instance name shown in the browser (default: `Etherpad`)
|
|
|
|
## Usage
|
|
|
|
No account is required to create or edit pads. Just visit the app URL and:
|
|
|
|
- Click **New Pad** to create a document
|
|
- Share the pad URL with collaborators — anyone with the link can edit in real time
|
|
|
|
## Admin Panel
|
|
|
|
An admin panel is available at `/admin`:
|
|
- **Username**: `admin`
|
|
- **Password**: value of `adminPassword` in your `secrets.yaml`
|
|
|
|
Use the admin panel to manage plugins, view connected users, and configure the instance.
|
|
|
|
## Notes
|
|
|
|
- Pads are identified by URL — anyone with the link can view and edit by default
|
|
- Password-protected pads can be created via the admin panel settings
|
|
- The admin panel also provides access to the plugin manager for extending functionality
|