github
/
OpenID-Connect-Java-Spring-Server
mirror of https://github.com/mitreid-connect/OpenID-Connect-Java-Spring-Server
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Updated Build Instructions (markdown)

master
Justin Richer 2014-01-14 07:03:33 -08:00
parent ea97b95ef8
commit b26242ef2c
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Build-Instructions.md

@ -14,8 +14,9 @@ The project has a hierarchical layout:
+-- openid-connect-common +-- openid-connect-common
+-- openid-connect-client +-- openid-connect-client
+-- openid-connect-server +-- openid-connect-server
+-- openid-connect-server-webapp
`openid-connect-common`, `openid-connect-client`, and `openid-connect-server` are each managed as individual Maven submodules. The root of the project contains a `pom.xml` file that references all sub-modules and manages dependencies for the entire project. `openid-connect-common`, `openid-connect-client`, `openid-connect-server`, and `openid-connect-server-webapp` are each managed as individual Maven submodules. The root of the project contains a `pom.xml` file that references all sub-modules. Most Maven commands should be run from this parent project.
# Building with Maven # Building with Maven
@ -29,9 +30,10 @@ The build process produces a .jar file for `openid-connect-common` and `openid-c
openid-connect-client/target/openid-connect-client-{VERSION}.jar openid-connect-client/target/openid-connect-client-{VERSION}.jar
openid-connect-common/target/openid-connect-common-{VERSION}.jar openid-connect-common/target/openid-connect-common-{VERSION}.jar
openid-connect-server/target/openid-connect-server.war openid-connect-server/target/openid-connect-server-{VERSION}.jar
openid-connect-server-webapp/target/openid-connect-server-webapp.war
Where `{VERSION}` is the current build version of the project such as `0.9.3-SNAPSHOT`. Where `{VERSION}` is the current build version of the project such as `1.1.0-SNAPSHOT`.
## Common Maven Options ## Common Maven Options
@ -43,15 +45,15 @@ To skip JavaDoc generation:
`mvn -Dmaven.javadoc.skip=true package` `mvn -Dmaven.javadoc.skip=true package`
To configure an http and https proxy, add this option (especially because Maven on Linux doesn't always read the settings.xml file): To configure an http and https proxy, add this option (especially because it seems that Maven on Linux doesn't always read the settings.xml file):
`mvn -Dhttp.proxyHost=proxy -Dhttp.proxyPort=80 -Dhttps.proxyHost=proxy -Dhttps.proxyPort=80 package` `mvn -Dhttp.proxyHost=proxy -Dhttp.proxyPort=80 -Dhttps.proxyHost=proxy -Dhttps.proxyPort=80 package`
## Data Connection ## Data Connection
The server is configured out of the box to use an in-memory HyperSQL database (hsqldb). All data that the server stores, such as tokens, clients, and user authorizations, will be lost when the server is shut down. In order to persist data for longer than a single session, it is necessary to change the data source as configured in `openid-connect-server/src/main/webapp/WEB-INF/data-context.xml`. The demo server webapp is configured out of the box to use an in-memory HyperSQL database (hsqldb). All data that the server stores, such as tokens, clients, and user authorizations, will be lost when the server is shut down. In order to persist data for longer than a single session, it is necessary to change the data source as configured in `openid-connect-server/src/main/webapp/WEB-INF/data-context.xml`.
The server is auto-configured with one client and four users, which are enumerated in the file `openid-connect-server/src/main/resources/db/clients.sql` and `openid-connect-server/src/main/resources/db/users.sql`. These files are automatically loaded by the hsqldb data source and can be edited to hold other clients and users. The server is auto-configured with one client and two users, which are enumerated in the file `openid-connect-server/src/main/resources/db/clients.sql` and `openid-connect-server/src/main/resources/db/users.sql`. These files are automatically loaded by the hsqldb data source and can be edited to hold other clients and users.
## Java Cryptographic Extensions (JCE) ## Java Cryptographic Extensions (JCE)