Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

An Etherpad based on node.js - Our goal is to make collaborative editing the standard on the web

branch: dokuwiki-merge
README.md

Our goal is to make collaborative editing the standard on the web

About

Etherpad lite is a really-real time collaborative editor spawned from the Hell fire of Etherpad. We're reusing the well tested Etherpad easysync library to make it really realtime. Etherpad Lite is based on node.js ergo is much lighter and more stable than the original Etherpad. Our hope is that this will encourage more users to use and install a realtime collaborative editor. A smaller, manageable and well documented codebase makes it easier for developers to improve the code and contribute towards the project.

Etherpad Lite is optimized to be easy embeddable. It provides a HTTP API that allows your web application to manage pads, users and groups. You can use this PHP Client to work with the API (If you don't want to use PHP, feel free to create a client for your favourite web development language). There is also a jQuery plugin that helps you to embed Pads into your website

Online demo
Visit http://beta.etherpad.org to test it live

Here is the FAQ

Etherpad vs Etherpad Lite

  Etherpad Etherpad Lite
Size of the folder (without git history) 30 MB 1.5 MB
Languages used server side Javascript (Rhino), Java, Scala Javascript (node.js)
Lines of server side Javascript code ~101k ~9k
RAM Usage immediately after start 257 MB (grows to ~1GB) 16 MB (grows to ~30MB)

Installation

Windows

  1. Download http://etherpad.org/etherpad-lite-win.zip
  2. Extract the file
  3. Open the extracted folder and double click start.bat
  4. Open your web browser and browse to http://localhost:9001. You like it? Look at the 'Next Steps' section below

Linux

As root:

  1. Install the dependencies. We need the gzip, git, curl, libssl develop libraries and python
    apt-get install gzip git-core curl python libssl-dev build-essential

  2. Install node.js
    1. Download the latest 0.4.x node.js release from http://nodejs.org/#download
    2. Extract it with tar xf node-v0.4*
    3. Move into the node folder cd node-v0.4* and build node with ./configure && make && make install
  3. Install npm curl http://npmjs.org/install.sh | sh

As any user (we recommend creating a separate user called etherpad-lite):

  1. Move to a folder where you want to install Etherpad Lite. Clone the git repository git clone 'git://github.com/Pita/etherpad-lite.git'
     
  2. Install the dependencies with bin/installDeps.sh
     
  3. Start it with bin/run.sh
     
  4. Open your web browser and visit http://localhost:9001. You like it? Look at the 'Next Steps' section below

Next Steps

You can modify the settings in the file settings.json

You can update to the latest version with git pull origin. The next start with bin/run.sh will update the dependencies

Look at this wiki pages:

You can find more information in the wiki. Feel free to improve these wiki pages

Develop

If you're new to git and github, start here http://learn.github.com/p/intro.html.

If you're new to node.js, start with this video http://youtu.be/jo_B4LTHi3I.

You can debug with bin/debugRun.sh

If you want to find out how Etherpads Easysync works (the library that makes it really realtime), start with this PDF (complex, but worth reading).

You know all this and just want to know how you can help? Look at the TODO list. You can join the mailinglist or go to the freenode irc channel #etherpad-lite-dev

You also help the project, if you only host a Etherpad Lite instance and share your experience with us.

Modules created for this project

  • ueberDB "transforms every database into a object key value store" - manages all database access
  • doc.md "A simple JSDoc documentation tool that creates markdown for node.js modules exports" - is used to generate the docs
  • channels "Event channels in node.js" - ensures that ueberDB operations are atomic and in series for each key

License

Apache License v2

Something went wrong with that request. Please try again.