Etherpad is an amazing real-time collaborative editor with a very low barrier for entry (no logins, no additional software, etc.). In case you missed it, Etherpad was acquired by Google and after a community uproar decided to release their code as open source under the Apache License 2.0.
We were excited to get it up and running for our own internal use. What follows is a step-by-step guide of how we proped it up on our development servers.
- We’re not Java guys, so if there is something we could be doing better, let us know.
- The default setup of Etherpad is RAM hungry. Make sure you have at least 256MB free before you get started.
- Our instructions are Ubuntu/Debian specific, but should be easy to translate to a different distribution.
Step 1: Get the RequirementsThis sets up your application directory and installs the requirements. <em>Note: Sun Java is required. Confirm you are using it with
Step 2: Setup your Environment
Create a bash script called
export.sh that stores you system paths for everything Etherpad needs.
Step 3: Setup your Database
Create a MySQL database.Of course, you’ll want to use a secure password. Store your MySQL settings under
Step 4: Build your Jar and Serve it
There are nice helper scripts provided to make this step happen.Assuming things went well, you should have your own Etherpad instance running at http://localhost:9000. Note: the port can be changed in
Step 5: Pushing it Live
We already have Nginx running on port 80 of this server, so proxying to the application was trivial. You can find a basic Nginx proxy configuration here.
You’ll also need to append your domain to the
SUPERDOMAINS variable in
etherpad-trunk/trunk/etherpad/src/etherpad/globals.js. That will look something like this: