Merge pull request #22 from openfoodfoundation/feature/sqs

Feature: Updated SQS config doco

.env.example

@@ -37,7 +37,7 @@ SANCTUM_STATEFUL_DOMAINS=vine.test
 
 BROADCAST_CONNECTION=log
 FILESYSTEM_DISK=local
-QUEUE_CONNECTION=database
+QUEUE_CONNECTION=sync
 
 CACHE_STORE=database
 CACHE_PREFIX=
@@ -63,7 +63,8 @@ AWS_SECRET_ACCESS_KEY=
 AWS_DEFAULT_REGION=us-east-1
 AWS_BUCKET=
 AWS_USE_PATH_STYLE_ENDPOINT=false
-
+SQS_PREFIX=
+SQS_QUEUE=
 
 
 VITE_APP_NAME="${APP_NAME}"

.env.testing

@@ -62,6 +62,8 @@ AWS_SECRET_ACCESS_KEY=
 AWS_DEFAULT_REGION=us-east-1
 AWS_BUCKET=
 AWS_USE_PATH_STYLE_ENDPOINT=false
+SQS_PREFIX=
+SQS_QUEUE=
 
 VITE_APP_NAME="${APP_NAME}"
 

README.md

@@ -152,15 +152,27 @@ The S3 bucket uses a configuration called `root`, which separates the base bucke
 
 NOTE: No extra config is required for this behaviour on AWS S3. It is not the default for any other filesystem storage providers.
 
+## Queue Configuration
+By default, the queue is set to `sync`: `QUEUE_CONNECTION=sync` which runs jobs as part of the current request. You are free to reconfigure this. 
+
+If using AWS SQS, you need to create queues for each environment, and update the env vars as follows:
+
+```dotenv
+QUEUE_CONNECTION=sqs
+SQS_QUEUE="queue-name-${APP_ENV}" # eg ofn-vine-uk-local as set in AWS SQS
+SQS_PREFIX=https://sqs.${AWS_DEFAULT_REGION}.amazonaws.com/[YOUR-AWS-ACCOUNT-ID]
+```
+You'll also need to run at least one properly configured queue worker on your server environment for this to work.
 
 ## API Middleware - Protecting The API
 
 In /bootstrap.app.php we've configured middleware as follows:
 
 ```php
-$middleware->alias([
-                  'abilities' => CheckForAnyTokenAbilities::class,
-              ]);
+$middleware->alias(
+    [
+        'abilities' => CheckForAnyTokenAbilities::class,
+    ]);
 ```
 
 This runs the API middleware through `CheckForAnyTokenAbilities`, checking the incoming personal access token for the