libretic
/
etherpad-lite
5
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
etherpad-lite/README.md

2.5 KiB
Raw Blame History

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 what makes it much leigther and more stable than the original Etherpad. Our hope is that this will encourage more users to install a realtime collaborative editor. A smaller and well documented codebase makes it easier for developers to improve the code

Online demo
Visit http://pitapoison.de:9001 to test it live

Why use Etherpad Lite?

  • Tiny server hardware footprint
  • Pure Javascript client and server side
  • Simplfied interface
  • Easy to embed
  • Well documented

Installation

  1. Download latest node.js version from http://nodejs.org/ and build it with this instructions https://github.com/joyent/node/wiki/Installation.
    THE NODE.JS VERSION OF YOUR LINUX REPOSITORY MAY BE TOO OLD. PLEASE COMPILE FROM THE SOURCE TO GET SURE YOU HAVE THE LATEST VERSION.
  2. Install npm curl http://npmjs.org/install.sh | sh
  3. Ensure you have installed the sqlite develob libraries, gzip and git apt-get install libsqlite3-dev gzip git-core
  4. Clone the git repository git clone 'git://github.com/Pita/etherpad-lite.git'
  5. Install the dependencies cd etherpad-lite && npm link
  6. Start it with bin/run.sh
  7. Open your web browser and visit http://localhost:9001

Next Steps

You can modify the settings in the file settings.json

You can update to the latest version with git pull origin && npm link

You can debug with bin/runDebug.sh

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.

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

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 ep-lite instance and share your experience with us.

License

Apache License v2