From d9521405bea154b3569626394a522e0ddd924700 Mon Sep 17 00:00:00 2001
From: Christoph Thelen <christoph.thelen@mni.thm.de>
Date: Wed, 29 Jan 2014 12:49:32 +0100
Subject: [PATCH] README clarifications; added option to start Jetty w/o ARS
mobile
---
README.md | 10 +++++++---
pom.xml | 3 ++-
2 files changed, 9 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 793994cb7..c56d728ae 100644
--- a/README.md
+++ b/README.md
@@ -34,7 +34,7 @@ We will cover all three in the following sections.
#### Configuration
-You will need to do some configuration work upfront: add a new directory "arsnova" in `/etc`, and create a copy of [arsnova.properties.example](src/main/webapp/WEB-INF/arsnova.properties.example) named arsnova.properties in this directory. Then change the settings to match your environment, e.g. you might want to change the URLs.
+You will need to do some configuration work upfront: add a new directory "arsnova" in `/etc`, and create a copy of [arsnova.properties.example](src/main/webapp/arsnova.properties.example) named `arsnova.properties` in this directory. Then change the settings to match your environment, e.g. you might want to change the URLs.
Also, don't forget to change all properties starting with `couchdb`, if you do not want to use our defaults. The properties are used in the next section.
@@ -42,7 +42,7 @@ Also, don't forget to change all properties starting with `couchdb`, if you do n
#### Database
-We provide a Python script that will set up all database essentials. This "Setup Tool" is located at <https://github.com/thm-projects/setuptool>. Make sure you have configured your database credentials inside the ARSnova configuration file (see previous section): you will need to have the entries `couchdb.username` and `couchdb.password`.
+We provide a Python script that will set up all database essentials. This "Setup Tool" is located at [thm-projects/setuptool](https://github.com/thm-projects/setuptool). Make sure you have configured your database credentials inside the ARSnova configuration file (see previous section): you will need to have the entries `couchdb.username` and `couchdb.password`.
To set up the database, run:
@@ -54,10 +54,14 @@ This will create the database along with all required view documents. Note that
The easiest way to deploy ARSnova is via Jetty:
- mvn jetty:run
+ mvn jetty:run -Dmobile.path=
This will work out of the box. ARSnova will be located at <http://localhost:8080/developer.html>. Be sure to use `developer.html` instead of `index.html` because it does not use any minified scripts or stylesheets. This way, your changes will take effect immediately without an additional build step.
+If you're wondering what that `-Dmobile.path=` thing is doing, this is a special override property for Jetty. By default, this property points to a local version of ARSnova mobile located at `../arsnova-mobile` — relative to the location of this project. If you happen to have downloaded ARSnova mobile to this location, you may skip the override, and just use:
+
+ mvn jetty:run
+
## Production Use
If you intend to use ARSnova in productive environments, you will have to do some additional configuration work.
diff --git a/pom.xml b/pom.xml
index 64f71c380..52c171ba3 100644
--- a/pom.xml
+++ b/pom.xml
@@ -11,6 +11,7 @@
<org.springframework.security-version>3.1.4.RELEASE</org.springframework.security-version>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.url>https://scm.thm.de/arsnova</project.url>
+ <mobile.path>../arsnova-mobile/src/main/webapp</mobile.path>
</properties>
<developers>
@@ -346,7 +347,7 @@
<webApp>
<contextPath>/</contextPath>
<baseResource implementation="org.eclipse.jetty.util.resource.ResourceCollection">
- <resourcesAsCSV>src/main/webapp,../arsnova-mobile/src/main/webapp</resourcesAsCSV>
+ <resourcesAsCSV>src/main/webapp,${mobile.path}</resourcesAsCSV>
</baseResource>
<overrideDescriptor>src/main/webapp/WEB-INF/web-dev.xml</overrideDescriptor>
</webApp>
--
GitLab