https://github.com/ether/etherpad-go
Etherpad: A modern really-real-time collaborative document editor. Now written in Go!
https://github.com/ether/etherpad-go
collaboration collaborative-editing etherpad libreoffice pdf word
Last synced: 5 months ago
JSON representation
Etherpad: A modern really-real-time collaborative document editor. Now written in Go!
- Host: GitHub
- URL: https://github.com/ether/etherpad-go
- Owner: ether
- License: apache-2.0
- Created: 2024-05-15T18:07:52.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2026-01-16T23:02:39.000Z (5 months ago)
- Last Synced: 2026-01-17T09:19:02.504Z (5 months ago)
- Topics: collaboration, collaborative-editing, etherpad, libreoffice, pdf, word
- Language: Go
- Homepage: https://docs.etherpad.org/
- Size: 5.82 MB
- Stars: 1
- Watchers: 1
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Etherpad-Go: A real-time collaborative editor for the web
Etherpad-Go is a performance focused 1 to 1 rewrite of Etherpad-Lite in Go. The old implementation was written in NodeJS and was still in CommonJS.
A new implementation in Go allows us to take advantage of Go's concurrency model, static typing, and performance optimizations.
Etherpad is a real-time collaborative editor [scalable to thousands of
simultaneous real time users](http://scale.etherpad.org/). It provides [full
data export](https://github.com/ether/etherpad-lite/wiki/Understanding-Etherpad's-Full-Data-Export-capabilities)
## Requirements to get started
* [Go 1.20+](https://golang.org/dl/)
* [NodeJS 22+](https://nodejs.org/en/download/)
* [Pnpm](https://pnpm.io/installation)
### Installation
1. Clone the repository
```bash
git clone https://github.com/ether/etherpad-go.git
cd etherpad-go
```
2. Create the ui:
```bash
cd ui
pnpm install
cd ../admin
pnpm install
node build.js
```
3. Build the Go server:
```bash
go build -o etherpad-go ./main.go
```
4. Copy the binary where you want to run it
5. For customization and configuration, copy the `settings.json.template` to `settings.json` and edit it to your needs.
6. Run the server:
```bash
./etherpad-go
```
7. Etherpad should start within less than a second. Open your browser and navigate to `http://localhost:9001` to access the Etherpad interface.
## Docker
You can also run Etherpad-Go using Docker. Here's how to do it:
### Build it your own
1. Build the Docker image:
```bash
docker build -t etherpad-go .
```
2. Use a prebuilt one which is available at [GitHub Container Registry](ghcr.io/ether/etherpad-go:)
## Starting the Docker Container
You can start the Docker container with a postgres database with docker compose:
```bash
docker compose up -d
```
This will start both the Etherpad-Go server and a Postgres database. The server will be accessible at `http://localhost:9001`.
You can find the docker compose file in [docker-compose.yml](./docker-compose.yml)