diff --git a/Architecture.md b/Architecture.md index 9c50504..9778a02 100644 --- a/Architecture.md +++ b/Architecture.md @@ -89,42 +89,52 @@ One of the best ways to build a custom deployment of this system is to use the M For instance, to overwrite the data source configuration in the main server war file, create a file named src/main/webapp/WEB-INF/data-context.xml that contains the dataSource bean. This file will completely replace the one that's in the originally built war. ### Steps to create an overlay project -1. Create a directory for the top level: mkdir example-openid-connect-overlay -2. Create example-openid-connect-overlay/pom.xml +1. Create a directory for the top level: `mkdir example-openid-connect-overlay` +2. Create `example-openid-connect-overlay/pom.xml` + <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> + <modelVersion>4.0.0</modelVersion> + <groupId>example.org</groupId> + <artifactId>example-openid-connect-overlay</artifactId> + <packaging>pom</packaging> + <version>1.0-SNAPSHOT</version> + <name>example-openid-connect-overlay</name> + <modules> + <module>OpenID-Connect-Java-Spring-Server</module> + <module>my-openid-connect</module> + </modules> + <dependencies> + <dependency> + <groupId>org.mitre</groupId> + <artifactId>openid-connect-server</artifactId> + <type>war</type> + <version>0.1-SNAPSHOT</version> + </dependency> + </dependencies> + <properties> + <java-version>1.6</java-version> + <org.springframework-version>3.1.1.RELEASE</org.springframework-version> + <org.slf4j-version>1.5.10</org.slf4j-version> + <spring.security.version>3.1.0.RELEASE</spring.security.version> + </properties> + <build> + <finalName>my-openid-connect-server</finalName> + </build> + </project> - <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> - <modelVersion>4.0.0</modelVersion> - <groupId>example.org</groupId> - <artifactId>example-openid-connect-overlay</artifactId> - <packaging>pom</packaging> - <version>1.0-SNAPSHOT</version> - <name>example-openid-connect-overlay</name> - <modules> - <module>OpenID-Connect-Java-Spring-Server</module> - <module>my-openid-connect</module> - </modules> - <dependencies> - <dependency> - <groupId>org.mitre</groupId> - <artifactId>openid-connect-server</artifactId> - <type>war</type> - <version>0.1-SNAPSHOT</version> - </dependency> - </dependencies> - <properties> - <java-version>1.6</java-version> - <org.springframework-version>3.1.1.RELEASE</org.springframework-version> - <org.slf4j-version>1.5.10</org.slf4j-version> - <spring.security.version>3.1.0.RELEASE</spring.security.version> - </properties> - <build> - <finalName>my-openid-connect-server</finalName> - </build> - </project> + This creates a project with two modules, one bing the `OpenID-Connect-Java-Spring-Server` (the original), and `my-openid-connect` which will hold our modifications we want to overlay. We also set some global properties (versions of Java, Spring, etc.) and the finalName of our project. -This creates a project with two modules, one bing the `OpenID-Connect-Java-Spring-Server` (the original), and `my-openid-connect` which will hold our modifications we want to overlay. +3. Now clone the `OpenID-Connect-Java-Spring-Server` into the `example-openid-connect-overlay/` directory + + cd example-openid-connect-overlay + git clone https://github.com/mitreid-connect/OpenID-Connect-Java-Spring-Server.git + cd OpenID-Connect-Java-Spring-Server + git submodule update --init --recursive + + You now have the current version of OpenID-Connect-Java-Spring-Server. You should make sure that the version in `example-openid-connect-overlay/OpenID-Connect-Java-Spring-Server/pom.xml` matches the dependency version for `openid-connect-server` located in `example-openid-connect-overlay/pom.xml` + +4. Create the my-openid-connect submodule ***