Skip to content

Commit

Permalink
Merge pull request Waffle#481 from hazendaz/master
Browse files Browse the repository at this point in the history
[docs] Updates for 1.8.2 final requirements
  • Loading branch information
hazendaz authored Jan 28, 2017
2 parents 5d0c58b + b080857 commit b048d7d
Show file tree
Hide file tree
Showing 7 changed files with 9 additions and 14 deletions.
4 changes: 2 additions & 2 deletions Docs/GettingStartedWithWaffleAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,11 @@ set windowsAuthProviderImpl = CreateObject("Waffle.Windows.AuthProvider")
Getting Started in Java
-----------------------

Add `waffle-jna-1.8.1.jar`, `jna-4.2.2.jar`, `jna-platform-4.2.2.jar`, `guava-20.0.jar`, and `slf4j-api-1.7.21.jar` to your `CLASSPATH` or, if you use Maven, add the following to your `pom.xml`.
Add `waffle-jna-1.8.2.jar`, `jna-4.2.2.jar`, `jna-platform-4.2.2.jar`, `guava-20.0.jar`, and `slf4j-api-1.7.22.jar` to your `CLASSPATH` or, if you use Maven, add the following to your `pom.xml`.

``` xml
<properties>
<waffle.version>1.8.1</waffle.version>
<waffle.version>1.8.2</waffle.version>
</properties>

<dependency>
Expand Down
2 changes: 1 addition & 1 deletion Docs/MavenReleaseGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This is a guide for WAFFLE developers hoping to publish a release to Maven Centr
Building with Maven
-------------------

In order to build with [Maven][], you'll need Java 6+ and [Maven][] 3.2.1+. Download and install them, and then run `mvn --version` to check that it's working. If you don't already have it, also get Git and a clone of the WAFFLE repository. Once you have this, run `mvn package` in the `Source/JNA/waffle-parent` directory. This command compiles, unit tests, and JARs all of the WAFFLE components that are currently Maven-enabled.
In order to build with [Maven][], you'll need Java 7+ and [Maven][] 3.3.9+. Download and install them, and then run `mvn --version` to check that it's working. If you don't already have it, also get Git and a clone of the WAFFLE repository. Once you have this, run `mvn package` in the `Source/JNA/waffle-parent` directory. This command compiles, unit tests, and JARs all of the WAFFLE components that are currently Maven-enabled.

If you don't want to run the unit tests (which can be useful if you're trying to compile on a non-Windows platform), use `mvn package -DskipTests=true` instead. This isn't recommended for release builds.

Expand Down
6 changes: 3 additions & 3 deletions Docs/ServletSingleSignOnSecurityFilter.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Configuring Web Servers

The following steps are required to configure a web server with the Waffle Servlet Security Filter. These instructions work for Tomcat, Jetty, WebSphere and possibly others.

Package Waffle JARs, including `waffle-jna-1.8.1.jar`, `guava-19.0.jar`, `jna-4.2.2.jar`, `jna-platform-4.2.2.jar` and `slf4j-1.7.21.jar` in the application's `lib` directory or copy them to your web server's lib.
Package Waffle JARs, including `waffle-jna-1.8.2.jar`, `guava-20.0.jar`, `jna-4.2.2.jar`, `jna-platform-4.2.2.jar` and `slf4j-1.7.22.jar` in the application's `lib` directory or copy them to your web server's lib.

Add a security filter to `WEB-INF\web.xml` of your application.

Expand Down Expand Up @@ -112,13 +112,13 @@ You can use maven to build and deploy this demo application by following the ste
* Start your tomcat server. You can launch a locally installed tomcat with remote debugging enabled on port 8000 using:

```
apache-tomcat-6.0.44$ bin/catalina.sh jpda start
apache-tomcat-7.0.53$ bin/catalina.sh jpda start
```

* Build and Deploy the demo application to the local tomcat 6 instance. In the waffle source tree, move to the directory: waffle/Source/JNA/waffle-demo-parent/waffle-filter, and execute the following:

```
mvn clean package tomcat6:redeploy
mvn clean package tomcat7:redeploy
```

The app will be available at:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Configuring Tomcat

The following steps are required to configure Tomcat with Waffle Mixed Authenticator.

Place `waffle-jna-1.8.1.jar`, `guava-20.0.jar`, `jna-4.2.2.jar`, `jna-platform-4.2.2.jar`, `slf4j-1.7.21.jar` and `waffle-tomcat[tomcat version].jar` into your Tomcat's `lib` directory. It is *not* possible to place these files in `WEB-INF\lib`!
Place `waffle-jna-1.8.2.jar`, `guava-20.0.jar`, `jna-4.2.2.jar`, `jna-platform-4.2.2.jar`, `slf4j-1.7.22.jar` and `waffle-tomcat[tomcat version]-1.8.2.jar` into your Tomcat's `lib` directory. It is *not* possible to place these files in `WEB-INF\lib`!

If you are using Eclipse, you can see which files tomcat is importing by going to Java Recources: `src / Libraries / Apache Tomcat vx.x`. If you've placed it in the tomcat directory and still don't see it, restart Eclipse.

Expand Down
2 changes: 1 addition & 1 deletion Docs/tomcat/TomcatSingleSignOnValve.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Configuring Tomcat

The following steps are required to configure Tomcat with Waffle authenticator.

Package Waffle JARs, including `waffle-jna-1.8.1.jar`, `guava-20.0.jar`, `jna-4.2.2.jar`, `jna-platform-4.2.2.jar`, `slf4j-1.7.21.jar` and `waffle-tomcat-6.jar` in the application's lib directory or copy them to Tomcat's lib.
Package Waffle JARs, including `waffle-jna-1.8.2.jar`, `guava-20.0.jar`, `jna-4.2.2.jar`, `jna-platform-4.2.2.jar`, `slf4j-1.7.22.jar` and `waffle-tomcat[tomcat version]-1.8.2.jar` in the application's lib directory or copy them to Tomcat's lib.

Add a valve and a realm to the application context. For an application, modify `META-INF\context.xml`.

Expand Down
2 changes: 1 addition & 1 deletion Docs/tomcat/TomcatWindowsLoginJAASAuthenticator.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Configuring Tomcat

The following steps are required to configure Tomcat with Waffle authenticator.

Package Waffle JARs, including `waffle-jna-1.8.1.jar`, `guava-20.0.jar`, `jna-4.2.2.jar`, `jna-platform-4.2.2.jar`, `slf4j-1.7.21.jar` and `waffle-jaas.jar` in the application's lib directory or copy them to Tomcat's lib.
Package Waffle JARs, including `waffle-jna-1.8.2.jar`, `guava-20.0.jar`, `jna-4.2.2.jar`, `jna-platform-4.2.2.jar`, and `slf4j-1.7.22.jar` in the application's lib directory or copy them to Tomcat's lib.

Add a JAAS realm to the application context. Modify `META-INF\context.xml`.

Expand Down
5 changes: 0 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,6 @@ Essentials
* [Older Versions on CodePlex](https://waffle.codeplex.com/).
* [PlatformSDK Security Group](https://groups.google.com/group/microsoft.public.platformsdk.security)

Jetty
-----
Jetty support is built using java 7 like everything else. However, using the provided jetty version will require java 8 usage.
To continue with java 7, drop back to Jetty version 9.2.19.v20160908.

Documentation
-------------

Expand Down

0 comments on commit b048d7d

Please sign in to comment.