Download the PHP package simplesamlphp/simplesamlphp-module-aggregator2 without Composer

On this page you can find all versions of the php package simplesamlphp/simplesamlphp-module-aggregator2. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package simplesamlphp-module-aggregator2

Aggregator 2

Build Status Coverage Status Type coverage Scrutinizer Code Quality

This is a SimpleSAMLphp module for metadata aggregation. It is designed to preserve most of the common metadata items, and it also attempts to preserve unknown elements. Metadata sources are parsed and rebuilt, so small differences between the original sources and the metadata generated may occur. More specifically:

Note: This aggregator works only with XML metadata, and does its work independently of other parts of SimpleSAMLphp, such as the metarefresh module.

Installation

Once you have installed SimpleSAMLphp, installing this module is very simple. Just execute the following command in the root of your SimpleSAMLphp installation:

where dev-master instructs Composer to install the master branch from the Git repository. See the releases available if you want to use a stable version of the module.

To use this module, enable the aggregator2 module: in config.php, search for the module.enable key and set aggregator2 to true:

Configuration

This module is configured through the config/module_aggregator2.php configuration file. An example file is available in modules/aggregator2/config-templates/:

The configuration file contains one or more aggregators in the configuration array. The index for each item in the configuration array gives the identifier of the aggregator.

Aggregator entry configuration

The aggregator can be configured with the following options:

Aggregator source configuration

Retrieving aggregated metadata

You will find a link to the aggregator2 module in the Federation tab of SimpleSAMLphp's web interface. There you will be able to see a list of all the metadata aggregates you have configured, and see or download them in different formats.

In general, metadata aggregates can be downloaded from the following location:

http://<YOUR HOST>/simplesaml/modules.php/aggregator2/get?id=<aggregator-id>

where the aggregator id is the identifier you used as an index for the aggregator configuration array. Additionally, you can use the following parameters to customize the resulting metadata aggregate:

Asynchronous metadata updates

By default, the aggregator2 module will update the metadata upon receiving a request. For performance reasons, it is recommended to run the updates asynchronously. By doing this, the aggregated metadata will be generated in the background.

To enable this, you must configure a cache directory with the cache.directory option. This directory must be writable by the web server. You can then enable caching of generated metadata by setting the cache.generated option to the number of seconds the metadata should be cached.

You will now have a configuration that caches both downloaded and generated metadata. However, it will still update the metadata when the user accesses the aggregator endpoint. To update the generated metadata in the background, you must add a cron.tag option. This option must reference a cron tag entry configured in module_cron.php. Once this is done, your aggregated metadata will be updated every time that cron entry is executed.


All versions of simplesamlphp-module-aggregator2 with dependencies

PHP Build Version
Package Version
Requires php Version >=7.4 || ^8.0
simplesamlphp/composer-module-installer Version ^1.3.2
simplesamlphp/simplesamlphp Version ^2.0.0-rc2
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package simplesamlphp/simplesamlphp-module-aggregator2 contains the following files

Loading the files please wait ....