{"id":560,"date":"2022-02-18T22:40:00","date_gmt":"2022-02-18T22:40:00","guid":{"rendered":"https:\/\/rishikantsri.in\/blog\/?p=560"},"modified":"2023-10-27T09:22:19","modified_gmt":"2023-10-27T09:22:19","slug":"config-filesystems-php","status":"publish","type":"post","link":"https:\/\/rishikantsri.in\/blog\/config-filesystems-php\/","title":{"rendered":"Config : filesystems.php"},"content":{"rendered":"\n

The code, provided here, is a configuration file from Laravel 8 for handling filesystems. In this configuration file, you can define various filesystem disks, specify their properties, and set the default filesystem disk to be used by the framework. <\/p>\n\n\n\n

PHP<\/span><\/span><\/path><\/path><\/svg><\/span>
<?<\/span>php<\/span><\/span>\n<\/span>\nreturn<\/span> [<\/span><\/span>\n<\/span>\n    <\/span>\/*<\/span><\/span>\n    |--------------------------------------------------------------------------<\/span><\/span>\n    | Default Filesystem Disk<\/span><\/span>\n    |--------------------------------------------------------------------------<\/span><\/span>\n    |<\/span><\/span>\n    | Here you may specify the default filesystem disk that should be used<\/span><\/span>\n    | by the framework. The "local" disk, as well as a variety of cloud<\/span><\/span>\n    | based disks are available to your application. Just store away!<\/span><\/span>\n    |<\/span><\/span>\n    *\/<\/span><\/span>\n<\/span>\n    <\/span>'default'<\/span> <\/span>=><\/span> env<\/span>(<\/span>'FILESYSTEM_DRIVER'<\/span>,<\/span> <\/span>'local'<\/span>),<\/span><\/span>\n<\/span>\n    <\/span>\/*<\/span><\/span>\n    |--------------------------------------------------------------------------<\/span><\/span>\n    | Filesystem Disks<\/span><\/span>\n    |--------------------------------------------------------------------------<\/span><\/span>\n    |<\/span><\/span>\n    | Here you may configure as many filesystem "disks" as you wish, and you<\/span><\/span>\n    | may even configure multiple disks of the same driver. Defaults have<\/span><\/span>\n    | been setup for each driver as an example of the required options.<\/span><\/span>\n    |<\/span><\/span>\n    | Supported Drivers: "local", "ftp", "sftp", "s3"<\/span><\/span>\n    |<\/span><\/span>\n    *\/<\/span><\/span>\n<\/span>\n    <\/span>'disks'<\/span> <\/span>=><\/span> [<\/span><\/span>\n<\/span>\n        <\/span>'local'<\/span> <\/span>=><\/span> [<\/span><\/span>\n            <\/span>'driver'<\/span> <\/span>=><\/span> <\/span>'local'<\/span>,<\/span><\/span>\n            <\/span>'root'<\/span> <\/span>=><\/span> storage_path<\/span>(<\/span>'app'<\/span>),<\/span><\/span>\n        ]<\/span>,<\/span><\/span>\n<\/span>\n        <\/span>'public'<\/span> <\/span>=><\/span> [<\/span><\/span>\n            <\/span>'driver'<\/span> <\/span>=><\/span> <\/span>'local'<\/span>,<\/span><\/span>\n            <\/span>'root'<\/span> <\/span>=><\/span> storage_path<\/span>(<\/span>'app\/public'<\/span>),<\/span><\/span>\n            <\/span>'url'<\/span> <\/span>=><\/span> env<\/span>(<\/span>'APP_URL'<\/span>)<\/span>.<\/span>'\/storage'<\/span>,<\/span><\/span>\n            <\/span>'visibility'<\/span> <\/span>=><\/span> <\/span>'public'<\/span>,<\/span><\/span>\n        ]<\/span>,<\/span><\/span>\n<\/span>\n        <\/span>'s3'<\/span> <\/span>=><\/span> [<\/span><\/span>\n            <\/span>'driver'<\/span> <\/span>=><\/span> <\/span>'s3'<\/span>,<\/span><\/span>\n            <\/span>'key'<\/span> <\/span>=><\/span> env<\/span>(<\/span>'AWS_ACCESS_KEY_ID'<\/span>),<\/span><\/span>\n            <\/span>'secret'<\/span> <\/span>=><\/span> env<\/span>(<\/span>'AWS_SECRET_ACCESS_KEY'<\/span>),<\/span><\/span>\n            <\/span>'region'<\/span> <\/span>=><\/span> env<\/span>(<\/span>'AWS_DEFAULT_REGION'<\/span>),<\/span><\/span>\n            <\/span>'bucket'<\/span> <\/span>=><\/span> env<\/span>(<\/span>'AWS_BUCKET'<\/span>),<\/span><\/span>\n            <\/span>'url'<\/span> <\/span>=><\/span> env<\/span>(<\/span>'AWS_URL'<\/span>),<\/span><\/span>\n            <\/span>'endpoint'<\/span> <\/span>=><\/span> env<\/span>(<\/span>'AWS_ENDPOINT'<\/span>),<\/span><\/span>\n            <\/span>'use_path_style_endpoint'<\/span> <\/span>=><\/span> env<\/span>(<\/span>'AWS_USE_PATH_STYLE_ENDPOINT'<\/span>,<\/span> <\/span>false<\/span>),<\/span><\/span>\n        ]<\/span>,<\/span><\/span>\n<\/span>\n    ]<\/span>,<\/span><\/span>\n<\/span>\n    <\/span>\/*<\/span><\/span>\n    |--------------------------------------------------------------------------<\/span><\/span>\n    | Symbolic Links<\/span><\/span>\n    |--------------------------------------------------------------------------<\/span><\/span>\n    |<\/span><\/span>\n    | Here you may configure the symbolic links that will be created when the<\/span><\/span>\n    | `storage:link` Artisan command is executed. The array keys should be<\/span><\/span>\n    | the locations of the links and the values should be their targets.<\/span><\/span>\n    |<\/span><\/span>\n    *\/<\/span><\/span>\n<\/span>\n    <\/span>'links'<\/span> <\/span>=><\/span> [<\/span><\/span>\n        public_path<\/span>(<\/span>'storage'<\/span>)<\/span> <\/span>=><\/span> storage_path<\/span>(<\/span>'app\/public'<\/span>),<\/span><\/span>\n    ]<\/span>,<\/span><\/span>\n<\/span>\n];<\/span><\/span>\n<\/span><\/code><\/pre><\/div>\n\n\n\n
Step 1: Default Filesystem Disk<\/h3>\n\n\n\n
PHP<\/span><\/span><\/path><\/path><\/svg><\/span>
'default'<\/span> <\/span>=><\/span> env<\/span>(<\/span>'FILESYSTEM_DRIVER'<\/span>,<\/span> <\/span>'local'<\/span>),<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
    \n
  • This section specifies the default filesystem disk that should be used by the framework. The env<\/code> function is used to retrieve an environment variable, and it defaults to ‘local’ if the ‘FILESYSTEM_DRIVER’ environment variable is not set.<\/li>\n<\/ul>\n\n\n\n
    Step 2: Filesystem Disks<\/h3>\n\n\n\n
    PHP<\/span><\/span><\/path><\/path><\/svg><\/span>
    'disks'<\/span> <\/span>=><\/span> [<\/span><\/span>\n    <\/span>\/\/ ...<\/span><\/span>\n]<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
      \n
    • This section allows you to configure multiple filesystem disks. Laravel supports different drivers like ‘local’, ‘ftp’, ‘sftp’, and ‘s3’ for storing and retrieving files.<\/li>\n<\/ul>\n\n\n\n
      ‘local’ Disk<\/h4>\n\n\n\n
      PHP<\/span><\/span><\/path><\/path><\/svg><\/span>
      'local'<\/span> <\/span>=><\/span> [<\/span><\/span>\n    <\/span>'driver'<\/span> <\/span>=><\/span> <\/span>'local'<\/span>,<\/span><\/span>\n    <\/span>'root'<\/span> <\/span>=><\/span> storage_path<\/span>(<\/span>'app'<\/span>),<\/span><\/span>\n]<\/span>,<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
        \n
      • This section configures a disk named ‘local’ with the ‘local’ driver. The ‘root’ parameter defines the root directory for this disk, which is typically ‘storage\/app’.<\/li>\n<\/ul>\n\n\n\n
        ‘public’ Disk<\/h4>\n\n\n\n
        PHP<\/span><\/span><\/path><\/path><\/svg><\/span>
        'public'<\/span> <\/span>=><\/span> [<\/span><\/span>\n    <\/span>'driver'<\/span> <\/span>=><\/span> <\/span>'local'<\/span>,<\/span><\/span>\n    <\/span>'root'<\/span> <\/span>=><\/span> storage_path<\/span>(<\/span>'app\/public'<\/span>),<\/span><\/span>\n    <\/span>'url'<\/span> <\/span>=><\/span> env<\/span>(<\/span>'APP_URL'<\/span>)<\/span>.<\/span>'\/storage'<\/span>,<\/span><\/span>\n    <\/span>'visibility'<\/span> <\/span>=><\/span> <\/span>'public'<\/span>,<\/span><\/span>\n]<\/span>,<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
          \n
        • Here, a disk named ‘public’ is configured. It uses the ‘local’ driver and sets the root directory to ‘storage\/app\/public’. The ‘url’ parameter specifies the public URL for files stored in this disk. ‘visibility’ is set to ‘public’, indicating that files stored in this disk are publicly accessible.<\/li>\n<\/ul>\n\n\n\n
          ‘s3’ Disk<\/h4>\n\n\n\n
          PHP<\/span><\/span><\/path><\/path><\/svg><\/span>
          's3'<\/span> <\/span>=><\/span> [<\/span><\/span>\n    <\/span>'driver'<\/span> <\/span>=><\/span> <\/span>'s3'<\/span>,<\/span><\/span>\n    <\/span>'key'<\/span> <\/span>=><\/span> env<\/span>(<\/span>'AWS_ACCESS_KEY_ID'<\/span>),<\/span><\/span>\n    <\/span>'secret'<\/span> <\/span>=><\/span> env<\/span>(<\/span>'AWS_SECRET_ACCESS_KEY'<\/span>),<\/span><\/span>\n    <\/span>'region'<\/span> <\/span>=><\/span> env<\/span>(<\/span>'AWS_DEFAULT_REGION'<\/span>),<\/span><\/span>\n    <\/span>'bucket'<\/span> <\/span>=><\/span> env<\/span>(<\/span>'AWS_BUCKET'<\/span>),<\/span><\/span>\n    <\/span>'url'<\/span> <\/span>=><\/span> env<\/span>(<\/span>'AWS_URL'<\/span>),<\/span><\/span>\n    <\/span>'endpoint'<\/span> <\/span>=><\/span> env<\/span>(<\/span>'AWS_ENDPOINT'<\/span>),<\/span><\/span>\n    <\/span>'use_path_style_endpoint'<\/span> <\/span>=><\/span> env<\/span>(<\/span>'AWS_USE_PATH_STYLE_ENDPOINT'<\/span>,<\/span> <\/span>false<\/span>),<\/span><\/span>\n]<\/span>,<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
            \n
          • This section configures an ‘s3’ disk for storing files on Amazon S3. It uses the ‘s3’ driver and requires various settings like access key, secret key, region, bucket name, URL, and endpoint for the S3 service.<\/li>\n<\/ul>\n\n\n\n
            Step 3: Symbolic Links<\/h3>\n\n\n\n
            PHP<\/span><\/span><\/path><\/path><\/svg><\/span>
            'links'<\/span> <\/span>=><\/span> [<\/span><\/span>\n    public_path<\/span>(<\/span>'storage'<\/span>)<\/span> <\/span>=><\/span> storage_path<\/span>(<\/span>'app\/public'<\/span>),<\/span><\/span>\n]<\/span>,<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
              \n
            • This section defines symbolic links that will be created when the storage:link<\/code> Artisan command is executed. It specifies the location of the link and its target. In this example, it creates a symbolic link from ‘public\/storage’ to ‘storage\/app\/public’.<\/li>\n<\/ul>\n\n\n\n
              Usage Examples:<\/h3>\n\n\n\n
                \n
              1. Default Filesystem Disk<\/strong>: You can use the default filesystem disk to store and retrieve files in your application. For example, when you upload a user’s profile picture, it might be stored in the ‘local’ disk by default.<\/li>\n\n\n\n
              2. Multiple Disks<\/strong>: You can use different disks for different purposes. For instance, you might use the ‘public’ disk for storing user-generated content that needs to be publicly accessible, and the ‘s3’ disk for storing backups or sensitive files on Amazon S3.<\/li>\n\n\n\n
              3. Symbolic Links<\/strong>: When you run the php artisan storage:link<\/code> command, symbolic links will be created. For example, you can create a symbolic link from ‘public\/storage’ to ‘storage\/app\/public’, allowing you to serve files from ‘public\/storage’ to the web.<\/li>\n<\/ol>\n\n\n\n
                Pros and Cons:<\/h3>\n\n\n\n
                Pros<\/strong>:<\/p>\n\n\n\n
                  \n
                1. Abstraction<\/strong>: Laravel’s filesystem abstraction makes it easy to work with files and storage across different platforms and drivers without changing your code.<\/li>\n\n\n\n
                2. Configurability<\/strong>: You can easily configure and switch between different storage solutions (local, FTP, S3, etc.) based on your application’s needs.<\/li>\n\n\n\n
                3. Symbolic Links<\/strong>: Laravel provides a convenient way to create symbolic links, making it simple to serve files to the web.<\/li>\n\n\n\n
                4. Environment Variables<\/strong>: The use of environment variables for configuration allows for flexibility and security.<\/li>\n<\/ol>\n\n\n\n
                  Cons<\/strong>:<\/p>\n\n\n\n
                    \n
                  1. Complexity<\/strong>: Managing multiple disks and their configurations can become complex in large applications.<\/li>\n\n\n\n
                  2. External Dependencies<\/strong>: When using cloud storage drivers like Amazon S3, your application’s file storage is dependent on external services, which may introduce additional complexity and cost.<\/li>\n\n\n\n
                  3. Learning Curve<\/strong>: For developers new to Laravel, understanding the filesystem configuration and how to use different disks can be challenging.<\/li>\n<\/ol>\n\n\n\n
                    In summary, this Laravel 8 filesystem configuration allows you to define and manage various storage disks with different drivers and settings, making it versatile and adaptable to your application’s needs. It simplifies file storage and retrieval while providing flexibility and configurability. However, it’s important to carefully choose the right storage solution based on your project’s requirements and to consider the potential complexities of managing multiple disks and external dependencies.<\/p>\n","protected":false},"excerpt":{"rendered":"
                    The code, provided here, is a configuration file from Laravel 8 for handling filesystems. In this configuration file, you can define various filesystem disks, specify their properties, and set the default filesystem disk to be used by the framework. Step 1: Default Filesystem Disk Step 2: Filesystem Disks ‘local’ Disk ‘public’ Disk ‘s3’ Disk Step […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[63,11],"tags":[64,3,4],"_links":{"self":[{"href":"https:\/\/rishikantsri.in\/blog\/wp-json\/wp\/v2\/posts\/560"}],"collection":[{"href":"https:\/\/rishikantsri.in\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/rishikantsri.in\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/rishikantsri.in\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/rishikantsri.in\/blog\/wp-json\/wp\/v2\/comments?post=560"}],"version-history":[{"count":1,"href":"https:\/\/rishikantsri.in\/blog\/wp-json\/wp\/v2\/posts\/560\/revisions"}],"predecessor-version":[{"id":561,"href":"https:\/\/rishikantsri.in\/blog\/wp-json\/wp\/v2\/posts\/560\/revisions\/561"}],"wp:attachment":[{"href":"https:\/\/rishikantsri.in\/blog\/wp-json\/wp\/v2\/media?parent=560"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/rishikantsri.in\/blog\/wp-json\/wp\/v2\/categories?post=560"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/rishikantsri.in\/blog\/wp-json\/wp\/v2\/tags?post=560"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}