diff --git a/README.md b/README.md index 637a885..f262335 100644 --- a/README.md +++ b/README.md @@ -141,24 +141,25 @@ To build the WAR file, type cd mvn clean install -Pprod -You can run the WAR file in 3 ways: +This will install the required JAR files in your local Maven repository (normally +at `~/.m2/repository`). You can run the WAR file in 3 ways: -1. directly from the **command-line**, using: - -``` -java -jar deployment/target/deployment-.war [--port ] [--silent] [--debug] [--help] -``` - - This will start the service at `http://localhost:/mapcode`. If `` is not specified, the - default value is `8080`. If it is `0`, the server will choose any free port. - -2. directly from **Maven** using: +1. Directly from **Maven** using: ``` cd deployment mvn jetty:run ``` - + +2. Or directly from the **command-line**, using: + +``` +java -jar deployment/target/deployment-.war [--port ] [--silent] [--debug] [--help] +``` + +This will start the service at `http://localhost:/mapcode`. If `` is not specified, the +default value is `8080`. If it is `0`, the server will choose any free port. + This will start the service at `http://localhost:8080/mapcode`. 3. in a **Tomcat server**, deploying the file `deployment/target/deployment-.war` into @@ -167,6 +168,9 @@ your Tomcat instance. The first method, running the WAR file from the command-line, using `java` only is particularly useful if you wish use the XML services, for example, in a Microsoft Excel spreadsheet. +**Important:** If the service does not start, some files may be missing from your `external-resources` +directory. To fix this, read on. + ### Missing `mapcode-secret.properties` and `log4j.xml` Files The service requires 2 files called `mapcode-secret.properties` and `log4j.xml` to be present on the @@ -351,6 +355,12 @@ self-hosting this service. ## Release Notes +### 2.4.14.4 + +* Changed `groupId` to `com.mapcode.rest`. + +* Updated `README.md` with correct instructions to create WAR file. + ### 2.4.14.3 * Updated dependencies. diff --git a/deployment/pom.xml b/deployment/pom.xml index 3a3d909..bc25228 100644 --- a/deployment/pom.xml +++ b/deployment/pom.xml @@ -21,9 +21,9 @@ 4.0.0 - com.mapcode + com.mapcode.rest mapcode-rest-service - 2.4.14.3 + 2.4.14.4 deployment diff --git a/pom.xml b/pom.xml index 383103e..0ce33ce 100644 --- a/pom.xml +++ b/pom.xml @@ -20,11 +20,11 @@ http://maven.apache.org/xsd/maven-4.0.0.xsd"> 4.0.0 - com.mapcode + com.mapcode.rest mapcode-rest-service pom - 2.4.14.3 + 2.4.14.4 Mapcode REST API Web Service diff --git a/resources/pom.xml b/resources/pom.xml index aa3fd33..dfae2e0 100644 --- a/resources/pom.xml +++ b/resources/pom.xml @@ -21,9 +21,9 @@ 4.0.0 - com.mapcode + com.mapcode.rest mapcode-rest-service - 2.4.14.3 + 2.4.14.4 resources diff --git a/service/pom.xml b/service/pom.xml index 5261039..a7ad397 100644 --- a/service/pom.xml +++ b/service/pom.xml @@ -21,9 +21,9 @@ 4.0.0 - com.mapcode + com.mapcode.rest mapcode-rest-service - 2.4.14.3 + 2.4.14.4 service