diff options
author | Peter 'Pita' Martischka <petermartischka@googlemail.com> | 2011-08-21 17:23:04 +0100 |
---|---|---|
committer | Peter 'Pita' Martischka <petermartischka@googlemail.com> | 2011-08-21 17:23:04 +0100 |
commit | 0260a742bc97de9f51029a1fe36a5831c943bc09 (patch) | |
tree | 7d8d1d7c6482457e24954cd5fca0c1377d11496c /README.md | |
parent | e4af96e67b7b2759be97b5700f0285c06925b8e8 (diff) | |
download | etherpad-lite-0260a742bc97de9f51029a1fe36a5831c943bc09.zip |
Improved the README
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 55 |
1 files changed, 28 insertions, 27 deletions
@@ -1,13 +1,22 @@ +# 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 what makes it much lighter 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. Look at our [FAQ Page](https://github.com/Pita/etherpad-lite/wiki/FAQ) +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, managable 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](https://github.com/Pita/etherpad-lite/wiki/HTTP-API) +that allows your web application to manage pads, users and groups. +You can use this [PHP Client](https://github.com/TomNomNom/etherpad-lite-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](https://github.com/johnyma22/etherpad-lite-jquery-plugin) that helps you to embed Pads into your website **Online demo**<br> -Visit <http://pitapoison.de:9001> to test it live. <br>You can find the same instance behind a nginx, with ssl and in a subpath here -> [https://pad.pitapoison.de/pad/](https://pad.pitapoison.de/pad/) +Visit <http://beta.etherpad.org> to test it live. <br>You can find the same instance behind a nginx, with ssl and in a subpath here -> [https://pad.pitapoison.de/pad/](https://pad.pitapoison.de/pad/) + +Here is the **[FAQ](https://github.com/Pita/etherpad-lite/wiki/FAQ)** # Etherpad vs Etherpad Lite <table> @@ -30,24 +39,24 @@ Visit <http://pitapoison.de:9001> to test it live. <br>You can find the same ins # Installation -# Windows +## 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> +4. Open your web browser and browse to <http://localhost:9001>. You like it? Look at the 'Next Steps' section below -# Linux +## Linux **As root:** <ol> - <li>Install all dependencies. We need the sqlite development libraries, gzip, git, curl, libssl develop libraries and python <br><code>apt-get install libsqlite3-dev gzip git-core curl python libssl-dev</code></li><br> + <li>Install the dependencies. We need the gzip, git, curl, libssl develop libraries and python <br><code>apt-get install gzip git-core curl python libssl-dev</code></li><br> <li>Install node.js <ol type="a"> <li>Download the latest <b>0.4.x</b> node.js release from <a href="http://nodejs.org/#download">http://nodejs.org/#download</a></li> <li>Extract it with <code>tar xf node-v0.4*</code></li> - <li>move into the node folder <code>cd node-v0.4*</code> and build node with <code>./configure && make && make install</code></li> + <li>Move into the node folder <code>cd node-v0.4*</code> and build node with <code>./configure && make && make install</code></li> </ol> </li> <li>Install npm <code>curl http://npmjs.org/install.sh | sh</code></li> @@ -56,25 +65,14 @@ Visit <http://pitapoison.de:9001> to test it live. <br>You can find the same ins **As any user (we recommend creating a separate user called etherpad-lite):** <ol start="4"> - <li> Move to a folder where you want to install Etherpad Lite. Clone the git repository <code>git clone 'git://github.com/Pita/etherpad-lite.git'</code><br> </li> - <li> Install the dependencies with <code>bin/installDeps.sh</code> <i>(if you have problems at this step, look at the section Troubleshooting below)</i><br> </li> - <li> Start it with <code>bin/run.sh</code><br> </li> - <li> Open your web browser and visit <a href="http://localhost:9001">http://localhost:9001</a>. You like it? Look at the 'Next Steps' section below</li> + <li>Move to a folder where you want to install Etherpad Lite. Clone the git repository <code>git clone 'git://github.com/Pita/etherpad-lite.git'</code><br> </li> + <li>Install the dependencies with <code>bin/installDeps.sh</code><br> </li> + <li>Start it with <code>bin/run.sh</code><br> </li> + <li>Open your web browser and visit <a href="http://localhost:9001">http://localhost:9001</a>. You like it? Look at the 'Next Steps' section below</li> </ol> -## Troubleshooting - -### It fails while installing the sqlite dependency -The sqlite package of some Linux versions (including debian lenny) is too old. We need sqlite >=3.6. You have to use a PPA or debian backports. You find sqlite packages for Ubuntu Hardy [here](https://launchpad.net/~mirabilos/+archive/ppa/+sourcepub/1304941/+listing-archive-extra), Debian Backports can be found [here](http://backports-master.debian.org/Instructions/#index1h2) - -### It fails while installing the express dependency, it says my node version is wrong -You might have installed node.js version 0.5. You can check that with `node --version`. Please reinstall node 0.4.x - -### My installation process stopped, now it doesn't work anymore, what can I do? -Remove the node_modules folder. This forces run.sh to reinstall all dependencies - ## Next Steps -You can modify the settings in the file settings.json +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 @@ -83,6 +81,9 @@ Look at this wiki pages: * [How to deploy Etherpad Lite as a service](https://github.com/Pita/etherpad-lite/wiki/How-to-deploy-Etherpad-Lite-as-a-service) * [How to put Etherpad Lite behind a reverse Proxy](https://github.com/Pita/etherpad-lite/wiki/How-to-put-Etherpad-Lite-behind-a-reverse-Proxy) * [How to customize your Etherpad Lite installation](https://github.com/Pita/etherpad-lite/wiki/How-to-customize-your-Etherpad-Lite-installation) +* [How to use Etherpad-Lite with jQuery](https://github.com/Pita/etherpad-lite/wiki/How-to-use-Etherpad-Lite-with-jQuery) +* [How to use Etherpad Lite with MySQL](https://github.com/Pita/etherpad-lite/wiki/How-to-use-Etherpad-Lite-with-MySQL) +* [Sites that run Etherpad Lite](https://github.com/Pita/etherpad-lite/wiki/Sites-that-run-Etherpad-Lite)) You can find more information in the [wiki](https://github.com/Pita/etherpad-lite/wiki). Feel free to improve these wiki pages @@ -93,7 +94,7 @@ 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 wanna find out how Etherpads Easysync works (the library that makes it really realtime), start with this [PDF](https://github.com/Pita/etherpad-lite/raw/master/doc/easysync/easysync-full-description.pdf) (complex, but worth reading it). +If you want to find out how Etherpads Easysync works (the library that makes it really realtime), start with this [PDF](https://github.com/Pita/etherpad-lite/raw/master/doc/easysync/easysync-full-description.pdf) (complex, but worth reading). You know all this and just want to know how you can help? Look at the [TODO list](https://github.com/Pita/etherpad-lite/wiki/TODO). You can join the [mailinglist](http://groups.google.com/group/etherpad-lite-dev) or go to the freenode irc channel [#etherpad-lite-dev](http://webchat.freenode.net?channels=#etherpad-lite-dev) |