venatorfox/simplesamlphp repository overview

Supported tags and respective Dockerfile links

• 1.18.3, latest (1.18.3/Dockerfile)⁠
• 1.18.2 (1.18.2/Dockerfile)⁠
• 1.18.1 (1.18.1/Dockerfile)⁠
• 1.18.0 (1.18.0/Dockerfile)⁠
• 1.17.8 (1.17.8/Dockerfile)⁠
• 1.17.7 (1.17.7/Dockerfile)⁠
• 1.17.6 (1.17.6/Dockerfile)⁠
• 1.17.5 (1.17.5/Dockerfile)⁠
• 1.17.4 (1.17.4/Dockerfile)⁠
• 1.17.3 (1.17.3/Dockerfile)⁠
• 1.17.2 (1.17.2/Dockerfile)⁠
• 1.17.1 (1.17.1/Dockerfile)⁠
• 1.15.0 (1.15.0/Dockerfile)⁠
• 1.14.17 (1.14.17/Dockerfile)⁠
• 1.14.16 (1.14.16/Dockerfile)⁠
• 1.14.15 (1.14.15/Dockerfile)⁠

⁠How to use this image

The following 1 liner will get you up and running with a default configuration.

Start a venatorfox/simplesamlphp instance, expose port 80.

$ docker run --name some-simplesamlphp -p80:80 venatorfox/simplesamlphp:latest

Visit the site at http://localhost⁠, default unconfigured username is "admin" and password is "123".

Of course, running with the default configuration and no volumes is not what is desired.
The next sections below will show available runtime environment variables for a more specific configuration.

⁠More Complex Examples

Some more complex (ie. with SSL termination, memcache, null client, etc...) setup examples are located in the README.md within the examples directory⁠.

⁠Supported Volume Mount Options for Pre-Seeding

The following directories will pre-seed if they are mounted.
Subdirectores will not seed, so data must already exist if volume mounting a subdirectory.

If the directory is not mounted, it will use its ephemeral counterpart in the container which is ideal, explained below. Note that once a directory is mounted, it will need to be upgraded manually for future SimpleSAMLphp releases if applicable. If a mounted directory disappears from the host, it will pre-seed again with defaults from the SimpleSAMLphp install on restart. If reverting to a default directory is desired, remove the host directory and adjust the docker run command to exclude the mount.

Some directories will probably never need manually updated as SimpleSAMLphp will not update them in new versions. /cert and /metadata are examples of directories that should always be volume mounted, as it contains data that must persist, is very organization specific, and will probably never or rarely be changed by SimpleSAMLphp releases.

Something like /bin should never be volume mounted unless it's for development purposes, as it will likley be upgraded by SimpleSAMLphp in new versions.

Be sure to check new SimpleSAMLphp releases to see if manual upgrades need done to a directory that was mounted. Check SimpleSAMLphp docs⁠ installation section 5 for specifics.

Individual files can also be mounted, but will not pre-seed content. It must pre-exist before starting the container. Mounting the authsources.php file is a good example, as /config will probably not be mounted. Another example, if using composer, the composer.json and composer.lock files will need mounted.

This will vary greatly depending on use. A compose file similar to a production instance as is at the end of this README.

⁠Runtime Environment Variables

The following variables can be overridden at run or in docker-compose. It is recommended to set them properly and not use default values. (Unless you want an authentication service with no SSL, with your admin password being 123 (Can you not, kthx)).

Default CONFIG_MEMCACHESTORESERVERS format, 2 pair of 2 example. Use this template and replace the hostnames. Check compose file for usage example:

    'memcache_store.servers' => array(\n        array(\n             array('hostname' => 'mc_a1'),\n             array('hostname' => 'mc_a2'),\n        ),\n        array(\n             array('hostname' => 'mc_b1'),\n             array('hostname' => 'mc_b2'),\n        ),

⁠Maintenance

This is being actively maintained and is running in production for several organizations. Please create an issue⁠ if needed or if additional variables/features are desired.