https://github.com/simplesamlphp/composer-module-installer
A Composer plugin that allows installing SimpleSAMLphp modules through Composer.
https://github.com/simplesamlphp/composer-module-installer
Last synced: 10 months ago
JSON representation
A Composer plugin that allows installing SimpleSAMLphp modules through Composer.
- Host: GitHub
- URL: https://github.com/simplesamlphp/composer-module-installer
- Owner: simplesamlphp
- License: lgpl-2.1
- Created: 2014-02-24T11:36:05.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2025-03-19T20:41:10.000Z (10 months ago)
- Last Synced: 2025-04-02T03:30:14.235Z (10 months ago)
- Language: PHP
- Size: 68.4 KB
- Stars: 13
- Watchers: 7
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
# SimpleSAMLphp Composer module installer
[](https://codecov.io/gh/simplesamlphp/composer-module-installer)
[](https://scrutinizer-ci.com/g/simplesamlphp/composer-module-installer/?branch=master)
[](https://shepherd.dev/github/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:
```bash
composer.phar require vendor/simplesamlphp-module-mymodule 1.*
```
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:
```json
{
"name": "vendor/simplesamlphp-module-mymodule",
"description": "A description of the module 'mymodule'.",
"type": "simplesamlphp-module",
"require": {
"simplesamlphp/composer-module-installer": "~1.4"
}
}
```
The package name must be on the form:
```bash
/simplesamlphp-module-
```
`` is the vendor name you use, and `` is the name
of your module. Your module will be installed in the `modules/`
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-`
## Installing your custom module
If you publish your module on [Packagist](https://packagist.org/), 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`:
```json
{
"type": "vcs",
"url": "/home/username/mymodule"
}
```
The `repositories array may look something like:
```json
"repositories": [
{
"type": "package",
"package": {
"name": "robrichards/xmlseclibs",
"version": "1.3.1",
"source": {
"type": "svn",
"url": "http://xmlseclibs.googlecode.com/svn",
"reference": "trunk@50"
},
"autoload": {
"files": ["xmlseclibs.php"]
}
}
},
{
"type": "vcs",
"url": "/home/username/mymodule"
}
]
```
Once you have added the repository, you should be able to install your module
by executing:
```bash
composer.phar require vendor/simplesamlphp-module-mymodule:dev-master
```
(`dev-master` instructs Composer to install the `master`-branch from the Git
repository.)
See the [Composer Repository documentation](https://getcomposer.org/doc/05-repositories.md)
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:
```json
{
"name": "vendor/simplesamlphp-module-mymodule",
"description": "A description of the module 'MyModule'.",
"type": "simplesamlphp-module",
"extra": {
"ssp-mixedcase-module-name": "myModule"
},
"require": {
"simplesamlphp/composer-module-installer": "~1.4"
}
}
```
Note that this is only meant for migration of existing modules. New modules
should only use lowercase letters in the name.