https://github.com/naderman/composer-aws

AWS Plugin for Composer
https://github.com/naderman/composer-aws

Last synced: 8 days ago
JSON representation

AWS Plugin for Composer

• Host: GitHub
• URL: https://github.com/naderman/composer-aws
• Owner: naderman
• License: mit
• Created: 2013-08-14T10:11:18.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2020-10-25T21:13:20.000Z (about 4 years ago)
• Last Synced: 2024-10-23T12:13:36.328Z (16 days ago)
• Language: PHP
• Size: 60.5 KB
• Stars: 77
• Watchers: 8
• Forks: 25
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-composer - Composer-AWS - The plugin loads repository data and downloads packages from Amazon S3 (with authentication support for private repositories). (Plugins / Support)

README

        
# composer-aws (ABANDONED)

A composer plugin to load repository data and download packages from Amazon S3 with authentication support for private repositories.

-----

## Using AWS S3 to host private packages? Check out [Private Packagist](https://packagist.com) for a better private Composer repository solution!

This project has been abandoned and will not support Composer 2.0. If you are currently relying on this plugin to download packages from S3, you should consider using [Private Packagist](https://packagist.com) to manage your private packages.

-----

## Installation

### Global scope (per user) installation

```shell

$ composer global require "naderman/composer-aws:^1.0"

```

### Project scope installation

```shell

$ composer require "naderman/composer-aws:^1.0"

```

## Configuration

There are three options available in order to configure and use this plugin:

 1. For AWS EC2: Create an IAM profile for your instances to access the bucket - then no other configuration is necessary.

 2. Set the environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`

 3. Add the following to your `config.json` (in `$COMPOSER_HOME`):

```json

{

    "config": {

        "amazon-aws": {

            "credentials": {

                "key": "your aws access key",

                "secret": "your aws secret"

            }

        }

    }

}

```

## Usage

Once the plugin is installed and configured, you can transparently use `packages.json` files which contain `s3://` schemes for dist urls.

## Loading package repositories from AWS S3

If you want to host a packages.json repository on S3 (e.g. generated by satis), you can use an S3 bucket for the repository url as well.

```json

{

    "repositories": [

        {

            "type": "composer",

            "url": "s3://my-S3-bucket/my/packages/repository/path/"

        }

    ]

}

```

## Further reading

 * AWS IAM Instance profiles: http://docs.aws.amazon.com/IAM/latest/UserGuide/instance-profiles.html

 * Amazon S3 Syncer: https://github.com/easybiblabs/s3-syncer