fuwafuwa
/
etherpad-lite
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
Real-time collaborative document editing https://pad.fuwafuwa.moe
231 Commits 1 Branch 0 Tags 10 MiB
Go to file
Peter 'Pita' Martischka 997e163223 Improved the README 2011-07-11 22:46:01 +02:00
bin fixed a little bug in runSafe 2011-07-11 22:37:11 +02:00
doc Beautify the docs 2011-05-30 16:05:42 +01:00
node Improve the logging of Socket.IO Messages 2011-07-11 15:56:45 +02:00
static Show a read only link on the pad 2011-07-08 17:42:07 +01:00
tests added Pad model via Joose, PadManager is a lot cleaner now. 2011-05-16 16:30:21 +02:00
var Minify and compress JS & CSS before sending it 2011-05-28 18:09:17 +01:00
.gitignore use a downloaded jQuery instead of using googles CDN, and fixed btw a bug that let pad.js fails randomly 2011-06-30 18:06:07 +01:00
.npmignore Added a .npmignore for smaller npm packages 2011-05-19 13:17:24 +01:00
README.md Improved the README 2011-07-11 22:46:01 +02:00
package.json Install socket.io via a tarball. This is the only way to get a socket.io version that runs properly behind a reverse proxy. This is a temporary fix until a new socket.io version is released 2011-07-11 14:05:29 +02:00
settings.json.template Create a template of the settings file 2011-06-02 12:15:02 +01:00

README.md

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. Etherpad Lite is optimized to be easy embeddable

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

Etherpad vs Etherpad Lite

 EtherpadEtherpad Lite
Size of the folder (without git history)30 MB1.5 MB
Languages used server sideJavascript (Rhino), Java, ScalaJavascript (node.js)
Lines of server side Javascript code1014105330
RAM Usage immediately after start257 MB16 MB

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 might be too old/new. Please compile from the source to get sure you have the correct version. We support node.js version 0.4.*
  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 install
  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 install

You can debug with bin/runDebug.sh

Look at the Wiki: How to put Etherpad Lite behind a reverse Proxy, How to deploy Etherpad Lite as a service. 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.

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