Download the PHP package simplesamlphp/composer-module-installer without Composer
On this page you can find all versions of the php package simplesamlphp/composer-module-installer. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download simplesamlphp/composer-module-installer
More information about simplesamlphp/composer-module-installer
Files in simplesamlphp/composer-module-installer
Package composer-module-installer
Short Description A Composer plugin that allows installing SimpleSAMLphp modules through Composer.
License LGPL-2.1-only
Informations about the package composer-module-installer
SimpleSAMLphp Composer module installer
This package is a Composer plugin that allows a SimpleSAMLphp module to be installed through Composer. Installation can be as easy as executing:
That command would install vendor/simplesamlphp-module-mymodule
matching
version 1.*
.
Making a module installable through Composer
To make a module installable through Composer, you need to add a
composer.json
-file to the root of the module. It should look
something like:
The package name must be on the form:
<vendor>
is the vendor name you use, and <module name>
is the name
of your module. Your module will be installed in the modules/<module name>
directory in the SimpleSAMLphp installation directory.
Assets modules
Asset modules are a special kidn of module that will install pre-built assets in
SimpleSAMLphp's public/
directory. These modules follow a slightly different
naming convention simplesamlphp-assets-<module name>
Installing your custom module
If you publish your module on Packagist, no special
configuration is required to install your module. However, if your module is
hosted in a private repository, you need to add a repository for the module to
your SimpleSAMLphp composer.json
file. For example, if your module is located
in a Git repository in /home/username/mymodule
, you would add something like
the following to repositories
in composer.json
:
The `repositories array may look something like:
Once you have added the repository, you should be able to install your module by executing:
(dev-master
instructs Composer to install the master
-branch from the Git
repository.)
See the Composer Repository documentation for more information about adding your own custom repositories to Composer.
Module names that contain uppercase letters
New modules should only have lowercase letters in the module name, however a
lot of existing module names contain uppercase letters. Since Composer package
names should only contain lowercase letters, a mixed-case variant of the module
name can be provided in the ssp-mixedcase-module-name
extra data option:
Note that this is only meant for migration of existing modules. New modules should only use lowercase letters in the name.