Back to all templates
Etherpad logo

Etherpad

Application512MB+ RAM

Real-time collaborative document editor — like a multiplayer notepad in the browser

applicationdocsetherpadopen-sourceself-hosteddocker

Deploy Etherpad in 3 Steps

1

Connect Your VPS

Add your server credentials to Server Compass

2

Select Etherpad

Choose from our template library

3

Deploy & Configure

Fill in settings and click Deploy

No Docker knowledge required
Step-by-step deployment guide

Deploy Etherpad on a VPS with Server Compass

Use the Etherpad template in Server Compass to deploy a self-hosted collaborative text editor on your VPS, then verify the pad creation page loads.

About 10 minutesBrowser verified
1
Step 1

Open the server Apps tab

Select the tutorial-vps VPS, open the Apps tab, and start a new app deployment. Keep sensitive server details hidden before capturing or sharing screenshots.

Server Compass Apps tab before creating a Etherpad app
2
Step 2

Choose an app template

Click New App and choose the template deployment path so Server Compass can load the built-in catalog.

Choosing to deploy an app from a Server Compass template
3
Step 3

Search for Etherpad

Use the template picker search to find Etherpad in the Server Compass template catalog.

Searching for Etherpad in the Server Compass template picker
4
Step 4

Select the Etherpad template

Choose the Etherpad template. Server Compass fills the Etherpad service, PostgreSQL service, admin password, database password, and public web port.

Etherpad template selected in Server Compass
5
Step 5

Review the Etherpad settings

Confirm the app name and compose service. In this run, the app was named etherpad-demo and used host port 4104.

Reviewing Etherpad project settings and compose service
6
Step 6

Deploy Etherpad

Review the generated compose settings, confirm the Etherpad web port is available, and click Deploy.

Reviewing Etherpad web port before deployment
7
Step 7

Watch the deployment progress

Keep the deployment modal open while Server Compass uploads the compose file, pulls the Etherpad image, starts the container, and verifies the stack.

Server Compass deploying the Etherpad template on the VPS
8
Step 8

Confirm Etherpad is running

After deployment finishes, return to the Apps tab and confirm the Etherpad app is marked Running with its application URL available.

Etherpad template running in the Server Compass Apps tab
9
Step 9

Open Etherpad in the browser

Open the application URL in a browser. The Etherpad start page confirms the collaborative editor is reachable.

The deployed Etherpad web UI loaded in a browser

After Etherpad Opens

  • Store the Etherpad admin password in a password manager.
  • Use HTTPS before inviting users to edit pads.
  • Back up both the Etherpad data volume and PostgreSQL volume.
  • Review public/private pad behavior before exposing the instance.
  • Use the admin panel only from trusted networks.
  • Install plugins carefully because they run in the editor environment.
  • Keep the Etherpad image updated for editor and dependency fixes.

Verified Result

The Etherpad web interface loaded successfully from the deployed container.

Etherpad deployment questions

What does the Etherpad template deploy?

It deploys Etherpad with PostgreSQL, a persistent editor data volume, and an admin password.

Which port did the tutorial use?

The tutorial used host port 4104, which maps to the Etherpad web UI inside the container on the same generated port.

Does Etherpad need setup after deployment?

Create a harmless test pad, then open `/admin` with username `admin` and the configured admin password if you need to manage settings or plugins.

Should this become a blog post?

No. The deployment guide should live on the Etherpad template detail page and be linked from the reusable template deployment docs page.

After Deployment

After deploying Etherpad with Server Compass, complete these steps to finish setup

1

Visit the application URL — you should see a button to create a new pad

2

Visit /admin and log in as admin to install plugins or change settings

3

Configure public/private pad behavior in settings

4

Optionally set up a reverse proxy with HTTPS

Need help? Check out our documentation for detailed guides.

Etherpad FAQ

Common questions about self-hosting Etherpad

How do I deploy Etherpad with Server Compass?

Simply download Server Compass, connect to your VPS, and select Etherpad from the templates list. Fill in the required configuration and click Deploy. The entire process takes under 3 minutes.

What are the system requirements for Etherpad?

Etherpad requires a minimum of 512MB RAM. We recommend a VPS with at least 1024MB RAM for optimal performance. Any modern Linux server with Docker support will work.

Can I migrate my existing Etherpad data?

Yes! Server Compass provides volume mapping that allows you to import existing data. You can also use standard Etherpad backup and restore procedures.

How do I update Etherpad to the latest version?

Server Compass makes updates easy. Simply click the Update button in your deployment dashboard, and the latest Etherpad image will be pulled and deployed with zero downtime.

Is Etherpad free to self-host?

Etherpad is open-source software. You only pay for your VPS hosting (typically $5-20/month) and optionally Server Compass ($29 one-time). No subscription fees or per-seat pricing.

Ready to Self-Host Etherpad?

Download Server Compass and deploy Etherpad to your VPS in under 3 minutes. No Docker expertise required.

Download Server Compass