From b8af62fdef791e3709a2ebc0443046a4416e1b42 Mon Sep 17 00:00:00 2001 From: Gabriel Liwerant Date: Tue, 20 Jan 2015 10:53:52 -0500 Subject: [PATCH] Add subdirectory installation instructions Out of the box, etherpad-lite does not work correctly if cloned/installed into a subdirectory within an existing project. To do so, a few minor tweaks to the installation process are necessary which are documented here. --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 0cddb0b0f..63916ba77 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,12 @@ Now, run `start.bat` and open in your browser. Update to the latest version with `git pull origin`, then run `bin\installOnWindows.bat`, again. +If cloning to a subdirectory within another project, you may need to do the following: + +1. Start the server manually (e.g. `node/node_modules/ep_etherpad-lite/node/server.js]`) +2. Edit the db `filename` in `settings.json` to the relative directory with the file (e.g. `application/lib/etherpad-lite/var/dirty.db`) +3. Add auto-generated files to the main project `.gitignore` + [Next steps](#next-steps). ## GNU/Linux and other UNIX-like systems