Versions Compared

Key

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

...

  1. Install OpenAthens software
    Anchor
    install
    install


    1. The recommended method is to use our Maven repository. For connection details see: Maven settings for Java OASP

    2. You can also download the software as a zip file from https://download.openathens.net. Both will use the same OpenAthens credentials as the publisher dashboard.

      Expand
      titleMaven settings

      Add to your settings.xml file

      Code Block
      <servers>
        <server>
          <id>eduserv</id>
          <username>USERNAME</username>
          <password>{SecurePasswordReference}</password>
        </server>
      </servers>
      Info
      iconfalse

      For information on how Maven encrypts and uses server passwords, see https://maven.apache.org/guides/mini/guide-encryption.html

       

      Add to your pom.xml file

      Code Block
      <repositories>
          <repository>
              <id>eduserv</id>
              <url>https://repo.openathens.net/maven</url>
          </repository>
      </repositories>
      
      ...
      
      <dependency>
          <groupId>uk.org.eduserv.iam</groupId>
          <artifactId>openathens-sp</artifactId>
          <version>2.1.0</version>
          <type>pom</type>
      </dependency>

      The id must match your .m2/setting.xml file and be 'eduserv'

       

    3. If you have installed from a downloaded zip file instead, check that the files have been placed in the correct location.
       

    Create metadata keys
    1. instead, you will need to manually move jar files to the correct location.

  2. Create metadata keys. These are used for signing and encrypting SAML erxchanges and the public key will be published in metadata.
    Anchor
    keys
    keys


    1. Linux

    2. Windows

  3. If you have not already done so, create an application in the publisher dashboard. PLACEHOLDER LINK

  4. Logging - PLACEHOLDER - HERE OR MAINT?

    1. Linux

    2. Windows

  5. Configure your web.xml file. The publisher dashboard will have  generated a configuration to copy and paste. In the file you will also need to:

    1. Update the protected location to cover your application.

    2. Restart your web server to download the configuration from the publisher dashboard and start using it.

...