Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/isaaceindhoven/composer-velocita

Velocita - Fast, reliable and shared Composer caching
https://github.com/isaaceindhoven/composer-velocita

cache composer composer-plugin packagist reverse-proxy

Last synced: about 2 months ago
JSON representation

Velocita - Fast, reliable and shared Composer caching

Lists

README

        

# Velocita Composer plugin

[![Packagist Version](https://img.shields.io/packagist/v/isaac/composer-velocita)](https://packagist.org/packages/isaac/composer-velocita)
[![Packagist Downloads](https://img.shields.io/packagist/dt/isaac/composer-velocita)](https://packagist.org/packages/isaac/composer-velocita)
![Packagist PHP Version Support](https://img.shields.io/packagist/php-v/isaac/composer-velocita)
[![License](https://img.shields.io/github/license/isaaceindhoven/composer-velocita)](https://github.com/isaaceindhoven/composer-velocita/blob/master/LICENSE)

Fast and reliable Composer package downloads using Velocita: a caching reverse proxy that does not require you to
modify your projects.

## Getting Started

### Prerequisites

* PHP 7.4 or newer
* A running [Velocita](https://github.com/isaaceindhoven/velocita) instance
* Composer 2

### Installation

Installation and configuration of the Velocita plugin is global, so you can use it for all projects that use Composer
without having to add it to your project's `composer.json`.

```
composer global config allow-plugins.isaac/composer-velocita true
composer global require isaac/composer-velocita
composer velocita:enable https://url.to.your.velocita.tld/
```

### Usage

After enabling and configuring Velocita, it is automatically used for all Composer projects when running `require`,
`update`, `install`, etcetera.

### Removal

Disable the plugin by executing:

```
composer velocita:disable
```

If you want to remove the plugin completely, execute:

```
composer global remove isaac/composer-velocita
```

## Authors

* Jelle Raaijmakers - [[email protected]](mailto:[email protected]) / [GMTA](https://github.com/GMTA)

## Contributing

Raise an issue or submit a pull request on [GitHub](https://github.com/isaaceindhoven/composer-velocita).

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.