diff --git a/README.md b/README.md index c4454c3787c01eaeb4102122c11023b6a38d39e2..6b03b313d17027aba8bb0ea1d72874255094a664 100644 --- a/README.md +++ b/README.md @@ -10,32 +10,32 @@ A starter application in spring boot & angular 2. ## Setting up the spring project -- First we need to set up the hidden file folder and hidden files (default hidden folder is in **/home/nikp/properties**). <br /> +* First we need to set up the hidden file folder and hidden files (default hidden folder is in **/home/nikp/properties**). <br /> The hidden files are these: - - A certificate file for accessing the CERN services + * A certificate file for accessing the CERN services (default name in the hidden folder: **sample-app.jks**) - - Download CERN certificates from + * Download CERN certificates from https://cafiles.cern.ch/cafiles/certificates/Grid.aspx **CERN Root Certification Authority 2.crt** and **CERN Grid Certification Authority.crt** - - Install certificate(Linux instructions): - - Open a console - - sudo keytool -import -file CERN\ Grid\ Certification\ Authority.crt -alias cern_grid -keystore $JAVA_HOME/jre/lib/security/cacerts - - sudo keytool -import -file CERN\ Root\ Certification\ Authority\ 2.crt -alias cern_root -keystore $JAVA_HOME/jre/lib/security/cacerts - - A property file per environment of your application , Dev, Prod, etc... + * Install certificate(Linux instructions): + * Open a console + * sudo keytool -import -file CERN\ Grid\ Certification\ Authority.crt -alias cern_grid -keystore $JAVA_HOME/jre/lib/security/cacerts + * sudo keytool -import -file CERN\ Root\ Certification\ Authority\ 2.crt -alias cern_root -keystore $JAVA_HOME/jre/lib/security/cacerts + * A property file per environment of your application , Dev, Prod, etc... The naming convention is as follows: app-ENVIRONMENT.properties (ex. for dev -> app-dev.properties)<br > A sample for this file is in the root folder of the project, named **app-ENVIRONMENT.properties**. -- Then we have to install java-8 and make sure that it has the needed policy files - - After installing java-8, make sure to replace the JCE policy files with the appropriate ones from:<br > +* Then we have to install java-8 and make sure that it has the needed policy files + * After installing java-8, make sure to replace the JCE policy files with the appropriate ones from:<br > http://www.oracle.com/technetwork/java/javase/downloads/jce8-download-2133166.html<br > The policy files can be found at $JAVA_HOME/jre/lib/security. The files that you will change are **local_policy.jar** and **US_export_policy.jar** -- By now most likely the LDAP authentication should be working. If it's not, then something went wrong in the previous steps <br > +* By now most likely the LDAP authentication should be working. If it's not, then something went wrong in the previous steps <br > Now to set up also the SSO authentication, you will have to register the application at https://sso-management.web.cern.ch/SSO/RegisterApplication.aspx - - It's important that you choose as your **Service Provider type** --> **SAML2 with online metadata** - - And in the **Application Metadata Uri** you should put https://YOUR-APPLICATION-MAIN-URL/saml/metadata <br > + * It's important that you choose as your **Service Provider type** --> **SAML2 with online metadata** + * And in the **Application Metadata Uri** you should put https://YOUR-APPLICATION-MAIN-URL/saml/metadata <br > (To check that it's the correct URl, by redirecting to the above url you should be getting an xml file) - - Finally for the **Application Homapage** put this https://YOUR-APPLICATION-MAIN-URL and wait for the SSO team to register your application. + * Finally for the **Application Homapage** put this https://YOUR-APPLICATION-MAIN-URL and wait for the SSO team to register your application. It's important that you leave your application running for them to approve it. -- Now you should be ready to start working :) . +* Now you should be ready to start working :) . ## Commands for gradle/Spring - `gradle clean`: clean the generated build dir