Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
squigg committed May 6, 2017
1 parent 04ac494 commit 1605cff
Showing 1 changed file with 18 additions and 9 deletions.
27 changes: 18 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ PHP Laravel 5 Queue Driver package to support Microsoft Azure Storage Queues
## Prerequisites

- PHP 5.5+ (5.6 required for v5.3+)
- Laravel 5.2 or 5.3 (not tested on previous versions)
- Laravel 5.2, 5.3 and 5.4 (not tested on previous versions)
- Microsoft Azure Storage account and API key
- Queue container created through Azure Portal
- Queue container created through Azure Portal or via Azure CLI / PowerShell

## Installation

Expand All @@ -24,10 +24,16 @@ You can find this library on [Packagist](https://packagist.org/packages/squigg/a
Require this package in your `composer.json`. The version numbers will follow Laravel.
#### Laravel 5.2.x
"squigg/azure-queue-laravel": "5.2.*"
composer require squigg/azure-queue-laravel:5.2.*
#### Laravel 5.3.x
"squigg/azure-queue-laravel": "5.3.*"

Add the following pear repository in your `composer.json` file required for the Microsoft Azure SDK:
composer require squigg/azure-queue-laravel:5.3.*
#### Laravel 5.4.x
"squigg/azure-queue-laravel": "5.4.*"
composer require squigg/azure-queue-laravel:5.4.*

Add the following pear repository in your `composer.json` file required for the Microsoft Azure SDK
(not required for 5.4.x which uses the new `microsoft/windowsazure` package):

"repositories": [
{
Expand All @@ -47,22 +53,25 @@ Add the ServiceProvider to your `providers` array in `app/config/app.php`:

'Squigg\AzureQueueLaravel\AzureQueueServiceProvider',

add the following to the `connection` array in `app/config/queue.php`, set your `default` connection to `azure` and fill out your own connection data from the Azure Management portal:
add the following to the `connection` array in `app/config/queue.php`, set your `default` connection to `azure` and
fill out your own connection data from the Azure Management portal:

'azure' => array(
'driver' => 'azure', // Leave this
'protocol' => 'https' // https or http
'azure' => [
'driver' => 'azure', // Leave this as-is
'protocol' => 'https', // https or http
'accountname' => '', // Azure storage account name
'key' => '', // Access key for storage account
'queue' => '', // Queue container name
'timeout' => 60 // Timeout (seconds) before a job is released back to the queue
)
],

You can add environment variables into your `.env` file to set the above configuration parameters if you desire:

AZURE_QUEUE_STORAGE_NAME=xxx
AZURE_QUEUE_KEY=xxx
AZURE_QUEUE_NAME=xxx

And then update the config file like below:

'accountname' => env('AZURE_QUEUE_STORAGE_NAME'),
'key' => env('AZURE_QUEUE_KEY'),
Expand Down

0 comments on commit 1605cff

Please sign in to comment.