etherpad-lite/README.md

127 lines
6.3 KiB
Markdown
Raw Normal View History

2012-09-10 14:44:06 +02:00
# Making collaborative editing the standard on the web
2011-08-21 18:23:04 +02:00
2011-04-07 16:17:40 +02:00
# About
2011-04-07 15:35:13 +02:00
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
2011-08-21 18:23:04 +02:00
is based on node.js ergo is much lighter and more stable than the original Etherpad. Our hope
2011-08-21 18:58:12 +02:00
is that this will encourage more users to use and install a realtime collaborative editor. A smaller, manageable and well
2012-09-10 14:44:06 +02:00
documented codebase makes it easier for developers to improve the code and contribute towards the project.
2011-08-21 18:23:04 +02:00
2012-09-10 14:44:06 +02:00
**Etherpad vs Etherpad lite**
2011-06-30 19:43:27 +02:00
<table>
<tr>
2011-07-07 19:21:20 +02:00
<td>&nbsp;</td><td><b>Etherpad</b></td><td><b>Etherpad Lite</b></td>
2011-06-30 19:43:27 +02:00
</tr>
<tr>
2011-07-07 19:21:20 +02:00
<td align="right">Size of the folder (without git history)</td><td>30 MB</td><td>1.5 MB</td>
2011-06-30 19:43:27 +02:00
</tr>
<tr>
2011-07-07 19:21:20 +02:00
<td align="right">Languages used server side</td><td>Javascript (Rhino), Java, Scala</td><td>Javascript (node.js)</td>
2011-06-30 19:43:27 +02:00
</tr>
<tr>
2011-08-23 18:56:54 +02:00
<td align="right">Lines of server side Javascript code</td><td>~101k</td><td>~9k</td>
2011-06-30 19:43:27 +02:00
</tr>
<tr>
2011-08-23 18:56:54 +02:00
<td align="right">RAM Usage immediately after start</td><td>257 MB (grows to ~1GB)</td><td>16 MB (grows to ~30MB)</td>
2011-06-30 19:43:27 +02:00
</tr>
2012-09-10 14:44:06 +02:00
</table>
2012-11-14 20:00:40 +01:00
Etherpad Lite is designed to be easily embeddable and provides a [HTTP API](https://github.com/ether/etherpad-lite/wiki/HTTP-API)
that allows your web application to manage pads, users and groups. It is recommended to use the client implementations available for this API, listed on [this wiki page](https://github.com/ether/etherpad-lite/wiki/HTTP-API-client-libraries).
2012-09-10 14:44:06 +02:00
There is also a [jQuery plugin](https://github.com/johnyma22/etherpad-lite-jquery-plugin) that helps you to embed Pads into your website
**Visit [beta.etherpad.org](http://beta.etherpad.org) to test it live**
2012-11-14 20:26:37 +01:00
Also, check out the **[FAQ](https://github.com/ether/etherpad-lite/wiki/FAQ)**, really!
2011-04-07 15:35:13 +02:00
# Installation
2011-08-21 18:23:04 +02:00
## Windows
2012-09-10 14:44:06 +02:00
### Prebuilt windows package
This package works out of the box on any windows machine, but it's not very useful for developing purposes...
2012-11-14 20:05:58 +01:00
1. Download the windows package <https://github.com/ether/etherpad-lite/downloads>
2012-09-10 14:44:06 +02:00
2. Extract the folder
Now, run `start.bat` and open <http://localhost:9001> in your browser. You like it? [Next steps](#next-steps).
### Fancy install
You'll need [node.js](http://nodejs.org) and (optionally, though recommended) git.
1. Grab the source, either
2012-11-14 20:05:58 +01:00
- download <https://github.com/ether/etherpad-lite/zipball/master>
- or `git clone https://github.com/ether/etherpad-lite.git` (for this you need git, obviously)
2012-09-10 14:44:06 +02:00
2. start `bin\installOnWindows.bat`
Now, run `start.bat` and open <http://localhost:9001> in your browser.
Update to the latest version with `git pull origin`, then run `bin\installOnWindows.bat`, again.
[Next steps](#next-steps).
2011-08-21 18:23:04 +02:00
## Linux
2012-09-10 14:44:06 +02:00
You'll need gzip, git, curl, libssl develop libraries, python and gcc.
*For Debian/Ubuntu*: `apt-get install gzip git-core curl python libssl-dev pkg-config build-essential`
*For Fedora/CentOS*: `yum install gzip git-core curl python openssl-devel && yum groupinstall "Development Tools"`
2012-09-10 14:44:06 +02:00
Additionally, you'll need [node.js](http://nodejs.org).
2011-08-02 23:15:59 +02:00
2011-08-09 23:44:33 +02:00
**As any user (we recommend creating a separate user called etherpad-lite):**
2011-08-02 23:15:59 +02:00
2012-11-14 20:05:58 +01:00
1. Move to a folder where you want to install Etherpad Lite. Clone the git repository `git clone git://github.com/ether/etherpad-lite.git`
2012-09-10 14:44:06 +02:00
2. Change into the new directory containing the cloned source code `cd etherpad-lite`
Now, run `bin/run.sh` and open <http://127.0.0.1:9001> in your browser.
2012-09-10 14:44:06 +02:00
Update to the latest version with `git pull origin`. The next start with bin/run.sh will update the dependencies.
You like it? [Next steps](#next-steps).
2011-04-07 15:35:13 +02:00
2012-09-10 14:44:06 +02:00
# Next Steps
2011-04-07 16:17:40 +02:00
2012-09-10 14:44:06 +02:00
## Tweak the settings
You can modify the settings in `settings.json`. (If you need to handle multiple settings files, you can pass the path to a settings file to `bin/run.sh` using the `-s|--settings` option. This allows you to run multiple Etherpad Lite instances from the same installation.)
2012-09-10 14:44:06 +02:00
You should use a dedicated database such as "mysql", if you are planning on using etherpad-lite in a production environment, since the "dirtyDB" database driver is only for testing and/or development purposes.
2012-09-10 14:44:06 +02:00
## Helpful resources
2012-11-14 20:05:58 +01:00
The [wiki](https://github.com/ether/etherpad-lite/wiki) is your one-stop resource for Tutorials and How-to's, really check it out! Also, feel free to improve these wiki pages.
2011-06-02 13:29:09 +02:00
2012-09-10 14:44:06 +02:00
Documentation can be found in `docs/`.
2011-08-04 21:33:39 +02:00
2012-09-10 14:44:06 +02:00
# Development
2011-06-02 13:29:09 +02:00
2012-09-10 14:44:06 +02:00
## Things you should know
Read this [git guide](http://learn.github.com/p/intro.html) and watch this [video on getting started with Etherpad Lite Development](http://youtu.be/67-Q26YH97E).
2011-07-11 22:45:19 +02:00
2012-09-10 14:44:06 +02:00
If you're new to node.js, start with Ryan Dahl's [Introduction to Node.js](http://youtu.be/jo_B4LTHi3I).
2011-06-02 13:29:09 +02:00
2012-09-10 14:44:06 +02:00
You can debug Etherpad lite using `bin/debugRun.sh`.
2011-06-02 13:29:09 +02:00
2012-11-14 20:26:37 +01:00
If you want to find out how Etherpad's `Easysync` works (the library that makes it really realtime), start with this [PDF](https://github.com/ether/etherpad-lite/raw/master/doc/easysync/easysync-full-description.pdf) (complex, but worth reading).
2011-08-02 23:15:59 +02:00
2012-09-10 14:44:06 +02:00
## Getting started
You know all this and just want to know how you can help?
2011-06-02 13:29:09 +02:00
2012-11-14 20:05:58 +01:00
Look at the [TODO list](https://github.com/ether/etherpad-lite/wiki/TODO) and our [Issue tracker](https://github.com/ether/etherpad-lite/issues). (Please consider using [jshint](http://www.jshint.com/about/), if you plan to contribute code.)
2011-06-02 13:29:09 +02:00
2012-11-14 20:26:37 +01:00
Also, and most importantly, read our [**Developer Guidelines**](https://github.com/ether/etherpad-lite/wiki/Developer-Guidelines), really!
2011-08-01 20:24:11 +02:00
2012-09-10 14:44:06 +02:00
# Get in touch
Join the [mailinglist](http://groups.google.com/group/etherpad-lite-dev) and make some noise on our freenode irc channel [#etherpad-lite-dev](http://webchat.freenode.net?channels=#etherpad-lite-dev)!
2011-12-21 21:32:17 +01:00
2011-08-01 20:24:11 +02:00
# Modules created for this project
2012-11-14 20:26:37 +01:00
* [ueberDB](https://github.com/ether/ueberDB) "transforms every database into a object key value store" - manages all database access
* [channels](https://github.com/ether/channels) "Event channels in node.js" - ensures that ueberDB operations are atomic and in series for each key
* [async-stacktrace](https://github.com/ether/async-stacktrace) "Improves node.js stacktraces and makes it easier to handle errors"
2011-08-01 20:24:11 +02:00
2012-09-10 14:44:06 +02:00
# Donate!
* [Flattr] (http://flattr.com/thing/71378/Etherpad-Foundation)
* Paypal - Press the donate button on [etherpad.org](http://etherpad.org)
2012-02-26 15:20:50 +01:00
2012-02-26 15:22:32 +01:00
# License
2012-11-14 20:26:37 +01:00
[Apache License v2](http://www.apache.org/licenses/LICENSE-2.0.html)