Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Containers for which we have specific installation guidance are shown in step 1 below, including some that we do not officially support. Material specific to any container is provided as a convenience, and is not a substitute for the container's own documentation.

  1. Prepare your Servlet container. Linux deployers may want to take a look at IdPLinuxNonRoot, which documents one way of using privileged ports. Some containers, such as Jetty, include alternatives. The links below are to (imperfect) examples provided by the project or by deployers. The list below is not reflective of the specific containers and versions we support, which is explicitly and only available on the SystemRequirements page.

  2. Download the latest Identity Provider software package (the zip file has Windows line endings, the tarball Unix line endings).

  3. Unpack the archive you downloaded to a convenient location. It will not be needed after installation.

  4. Change into the newly created distribution directory, shibboleth-identityprovider-VERSION.

  5. Run either bin/install.sh (on non-Windows systems) or bin\install.bat (on Windows systems).

    • The installation directory you provide will be referred to as idp.home throughout this documentation.

    • The installation directory cannot be the source directory.

  6. Deploy the IdP WAR file, located in war/idp.war. See the Servlet container preparation notes for examples on how to do this.

Property Driven Installation 

...

If everything is working correctly, you should see output summarizing the environment and information about the IdP's state. This doesn't mean that you will be able to log into anything yet as you have not yet configured the IdP to use your organization's infrastructure, added metadata, etc.

Typical Next Steps

  1. Review the top of the Configuration page to get some basic familiarity with the installation tree and how to use it.

  2. Configure authentication.

  3. Configure attribute resolution.

  4. Try the Hello World feature for initial testing of authentication and attribute resolution.

  5. Load SAML metadata for the service provider(s) with which you will interact and establish an appropriate attribute release policy.

  6. Customize your login UI, error handling, etc.

Rebuilding the WAR file

To rebuild the WAR file, run the build command line utility (bin/build.sh or bin\build.bat) from the installation directory idp.home.  Properties available are documented here.

...