WAVE-311 Updates README with instrctions on installing MongoDB and Solr.
Project: http://git-wip-us.apache.org/repos/asf/incubator-wave/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-wave/commit/2e86453b Tree: http://git-wip-us.apache.org/repos/asf/incubator-wave/tree/2e86453b Diff: http://git-wip-us.apache.org/repos/asf/incubator-wave/diff/2e86453b Branch: refs/heads/master Commit: 2e86453b8228dbd04a9bd86758ddca2b81e23abc Parents: d8cc013 Author: Yuri Zelikov <[email protected]> Authored: Sun Aug 24 21:47:35 2014 +0300 Committer: Yuri Zelikov <[email protected]> Committed: Wed Aug 27 20:50:29 2014 +0300 ---------------------------------------------------------------------- README | 97 ++++++++++++++++++++++++++++++++++++------------------------- 1 file changed, 57 insertions(+), 40 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-wave/blob/2e86453b/README ---------------------------------------------------------------------- diff --git a/README b/README index 2498402..5719913 100644 --- a/README +++ b/README @@ -36,52 +36,52 @@ software: Run Binary ---------- - -Extract the archive and execute run-server.sh for Linux/Mac or run-server.bat for Windows. +The nigtly binaries can be downloaded from https://builds.apache.org/view/S-Z/view/Wave/job/wave-artifacts/lastSuccessfulBuild/artifact/. +The lastest "dev" releases can be downloaded from: https://dist.apache.org/repos/dist/dev/incubator/wave/. +The lastest offically released binaries can be downloaded from: https://dist.apache.org/repos/dist/release/incubator/wave/. +Extract the archive and execute run-server.sh for Linux/Mac or run-server.bat for Windows. +The web client will be accessible by default at http://localhost:9898/. Build ------ Wave in a Box requires Java 7 & and uses Ant 1.9.3 (or higher) to build. -To run the tests (optional), run: - -<code> - ant get-third-party test -</code> +To run the tests (optional), run: + ant get-third-party test -To build the client and server run: -<code> - ant get-third-party compile-gwt dist-server -</code> -It will be created in dist/wave-in-a-box-server-X.Y-incubating.jar. +To build the client and server run: + ant get-third-party compile-gwt dist-server +It will be created in dist/wave-in-a-box-server-X.Y-incubating.jar. -You need to configure your instance before you can use it. To create a default simple configuration run: -<code> - ant -f server-config.xml -</code> +You need to configure your instance before you can use it. To create a default simple configuration run: + ant -f server-config.xml To override default values pass them to the ant script. -For example, to override wave_server_domain run : ant -f server-config.xml -Dwave_server_domain=example.com +For example, to override wave\_server\_domain run: +ant -f server-config.xml -Dwave\_server\_domain=example.com Take a look at the server.config.example to learn about configuration and possible/default values. -The server can be started (on Linux/MacOS) by running -./run-server.sh -Or on Windows by running -run-server.bat -Or, you can run the server from the compiled classes with ant: -<code> - ant run-server -</code> -The web client will be accessible by default at http://localhost:9898/ - -To learn more about Wave in a Box and Wave Federation Protocol: -1. Look at the white papers folder - the information is a bit old but still usable. -2. Watch the Wave Summit videos on YouTube, find the links at: https://cwiki.apache.org/confluence/display/WAVE/Wave+Summit+Talks -3. Subscribe to the wave-dev mailing list, find instructions at http://incubator.apache.org/wave/mailing-lists.html - -Wave Protocol communicates using Protocol Buffers -<http://code.google.com/p/protobuf/> +The server can be started (on Linux/MacOS) by running + ./run-server.sh +Or on Windows by running + run-server.bat +Or, you can run the server from the compiled classes with ant: + ant run-server +The web client will be accessible by default at http://localhost:9898/. + + +To learn more about Wave in a Box and Wave Federation Protocol: +------ +1. Subscribe to the wave-dev mailing list, find instructions at http://incubator.apache.org/wave/mailing-lists.html. +2. Visit the Apache Wave wiki at https://cwiki.apache.org/confluence/display/WAVE/Home. +3. Look at the white papers folder - the information is a bit old but still usable. +4. Watch the Wave Summit videos on YouTube, find the links at: https://cwiki.apache.org/confluence/display/WAVE/Wave+Summit+Talks + +Protocol Buffers +-- +Wave Protocol communicates using Protocol Buffers <http://code.google.com/p/protobuf/>. + Because of the difficulty of distributing binaries, we do not include the protocol compiler in this distribution. Therefore, to rebuild updated protocol buffer files, you will need to install the binary protoc @@ -91,11 +91,8 @@ above. Additionally, you will have to update the build-proto.properties file to point to the unpacked source distribution of the protocol buffers release. -Then, after updating a proto file, run - -<code> - ant -f build-proto.xml compile compile_json -</code> +Then, after updating a proto file, run + ant -f build-proto.xml compile compile_json Note: this generates files into proto_src. If files here exist without write permission, you will get permission denied errors from this step. @@ -105,7 +102,7 @@ files. To enable SSL: - +-- Create a Java keystore for your server (e.g. using http://portecle.sourceforge.net/). You will need a key (e.g. called "server") whose subject Common Name (CN) is the hostname of your server. @@ -127,3 +124,23 @@ You can get your CA's certficate from their website, though note they might prov Users will be automatically logged in when they access the site, with the username taken from the email address in their certificate. + +Setting up third party optional dependencies: + +To enable MongoDB: +-- +In order to specify MongoDB in server.config as the storage option for storing deltas, accounts and attachments - you need to install according to instructions at: http://www.mongodb.org/downloads. +Or on Ubuntu Linux you can use the following command: + sudo apt-get install mongodb-org + +To enable Solr: +-- +In order to specify Solr in server.config as the search type - you need to install Solr according to instructions at: http://www.apache.org/dyn/closer.cgi/lucene/solr/4.9.0. +Or, you can use built in Ant script, i.e. run: + ant get-third-party-solr-dep +This will download and unzip the Solr distribution into third_party/solr folder. +You can then run the Solr server with: + run-solr.sh +for Linux/Mac or: + run-solr.bat +for Windows.
