diff --git a/README.md b/README.md index e0a5dd768462c7adbb1b487e3a46e7ac3ac32bb9..3369db736de654576e98f3fd6c60100c5d056274 100644 --- a/README.md +++ b/README.md @@ -11,28 +11,27 @@ A queueing system to be used at labs at EWI (tudelft.nl). In order to have the project setup properly for development a few steps need to be taken. - 1. First the config file should be moved from the template into the actual properties file - By executing ` cp src/main/resources/application.properties.template src/main/resources/application.properties ` - from the root directory of the project. - - 2. Follow these [instructions](https://gitlab.ewi.tudelft.nl/eip/labrador/queue/blob/development/Contributing.md#submitting-your-changes) - to submit your work +1. First the config file should be moved from the template into the actual properties file + by executing `cp src/main/resources/application.properties.template src/main/resources/application.properties` + from the root directory of the project. +1. Follow these [instructions](https://gitlab.ewi.tudelft.nl/eip/labrador/queue/blob/development/Contributing.md#submitting-your-changes) + to submit your work ### Run website from IDE 1. Install [IntelliJ IDEA Professional](https://www.jetbrains.com/idea/) ([free for students](https://www.jetbrains.com/student/)) -2. [Import project from Gradle model](https://www.jetbrains.com/idea/help/importing-project-from-gradle-model.html) -4. For IntelliJ to run the project make sure are running jdk 8. -4. Start the project by right-clicking `QueueApplication` and clicking 'Run' -5. Visit http://localhost:8081/ -6. Finally visit http://localhost:8081/users/login to login. +1. [Import project from Gradle model](https://www.jetbrains.com/idea/help/importing-project-from-gradle-model.html) +1. For IntelliJ to run the project make sure are running jdk 8. +1. Start the project by right-clicking `QueueApplication` and clicking 'Run' +1. Visit http://localhost:8081/ +1. Finally visit http://localhost:8081/users/login to login. Various test users credentials can be found in the `DataBaseLoader` class. ### Run website from CLI 1. `gradle build` -2. `sudo java -jar build/libs/queue-0.0.1-SNAPSHOT.jar` -3. Visit http://localhost:8081/ -4. Finally visit http://localhost:8081/users/login to login. +1. `sudo java -jar build/libs/queue-0.0.1-SNAPSHOT.jar` +1. Visit http://localhost:8081/ +1. Finally visit http://localhost:8081/users/login to login. Various test users credentials can be found in the `DataBaseLoader` class. ## Deployment @@ -74,7 +73,7 @@ The changelog can be found in src/main/resources/changeLog.yaml, the correspondi environment you need to change a few settings in the application properties file. 1. Point Spring to the changelog you want to apply using the: `liquibase.change-log=` property -2. Change the `spring.datasource.url=` property to a persistent h2 url rather than the in-memory variant. +1. Change the `spring.datasource.url=` property to a persistent h2 url rather than the in-memory variant. ## Roles @@ -104,8 +103,8 @@ In development you may not want to go through the SAML process. The traditional The SAML messages are cryptographically signed. The file `security/samlKeystore.jks` is a Java keystore. It has no password (when prompted for a password, enter the empty string). The development keystore contains a key with alias `apollo` and password `nalle123`. For production, you'll want to: 1. Create a PKCS12 file using your private key and a CA signed certificate of it. You can use openssl command for this: `openssl pkcs12 -export -in /etc/ssl/certs/queue_ewi_tudelft_nl.crt -inkey /etc/ssl/private/queue.ewi.tudelft.nl.key -certfile /etc/ssl/certs/queue_ewi_tudelft_nl.crt -out testkeystore.p12` -2. Create a Java keystore (.jks file) using the `keytool`: `keytool -importkeystore -srckeystore testkeystore.p12 -srcstoretype pkcs12 -destkeystore keystore.jks -deststoretype JKS` -3. To list the keys in the Java keystore: `keytool -list -v -keystore keystore.jks` +1. Create a Java keystore (.jks file) using the `keytool`: `keytool -importkeystore -srckeystore testkeystore.p12 -srcstoretype pkcs12 -destkeystore keystore.jks -deststoretype JKS` +1. To list the keys in the Java keystore: `keytool -list -v -keystore keystore.jks` ([source](http://xacmlinfo.org/2014/06/13/how-to-keystore-creating-jks-file-from-existing-private-key-and-certificate/)) @@ -128,3 +127,4 @@ The file to edit for this is mpm_prefork.conf and the directive is MaxRequestWor ### Security - To ensure forms have a `_csrf` field, either make sure the form uses `th:action`, as this automagically adds the field or add it by hand as a hidden input field. +