S3 cloud storage integration in Laravel - Mini Project: Build & Apply

S3 Cloud Storage Integration with Laravel

📖 Scenario: You are building a Laravel application that needs to store user-uploaded files securely in the cloud. Amazon S3 is a popular choice for cloud storage. This project will guide you step-by-step to set up S3 storage integration in Laravel.

🎯 Goal: By the end, you will have configured Laravel to connect to Amazon S3 and written code to upload a file to the S3 bucket.

📋 What You'll Learn

Create the S3 disk configuration in Laravel's filesystems config

Add AWS credentials as environment variables

Write code to upload a file to the S3 disk

Use Laravel's Storage facade to complete the upload

💡 Why This Matters

🌍 Real World

Many web applications store user files like images, documents, or backups in cloud storage for reliability and scalability. Amazon S3 is a common choice.

💼 Career

Knowing how to integrate cloud storage like S3 with Laravel is a valuable skill for backend developers working on scalable web applications.

1

Set up AWS credentials in the .env file

Add these exact lines to your .env file to set AWS credentials and bucket name:
AWS_ACCESS_KEY_ID=your-access-key-id
AWS_SECRET_ACCESS_KEY=your-secret-access-key
AWS_DEFAULT_REGION=us-east-1
AWS_BUCKET=your-bucket-name

Laravel

# Add the AWS credentials and bucket name to your .env file
# Your code here

Hint

Open the .env file in your Laravel project root and add the lines exactly as shown.

2

Configure the S3 disk in config/filesystems.php

In config/filesystems.php, add the S3 disk configuration inside the 'disks' array exactly as:
's3' => [
'driver' => 's3',
'key' => env('AWS_ACCESS_KEY_ID'),
'secret' => env('AWS_SECRET_ACCESS_KEY'),
'region' => env('AWS_DEFAULT_REGION'),
'bucket' => env('AWS_BUCKET'),
],

Laravel

AWS_ACCESS_KEY_ID=your-access-key-id
AWS_SECRET_ACCESS_KEY=your-secret-access-key
AWS_DEFAULT_REGION=us-east-1
AWS_BUCKET=your-bucket-name

// Add the S3 disk configuration inside the 'disks' array in config/filesystems.php
# Your code here

Hint

Open config/filesystems.php and find the 'disks' array. Add the S3 disk config exactly as shown.

3

Write code to upload a file to S3 using Laravel's Storage facade

In your controller or route, write code to upload a file called example.txt with content 'Hello S3!' to the S3 disk using Laravel's Storage facade:
use Illuminate\Support\Facades\Storage;
Storage::disk('s3')->put('example.txt', 'Hello S3!');

Laravel

AWS_ACCESS_KEY_ID=your-access-key-id
AWS_SECRET_ACCESS_KEY=your-secret-access-key
AWS_DEFAULT_REGION=us-east-1
AWS_BUCKET=your-bucket-name

// In config/filesystems.php inside 'disks' array
's3' => [
    'driver' => 's3',
    'key' => env('AWS_ACCESS_KEY_ID'),
    'secret' => env('AWS_SECRET_ACCESS_KEY'),
    'region' => env('AWS_DEFAULT_REGION'),
    'bucket' => env('AWS_BUCKET'),
],

// Add code to upload a file to S3
# Your code here

Hint

Use Laravel's Storage facade and call disk('s3')->put() with the file name and content.

4

Complete by setting the default filesystem disk to S3

In config/filesystems.php, set the 'default' key to 's3' so Laravel uses S3 by default:
'default' => 's3',

Laravel

AWS_ACCESS_KEY_ID=your-access-key-id
AWS_SECRET_ACCESS_KEY=your-secret-access-key
AWS_DEFAULT_REGION=us-east-1
AWS_BUCKET=your-bucket-name

// In config/filesystems.php inside 'disks' array
's3' => [
    'driver' => 's3',
    'key' => env('AWS_ACCESS_KEY_ID'),
    'secret' => env('AWS_SECRET_ACCESS_KEY'),
    'region' => env('AWS_DEFAULT_REGION'),
    'bucket' => env('AWS_BUCKET'),
],

use Illuminate\Support\Facades\Storage;

Storage::disk('s3')->put('example.txt', 'Hello S3!');

// Set the default filesystem disk to s3
# Your code here

Hint

Find the 'default' key in config/filesystems.php and change its value to 's3'.

Practice

1. What is the main purpose of integrating S3 cloud storage in a Laravel application?

easy

A. To speed up database queries

B. To store files safely online and access them via Laravel

C. To replace Laravel's routing system

D. To manage user authentication

Solution

1. Step 1: Understand S3 integration role

   S3 cloud storage is used to store files remotely and securely in the cloud.

2. Step 2: Connect with Laravel usage

   Laravel uses Storage::disk('s3') to interact with these files, enabling safe online storage.

3. Final Answer:

   To store files safely online and access them via Laravel -> Option B

4. Quick Check:

   S3 integration = safe online file storage [OK]

Hint: Remember S3 is for file storage, not database or routing [OK]

Common Mistakes:

• Confusing S3 with database optimization
• Thinking S3 replaces routing or authentication
• Assuming S3 is for local file storage only

2. Which of the following is the correct Laravel syntax to store a file named 'photo.jpg' on the S3 disk?

easy

A. Storage::put('s3', 'photo.jpg', $fileContent);

B. Storage::disk('photo.jpg')->put('s3', $fileContent);

C. Storage::s3()->store('photo.jpg', $fileContent);

D. Storage::disk('s3')->put('photo.jpg', $fileContent);

Solution

1. Step 1: Identify correct method chaining

   Laravel uses Storage::disk('s3') to select the S3 disk, then put() to save files.

2. Step 2: Match parameters order

   The put() method takes the filename first, then the file content.

3. Final Answer:

   Storage::disk('s3')->put('photo.jpg', $fileContent); -> Option D

4. Quick Check:

   Correct syntax = Storage::disk('s3')->put(filename, content) [OK]

Hint: Use disk('s3') before put() to target S3 storage [OK]

Common Mistakes:

• Swapping parameters in put() method
• Using Storage::put() without disk() for S3
• Calling non-existent methods like s3()

3. Given this Laravel code snippet:

Storage::disk('s3')->put('docs/report.txt', 'Annual Report');
$exists = Storage::disk('s3')->exists('docs/report.txt');
return $exists ? 'File found' : 'File missing';

What will be the output?

medium

A. File found

B. Syntax error

C. File missing

D. Runtime exception

Solution

1. Step 1: Store file on S3 disk

   The put() method saves 'docs/report.txt' with content 'Annual Report'.

2. Step 2: Check file existence

   The exists() method checks if the file is present, which returns true after put().

3. Final Answer:

   File found -> Option A

4. Quick Check:

   File saved and exists = 'File found' [OK]

Hint: put() then exists() returns true if file saved successfully [OK]

Common Mistakes:

• Assuming file doesn't exist immediately after put()
• Confusing method names like exist() instead of exists()
• Expecting syntax or runtime errors without cause

4. You wrote this code to delete a file from S3:

Storage::disk('s3')->delete('images/photo.png');

But the file is not deleted. What is the most likely cause?

medium

A. You must call Storage::delete() without disk() for S3

B. The delete() method requires a second parameter

C. AWS credentials or bucket name not set correctly in .env

D. Laravel does not support deleting files on S3

Solution

1. Step 1: Check AWS configuration

   Deleting files on S3 requires correct AWS keys and bucket info in environment settings.

2. Step 2: Verify method usage

   The delete() method needs only the filename; no second parameter is required.

3. Final Answer:

   AWS credentials or bucket name not set correctly in .env -> Option C

4. Quick Check:

   Missing AWS config = delete fails [OK]

Hint: Always verify AWS keys and bucket in .env before file ops [OK]

Common Mistakes:

• Adding extra parameters to delete() method
• Calling delete() without disk('s3') for S3 files
• Believing Laravel can't delete S3 files

5. You want to upload multiple files to S3 and then list all files in the 'uploads/' folder. Which Laravel code snippet correctly does this?

hard

A. foreach ($files as $file) { Storage::disk('s3')->put('uploads/'.$file->getClientOriginalName(), file_get_contents($file)); } $list = Storage::disk('s3')->files('uploads');

B. Storage::disk('s3')->putFiles('uploads', $files); $list = Storage::disk('s3')->allFiles('uploads');

C. foreach ($files as $file) { Storage::put('s3/uploads/'.$file, $file); } $list = Storage::disk('s3')->list('uploads');

D. Storage::disk('uploads')->put($files); $list = Storage::disk('s3')->files();

Solution

1. Step 1: Upload multiple files correctly

   Loop over each file, use Storage::disk('s3')->put() with correct path and file content.

2. Step 2: List files in 'uploads/' folder

   Use Storage::disk('s3')->files('uploads') to get all files in that folder.

3. Final Answer:

   foreach ($files as $file) { Storage::disk('s3')->put('uploads/'.$file->getClientOriginalName(), file_get_contents($file)); } $list = Storage::disk('s3')->files('uploads'); -> Option A

4. Quick Check:

   Loop put + files() list = correct multi-file S3 upload [OK]

Hint: Use loop with put() and files() to upload and list files [OK]

Common Mistakes:

• Using non-existent putFiles() method
• Wrong disk name or method for listing files
• Passing files array directly without looping