Filesystem configuration in Laravel

Introduction

Filesystem configuration helps your Laravel app save and get files easily. It tells Laravel where and how to store files.

When you want to save user-uploaded images or documents.

When you need to store logs or reports on your server or cloud.

When your app needs to read files from different places like local disk or cloud storage.

When you want to switch storage locations without changing your app code.

When you want to organize files in folders or disks for better management.

Syntax

Laravel

return [
    'default' => env('FILESYSTEM_DISK', 'local'),

    'disks' => [
        'local' => [
            'driver' => 'local',
            'root' => storage_path('app'),
        ],

        'public' => [
            'driver' => 'local',
            'root' => storage_path('app/public'),
            'url' => env('APP_URL').'/storage',
            'visibility' => 'public',
        ],

        's3' => [
            'driver' => 's3',
            'key' => env('AWS_ACCESS_KEY_ID'),
            'secret' => env('AWS_SECRET_ACCESS_KEY'),
            'region' => env('AWS_DEFAULT_REGION'),
            'bucket' => env('AWS_BUCKET'),
            'url' => env('AWS_URL'),
        ],
    ],

    'links' => [
        public_path('storage') => storage_path('app/public'),
    ],
];

The default key sets which disk Laravel uses if you don't specify one.

Each disk has a driver like 'local' or 's3' to tell Laravel how to handle files.

Examples

This sets the default storage disk to local, which saves files on your server.

Laravel

'default' => 'local',

This configures a public disk where files are accessible via URL.

Laravel

'disks' => [
    'public' => [
        'driver' => 'local',
        'root' => storage_path('app/public'),
        'visibility' => 'public',
    ],
],

This sets up an Amazon S3 disk to store files in the cloud.

Laravel

'disks' => [
    's3' => [
        'driver' => 's3',
        'key' => env('AWS_ACCESS_KEY_ID'),
        'secret' => env('AWS_SECRET_ACCESS_KEY'),
        'region' => env('AWS_DEFAULT_REGION'),
        'bucket' => env('AWS_BUCKET'),
    ],
],

Sample Program

This controller saves an uploaded photo to the 'public' disk inside a 'photos' folder. It also shows how to get the URL of a saved file.

Laravel

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use Illuminate\Support\Facades\Storage;

class FileController extends Controller
{
    public function upload(Request $request)
    {
        $path = $request->file('photo')->store('photos', 'public');
        return "File saved at: " . $path;
    }

    public function showFile()
    {
        if (Storage::disk('public')->exists('photos/example.jpg')) {
            return Storage::disk('public')->url('photos/example.jpg');
        }
        return 'File not found';
    }
}

Important Notes

Remember to run php artisan storage:link to create a symbolic link for public files.

Use environment variables to keep sensitive info like AWS keys safe.

You can add more disks for different storage needs, like FTP or SFTP.

Summary

Filesystem config tells Laravel where and how to save files.

You can use local storage or cloud services like Amazon S3.

Setting the default disk makes file handling easier in your app.

Practice

1. What is the purpose of the default key in Laravel's config/filesystems.php file?

easy

A. It sets the default storage disk Laravel uses for file operations.

B. It defines the maximum file size allowed for uploads.

C. It specifies the encryption method for stored files.

D. It lists all available storage disks in the application.

Solution

1. Step 1: Understand the role of the default key

   The default key in config/filesystems.php tells Laravel which disk to use when no specific disk is mentioned.

2. Step 2: Compare with other options

   Options A, B, and C describe unrelated settings. Only "It sets the default storage disk Laravel uses for file operations." correctly describes the default disk setting.

3. Final Answer:

   It sets the default storage disk Laravel uses for file operations. -> Option A

4. Quick Check:

   Default disk = storage location [OK]

Hint: Default disk means where files go if no disk specified [OK]

Common Mistakes:

• Confusing default disk with file size limits
• Thinking default sets encryption
• Assuming default lists all disks

2. Which of the following is the correct syntax to define a local disk in config/filesystems.php?

easy

A. 'local' => ['driver' => 'ftp', 'root' => storage_path('app')],

B. 'local' => ['driver' => 'local', 'root' => storage_path('app')],

C. 'local' => ['driver' => 's3', 'root' => storage_path('app')],

D. 'local' => ['driver' => 'local', 'root' => public_path('app')],

Solution

1. Step 1: Identify the correct driver for local disk

   The local disk uses the 'local' driver, so options with 'ftp' or 's3' are incorrect.

2. Step 2: Check the root path for local storage

   The root path for local disk is usually storage_path('app'), not public_path('app').

3. Final Answer:

   'local' => ['driver' => 'local', 'root' => storage_path('app')], -> Option B

4. Quick Check:

   Local driver + storage_path = correct syntax [OK]

Hint: Local disk uses 'local' driver and storage_path root [OK]

Common Mistakes:

• Using wrong driver like 'ftp' or 's3' for local disk
• Setting root to public_path instead of storage_path
• Mixing driver and root paths

3. Given this config/filesystems.php snippet:

'disks' => [
    's3' => [
        'driver' => 's3',
        'key' => env('AWS_ACCESS_KEY_ID'),
        'secret' => env('AWS_SECRET_ACCESS_KEY'),
        'region' => env('AWS_DEFAULT_REGION'),
        'bucket' => env('AWS_BUCKET'),
    ],
],
'default' => 's3',

What happens when you call Storage::put('file.txt', 'Hello') in your app?

medium

A. An error occurs because the local disk is not set.

B. The file is saved to the local storage folder.

C. The file is saved to the configured Amazon S3 bucket.

D. The file is saved to a temporary directory.

Solution

1. Step 1: Identify the default disk

   The default disk is set to 's3', so all Storage calls use the S3 disk unless specified otherwise.

2. Step 2: Understand Storage::put behavior

   Calling Storage::put saves the file to the default disk, which is the S3 bucket configured.

3. Final Answer:

   The file is saved to the configured Amazon S3 bucket. -> Option C

4. Quick Check:

   Default disk 's3' means files go to S3 [OK]

Hint: Default disk controls Storage::put location [OK]

Common Mistakes:

• Assuming file saves locally despite default 's3'
• Thinking missing local disk causes error
• Confusing temporary directory with storage

4. You added a new disk in config/filesystems.php but get an error when using it. Which of these is the most likely cause?

medium

A. You forgot to run php artisan config:cache after changing the config.

B. You used the wrong PHP version for Laravel.

C. You did not install the Laravel UI package.

D. You set the disk name to 'default' instead of a unique name.

Solution

1. Step 1: Understand Laravel config caching

   Laravel caches config files for performance. Changes in config files require clearing or caching again.

2. Step 2: Identify the common fix

   Running php artisan config:cache refreshes the cached config and applies new disk settings.

3. Final Answer:

   You forgot to run php artisan config:cache after changing the config. -> Option A

4. Quick Check:

   Config cache must refresh after edits [OK]

Hint: Run config:cache after config changes [OK]

Common Mistakes:

• Ignoring config cache after edits
• Blaming PHP version for config errors
• Confusing unrelated packages with filesystem config

5. You want to configure a new disk in config/filesystems.php that stores files on a remote FTP server. Which of these is the correct minimal configuration?

hard

A. 'ftp' => [ 'driver' => 's3', 'key' => env('FTP_KEY'), 'secret' => env('FTP_SECRET') ],

B. 'ftp' => [ 'driver' => 'local', 'root' => env('FTP_HOST') ],

C. 'ftp' => [ 'driver' => 'ftp', 'bucket' => env('FTP_BUCKET') ],

D. 'ftp' => [ 'driver' => 'ftp', 'host' => env('FTP_HOST'), 'username' => env('FTP_USERNAME'), 'password' => env('FTP_PASSWORD') ],

Solution

1. Step 1: Identify the correct driver for FTP

   The driver must be 'ftp' to connect to an FTP server, so options with 'local' or 's3' are incorrect.

2. Step 2: Check required connection details

   FTP requires host, username, and password. 'ftp' => [ 'driver' => 'ftp', 'host' => env('FTP_HOST'), 'username' => env('FTP_USERNAME'), 'password' => env('FTP_PASSWORD') ], includes these minimal required keys.

3. Final Answer:

   'ftp' => [ 'driver' => 'ftp', 'host' => env('FTP_HOST'), 'username' => env('FTP_USERNAME'), 'password' => env('FTP_PASSWORD') ], -> Option D

4. Quick Check:

   FTP driver + host, username, password needed [OK]

Hint: FTP disk needs driver 'ftp' and host, user, password [OK]

Common Mistakes:

• Using wrong driver like 'local' or 's3' for FTP
• Missing required host or credentials
• Confusing bucket with FTP config