Update README.md for new config and documentation
Project: http://git-wip-us.apache.org/repos/asf/incubator-wave/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-wave/commit/d786b8b6 Tree: http://git-wip-us.apache.org/repos/asf/incubator-wave/tree/d786b8b6 Diff: http://git-wip-us.apache.org/repos/asf/incubator-wave/diff/d786b8b6 Branch: refs/heads/0.4.0-rc10 Commit: d786b8b6c3ff99ddc2765bd82ae1846c966fbb6f Parents: c3ed45e Author: Ali Lown <[email protected]> Authored: Sat Oct 10 07:24:08 2015 +0100 Committer: Ali Lown <[email protected]> Committed: Sat Oct 10 07:24:45 2015 +0100 ---------------------------------------------------------------------- README.md | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-wave/blob/d786b8b6/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index b227c16..2c93325 100644 --- a/README.md +++ b/README.md @@ -54,13 +54,8 @@ 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: - 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 -Take a look at the server.config.example to learn about configuration and possible/default values. +You need to configure your instance before you can use it. A complete list of commented configuration options has +been provided in reference.conf, which is setup by default to start a localhost-only server instance. The server can be started (on Linux/MacOS) by running ./run-server.sh @@ -74,7 +69,7 @@ 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. +2. Download the Apache Wave documentation at https://incubator.apache.org/wave/documentation.html 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 @@ -129,13 +124,13 @@ 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. +In order to specify MongoDB in reference.conf 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.1. +In order to specify Solr in reference.conf as the search type - you need to install Solr according to instructions at: http://www.apache.org/dyn/closer.cgi/lucene/solr/4.9.1. 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.
