Merge pull request #21 from openfoodfoundation/feature/setup-s3

Feature: Cloud storage system set up and working well

.env.example

@@ -4,6 +4,7 @@ APP_KEY=
 APP_DEBUG=true
 APP_TIMEZONE=UTC
 APP_URL=http://vine.test
+APP_PRODUCTION_URL=http://vine.test
 
 APP_LOCALE=en
 APP_FALLBACK_LOCALE=en
@@ -63,6 +64,8 @@ AWS_DEFAULT_REGION=us-east-1
 AWS_BUCKET=
 AWS_USE_PATH_STYLE_ENDPOINT=false
 
+
+
 VITE_APP_NAME="${APP_NAME}"
 
 FLARE_KEY=

README.md

@@ -127,6 +127,32 @@ LOG_STACK=sentry  # or sentry,single etc for multiple
 
 Todo - explain how pint works, and under what circumstances it'll run
 
+## File Storage: Local vs. AWS S3
+You are free to use whichever storage cloud you like - the default environment variable of `FILESYSTEM_DISK=local` means that the application will use the local server.
+
+To configure the system to use AWS S3, first create a bucket in S3 and some access keys for your implementation. then update the following environment variables:
+
+```dotenv
+FILESYSTEM_DISK=s3
+
+AWS_ACCESS_KEY_ID=[YourApplicationKey]
+AWS_SECRET_ACCESS_KEY=[YourApplicationSecret]
+AWS_DEFAULT_REGION=[S3 Bucket location eg ap-southeast-2]
+AWS_BUCKET=[S3 Bucket Name]
+AWS_USE_PATH_STYLE_ENDPOINT=false
+```
+The S3 bucket uses a configuration called `root`, which separates the base bucket into the environment that the application is running under. This is based on `APP_ENV`. If you are running `APP_ENV=local` and your bucket was called `AWS_BUCKET=ofn-vine-uk`, your bucket folder structure would look like this:
+
+```
+/ofn-vine-uk
+    /local 👈 // Objects would be placed here by default at the path you provide
+    /staging
+    /production
+```
+
+NOTE: No extra config is required for this behaviour on AWS S3. It is not the default for any other filesystem storage providers.
+
+
 ## API Middleware - Protecting The API
 
 In /bootstrap.app.php we've configured middleware as follows:

app/Console/Commands/TestCommand.php

@@ -2,10 +2,6 @@
 
 namespace App\Console\Commands;
 
-use App\Models\Team;
-use App\Models\User;
-use App\Models\Voucher;
-use App\Models\VoucherSet;
 use Illuminate\Console\Command;
 
 class TestCommand extends Command
@@ -27,11 +23,5 @@ class TestCommand extends Command
     /**
      * Execute the console command.
      */
-    public function handle()
-    {
-        $users       = User::factory(100)->createQuietly();
-        $teams       = Team::factory(100)->createQuietly();
-        $vouchers    = Voucher::factory(100)->createQuietly();
-        $voucherSets = VoucherSet::factory(100)->createQuietly();
-    }
+    public function handle() {}
 }

composer.json

@@ -10,6 +10,7 @@
         "laravel/framework": "^11.9",
         "laravel/sanctum": "^4.0",
         "laravel/tinker": "^2.9",
+        "league/flysystem-aws-s3-v3": "^3.28",
         "sentry/sentry-laravel": "^4.7",
         "spatie/laravel-flare": "^1.0",
         "tightenco/ziggy": "^2.0"

config/filesystems.php

@@ -54,8 +54,8 @@
             'endpoint'                => env('AWS_ENDPOINT'),
             'use_path_style_endpoint' => env('AWS_USE_PATH_STYLE_ENDPOINT', false),
             'throw'                   => false,
+            'root'                    => env('APP_ENV'),
         ],
-
     ],
 
     /*

config/scribe.php

@@ -12,7 +12,7 @@
 
     // The base URL displayed in the docs. If this is empty, Scribe will use the value of config('app.url') at generation time.
     // If you're using `laravel` type, you can set this to a dynamic string, like '{{ config("app.tenant_url") }}' to get a dynamic base URL.
-    'base_url' => env('APP_URL'),
+    'base_url' => env('APP_PRODUCTION_URL'),
 
     'routes' => [
         [