Skip to content

Commit

Permalink
Add docs for Guzzle version workaround
Browse files Browse the repository at this point in the history
  • Loading branch information
squigg committed Sep 19, 2020
1 parent 015c2c1 commit a3762a5
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Expand Up @@ -26,7 +26,22 @@ or [PowerShell](https://docs.microsoft.com/en-us/azure/storage/queues/storage-po
### Install using composer
You can find this library on [Packagist](https://packagist.org/packages/squigg/azure-queue-laravel).

#### Important notes for Laravel 8
Laravel 8 has moved to Guzzle 7.x, but the upstream dependency `microsoft/azure-storage-queue` from this package still uses Guzzle 6.
This will cause `composer` to fail during dependency resolution.

Tests so far have not identified any impacting breaking changes between Guzzle 6 and 7, so while we wait for the upstream package to be updated, you can work around this issue by adding/updating your root
`composer.json` file to use an inline alias for `guzzlehttp/guzzle`:
```
"guzzlehttp/guzzle": "7.0.1 as 6.5.5"
```
Or run this command:
```
composer require guzzlehttp/guzzle:"7.0.1 as 6.5.5"
```
#### Installation
Require this package in your `composer.json`. The version numbers will follow Laravel.

#### Laravel 8.x
"squigg/azure-queue-laravel": "^8.0"
composer require squigg/azure-queue-laravel:^8.0
Expand Down Expand Up @@ -99,7 +114,7 @@ fill out your own connection data from the Azure Management portal:
'endpoint' => env('AZURE_QUEUE_ENDPOINTSUFFIX'), // Optional endpoint suffix if different from core.windows.net
],

Add environment variables into your `.env` file to set the above configuration parameters if you prefer:
Add environment variables into your `.env` file to set the above configuration parameters:

AZURE_QUEUE_STORAGE_NAME=xxx
AZURE_QUEUE_KEY=xxx
Expand All @@ -111,6 +126,8 @@ Update the default queue used by Laravel by setting the `QUEUE_CONNECTION` value

QUEUE_CONNECTION=azure

This setting is `QUEUE_DRIVER` in older versions of Laravel.

## Usage
Use the normal Laravel Queue functionality as per the [documentation](http://laravel.com/docs/queues).

Expand Down

0 comments on commit a3762a5

Please sign in to comment.