From 97382e365c9e0b8f3ccc968b2651cfcb2103e0cf Mon Sep 17 00:00:00 2001 From: Peter 'Pita' Martischka Date: Thu, 4 Aug 2011 20:33:39 +0100 Subject: [PATCH] Improved the README --- README.md | 31 +++++++++++++++++++++---------- 1 file changed, 21 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 18c145ef4..57ce3123f 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ documented codebase makes it easier for developers to improve the code. Etherpad to be easy embeddable. Look at our [FAQ Page](https://github.com/Pita/etherpad-lite/wiki/FAQ) **Online demo**
-Visit to test it live. 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 to test it live.
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/) # Etherpad vs Etherpad Lite @@ -31,26 +31,36 @@ Visit to test it live. You can find the same instanc # Installation **As root:** -1. Download the latest **0.4.x** node.js release from , extract it and build it with `./configure && make && make install`.
-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. -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` +
    +
  1. Install all dependencies. We need the sqlite develob libraries, gzip, git, curl, wget, libssl develop libraries and python
    apt-get install libsqlite3-dev gzip git-core curl wget python libssl-dev

    2. +
  2. Install node.js +
      +
    1. Download the latest 0.4.x node.js release from http://nodejs.org/#download
      2. +
    2. Extract it with tar xf node-v0.4*
      3. +
    3. move into the node folder cd node-v0.4* and build node with ./configure && make && make install
      4. +
    +
    3. +
  3. Install npm curl http://npmjs.org/install.sh | sh
    4. +
**As any user (we recommend creating a seperate user called etherpad-lite):** -4. Clone the git repository `git clone 'git://github.com/Pita/etherpad-lite.git'` -5. Start it with `bin/run.sh` (the first run will install all dependencies) -6. Open your web browser and visit +
    +
  1. Clone the git repository git clone 'git://github.com/Pita/etherpad-lite.git'
     
    2. +
  2. Install the dependencies with bin/installDeps.sh (if you have problems at this step, look at the section Troubleshooting below)
     
    3. +
  3. Start it with bin/run.sh
     
    4. +
  4. Open your web browser and visit http://localhost:9001. You like it? Look at the 'Next Steps' section below
    5. +
## Troubleshooting ### It fails while installing the sqlite dependency -The sqlite package of some linux versions (including debian lenny) is too old. You have to use a PPA or debian backports +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 -### I stopped the installing process, now it doesn't work anymore, what can I do? +### 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 @@ -59,6 +69,7 @@ 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 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)