digitalidentity/shibwright repository overview

⁠Shibwright

⁠What is this?

Shibboleth Identity Provider⁠ is a mature, SAML-based single sign on (SSO) web application widely deployed in academic organisations. It's used by millions of staff and students around the world.

Shibwright is a lazy and inefficient alternative way to install or update a Shibboleth IdP configuration. It is maintained by Digital Identity Ltd.⁠. We're not sure how useful it actually is. Shibwright uses a Docker container to run the Shibboleth IdP installer on the local directory. Shibwright does not actually run the IdP software itself - you will need a Java web container such as Tomcat or Jetty, either installed locally or in a Docker container such as Ishigaki⁠

⁠Why use this?

• You are running the Shibboleth IdP in a Docker container and need to create or update configuration files
• Your configuration is managed in a git repository and edited locally
• You want to update configuration files on a computer without Java
• You need to update a series of IdP installations slightly quicker

⁠Any reasons not to use this?

• It's an entire operating system and Java JDK just to run an install script

⁠Configuring and running Shibwright

⁠Getting the image

Please check that Shibwright contains the latest version of the Shibboleth IdP before using it.

docker pull digitalidentity/shibwright

⁠Using Shibwright

The easiest way to use Shibwright is to create a shell alias

In bash:

alias shibwright="docker run -it -v $(pwd):/opt/shibboleth-idp --rm digitalidentity/shibwright:latest"

In fish:

alias shibwright="docker run -it -v (pwd):/opt/shibboleth-idp --rm digitalidentity/shibwright:latest"

After creating the alias you can run shibwright with shibwright.

The Shibwright alias will mount your current directory as the default install location /opt/shibboleth-idp - use the installer as if that's where you installing to, and the files will be created in your current directory.

You can run other commands by specifying them:

shibwright module.sh -e idp.intercept.Consent

Shibwright's $PATH will check in /opt/shibboleth-idp/bin first, and then /usr/local/src/idp_src/bin afterwards, so in an empty directory it will run commands from the installer source directory.

Adjust the files to suit your use-case - see the Shibboleth IdP documentation⁠ for lots more information.

⁠Related Projects from Digital Identity

• Ishigaki⁠ - a Docker image for running the Shibboleth IdP.

⁠Thanks

• We're just packaging huge amounts of work by The Shibboleth Consortium⁠ and the wider Shibboleth community. If your organisation depends on Shibboleth please consider supporting them.

⁠Contributing

You can request new features by creating an issue⁠, or submit a pull request⁠ with your contribution.

If you have a support contract with Mimoto, please contact Mimoto⁠ for assistance, rather than use Github.

⁠License

Copyright (c) 2021 Digital Identity Ltd, UK

Licensed under the MIT License