Real-time collaborative document editing https://pad.fuwafuwa.moe

Go to file

Peter 'Pita' Martischka ebeb2da275 Merge pull request #422 from jhollinger/fix_listPads HTTP API listPads should return an array		2012-02-14 09:22:18 -08:00
bin	Share `randomString` method.	2012-02-10 14:52:34 -08:00
doc	removed docs created with doc.md, these docs were completly useless	2011-12-04 17:12:27 +01:00
node	Merge pull request #422 from jhollinger/fix_listPads	2012-02-14 09:22:18 -08:00
static	Merge pull request #352 from cweider/modulize-share	2012-02-14 09:21:45 -08:00
var	Minify and compress JS & CSS before sending it	2011-05-28 18:09:17 +01:00
.gitignore	fixes automatic update	2012-02-04 18:46:43 +01:00
CHANGELOG.md	started a changelog	2011-08-23 18:59:32 +01:00
README.md	Changing openssl dev package name for Fedora to what it actually is.	2012-01-24 18:52:09 -06:00
package.json	package.json: upgrade clean-css package	2012-02-07 16:59:19 +01:00
settings.json.template	change settings sample to avoid error when editing httpAuth	2011-12-02 14:42:42 +01:00
settings.json.template_windows	editOnly should default to false	2011-11-25 21:24:00 -05:00
start.bat	added a buildForWindows script	2011-08-11 22:00:52 +01:00

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. There are several clients in for this API:

PHP, thx to TomNomNom
.Net, thx to ja-jo
Node.js, thx to tomassedovic
Ruby, thx to jhollinger
Python, thx to devjones

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

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

Linux

As root:

Install the dependencies. We need gzip, git, curl, libssl develop libraries, python and gcc.
For Debian/Ubuntu apt-get install gzip git-core curl python libssl-dev build-essential
For Fedora/CentOS yum install gzip git-core curl python openssl-devel && yum groupinstall "Development Tools"

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

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

Move to a folder where you want to install Etherpad Lite. Clone the git repository git clone 'git://github.com/Pita/etherpad-lite.git'
Install the dependencies with bin/installDeps.sh
Start it with bin/run.sh
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 should use a dedicated database such as "mysql" if you are planning on using etherpad-lite in a production environment, the "dirty" database driver is only for testing and/or development purposes.

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 by watching this video then read this git guide.

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.

Please consider using jshint if you plan to contribute to Etherpad Lite.

Modules created for this project

ueberDB "transforms every database into a object key value store" - manages all database access
channels "Event channels in node.js" - ensures that ueberDB operations are atomic and in series for each key
async-stacktrace "Improves node.js stacktraces and makes it easier to handle errors"

License

Apache License v2