Adding installation and configuration notes to README

README.md

@@ -1,19 +1,48 @@
-# PrintCodeWebService
+# PrintCodeWebService (PC-WS)
 
 Main service for the BFH AppTrans exercise.
 
 Live demo (with mock external systems) at https://bfh-pcws-mock.herokuapp.com/swagger-ui.html
 
 See also https://github.com/SamuelBucheliZ/bfh-apptrans-exercise/blob/master/README.md
 
+## Versions
+
+PC-WS is known to work with the following versions
+
+- Java: 8
+- Tomcat: 9
+- PostgreSQL: 10
+
+## Installation
+
+The relevant artifacts can be found here https://github.com/SamuelBucheliZ/bfh-pcws/releases/tag/v1.0
+
+1. Set up database using [setup_db.sql](https://github.com/SamuelBucheliZ/bfh-pcws/releases/download/v1.0/setup_db.sql).
+2. Set up cronjob to run [transfer_logs.sh](https://github.com/SamuelBucheliZ/bfh-pcws/releases/download/v1.0/transfer_logs.sh) every minute.
+3. Deploy [pcws.war](https://github.com/SamuelBucheliZ/bfh-pcws/releases/download/v1.0/pcws.war) in Tomcat.
+
+## Configuration
+
+The PrintCode-WebService can be configured using the following environment variables
+- `SPRING_PROFILES_ACTIVE`: Either `real` (to use the actual external services and database)  or `mock` (to use mocked services). For the exercise, eventually, the `real` configuration must be used.
+- `PCWS_DATALOG_DIRECTORY`: Absolute path to the directory the service should write the datalogs into, e.g., `/datalogDirectory`.
+- `PCWS_ACCOUNT_SERVICE_URL`: URL of the account service, you can use `https://bfh-paketblitz-account-service.herokuapp.com`.
+- `PCWS_DATASOURCE_JDBC_URL`: JDBC URL of the database, this has the form `jdbc:postgresql://<hostname>:<port>/<database-name>`.
+- `PCWS_DATASOURCE_USERNAME` and `PCWS_DATASOURCE_PASSWORD`: Credentials to access the database.
+
+The shell script to transfer the logs can be configured using the following environment variables
+- `PCWS_DATALOG_DIRECTORY`: Location of the datalog files to send. 
+- `PCWS_DATALOG_SERVICE_URL`: URL of the datalog service, you can use `https://bfh-paketblitz-datalog-service.herokuapp.com`.
+
 ## How to build
 
 Build war for Tomcat deployment (for the exercise)
 ```
 mvn clean package -Pwar
 ``` 
 
-Build standalone jar (for demo and Heroku)
+Build standalone jar (for demo on Heroku)
 ```
 mvn clean package -Pjar
 ```