diff --git a/Home.md b/Home.md index b4c7530..8b6c00e 100644 --- a/Home.md +++ b/Home.md @@ -1 +1,15 @@ -Welcome to the OpenID-Connect-Java-Spring-Server wiki! \ No newline at end of file +Welcome to the OpenID-Connect-Java-Spring-Server wiki! + +### Deployment Instructions +The project's pom file is configured to run the maven-replacer plugin. This plugin looks for a file named local-values.conf at the root of the project directory (not inside the server package, directly at OpenID-Connect-Java-Spring-Server/). This file should look like the following: + + DB_URL=jdbc:mysql://msql_url + DB_USER=user + DB_PASSWORD=password + OPENID_IDENTIFIER=openid_identifier + OPENID_ROOT=root + OPENID_ADMINS=bob + +with the proper values for your deployment filled in. The project will fail to build if the file cannot be found. + +Since this file contains sensitive information (and will vary from deployment to deployment) it should not be checked in. \ No newline at end of file