🕷️ Crawler Inspector

URL Lookup

Direct Parameter Lookup

Raw Queries and Responses

1. Shard Calculation

Query:

Response:

Calculated Shard: 63 (from laksa147)

2. Crawled Status Check

Query:

curl -X POST \
  'http://laksa063.int.ahrefs:8124/' \
  -H 'Content-Type: text/plain' \
  -H 'X-ClickHouse-Database: crawler3' \
  -H 'Authorization: Basic YXBpOg==' \
  -d 'SELECT getAhrefsURLFromUnparsed(src_unparsed) AS found_url, ifNull(toUnixTimestamp(download_stamp), 0) AS crawl_time, ifNull(toUnixTimestamp(props_url_first_seen), 0) AS first_indexed_time, download_http_code AS http_code, src_unparsed AS src_unparsed, src_root_hash AS src_root_hash, history_drop_reason AS history_drop_reason, meta_title AS meta_title, meta_descriptions AS meta_descriptions, attrs_boilerpipe_text AS attrs_boilerpipe_text, attrs_markdown AS attrs_markdown, attrs_readable_markdown AS attrs_readable_markdown, meta_canonical AS meta_canonical FROM crawler3.page_info_local FINAL PREWHERE (src_root_hash, src_unparsed) IN ((getAhrefsRootHashFromUnparsed(getAhrefsUnparsedNoserviceFromURL(\'https://laravel.com/docs/12.x/filesystem\')), getAhrefsUnparsedNoserviceFromURL(\'https://laravel.com/docs/12.x/filesystem\'))) FORMAT JSONEachRow'

Response:

{"found_url":"https:\/\/laravel.com\/docs\/12.x\/filesystem","crawl_time":1776043894,"first_indexed_time":1740415655,"http_code":200,"src_unparsed":"com,laravel!\/docs\/12.x\/filesystem s443","src_root_hash":"5292393658133462863","history_drop_reason":null,"meta_title":"File Storage | Laravel 12.x - The clean stack for Artisans and agents","meta_descriptions":["Laravel is a PHP web application framework with expressive, elegant syntax. We've already laid the foundation — freeing you to create without sweating the small things."],"attrs_boilerpipe_text":"WARNING\nYou're browsing the documentation for an old version of Laravel. Consider upgrading your project to\nLaravel 13.x\n.\nIntroduction\nConfiguration\nThe Local Driver\nThe Public Disk\nDriver Prerequisites\nScoped and Read-Only Filesystems\nAmazon S3 Compatible Filesystems\nObtaining Disk Instances\nOn-Demand Disks\nRetrieving Files\nDownloading Files\nFile URLs\nTemporary URLs\nFile Metadata\nStoring Files\nPrepending and Appending To Files\nCopying and Moving Files\nAutomatic Streaming\nFile Uploads\nFile Visibility\nDeleting Files\nDirectories\nTesting\nCustom Filesystems\nIntroduction\nLaravel provides a powerful filesystem abstraction thanks to the wonderful\nFlysystem\nPHP package by Frank de Jonge. The Laravel Flysystem integration provides simple drivers for working with local filesystems, SFTP, and Amazon S3. Even better, it's amazingly simple to switch between these storage options between your local development machine and production server as the API remains the same for each system.\nConfiguration\nLaravel's filesystem configuration file is located at\nconfig\/filesystems.php\n. Within this file, you may configure all of your filesystem \"disks\". Each disk represents a particular storage driver and storage location. Example configurations for each supported driver are included in the configuration file so you can modify the configuration to reflect your storage preferences and credentials.\nThe\nlocal\ndriver interacts with files stored locally on the server running the Laravel application, while the\nsftp\nstorage driver is used for SSH key-based FTP. The\ns3\ndriver is used to write to Amazon's S3 cloud storage service.\nYou may configure as many disks as you like and may even have multiple disks that use the same driver.\nThe Local Driver\nWhen using the\nlocal\ndriver, all file operations are relative to the\nroot\ndirectory defined in your\nfilesystems\nconfiguration file. By default, this value is set to the\nstorage\/app\/private\ndirectory. Therefore, the following method would write to\nstorage\/app\/private\/example.txt\n:\n1\nuse\nIlluminate\\Support\\Facades\\\nStorage\n;\n2\n3\nStorage\n::\ndisk\n(\n'\nlocal\n'\n)\n->\nput\n(\n'\nexample.txt\n'\n,\n'\nContents\n'\n);\nThe Public Disk\nThe\npublic\ndisk included in your application's\nfilesystems\nconfiguration file is intended for files that are going to be publicly accessible. By default, the\npublic\ndisk uses the\nlocal\ndriver and stores its files in\nstorage\/app\/public\n.\nIf your\npublic\ndisk uses the\nlocal\ndriver and you want to make these files accessible from the web, you should create a symbolic link from source directory\nstorage\/app\/public\nto target directory\npublic\/storage\n:\nTo create the symbolic link, you may use the\nstorage:link\nArtisan command:\n1\nphp\nartisan\nstorage:link\nOnce a file has been stored and the symbolic link has been created, you can create a URL to the files using the\nasset\nhelper:\n1\necho\nasset\n(\n'\nstorage\/file.txt\n'\n);\nYou may configure additional symbolic links in your\nfilesystems\nconfiguration file. Each of the configured links will be created when you run the\nstorage:link\ncommand:\n1\n'\nlinks\n'\n=>\n[\n2\npublic_path\n(\n'\nstorage\n'\n)\n=>\nstorage_path\n(\n'\napp\/public\n'\n),\n3\npublic_path\n(\n'\nimages\n'\n)\n=>\nstorage_path\n(\n'\napp\/images\n'\n),\n4\n],\nThe\nstorage:unlink\ncommand may be used to destroy your configured symbolic links:\n1\nphp\nartisan\nstorage:unlink\nDriver Prerequisites\nS3 Driver Configuration\nBefore using the S3 driver, you will need to install the Flysystem S3 package via the Composer package manager:\n1\ncomposer\nrequire\nleague\/flysystem-aws-s3-v3\n\"\n^3.0\n\"\n--with-all-dependencies\nAn S3 disk configuration array is located in your\nconfig\/filesystems.php\nconfiguration file. Typically, you should configure your S3 information and credentials using the following environment variables which are referenced by the\nconfig\/filesystems.php\nconfiguration file:\n1\nAWS_ACCESS_KEY_ID\n=<your-key-id>\n2\nAWS_SECRET_ACCESS_KEY\n=<your-secret-access-key>\n3\nAWS_DEFAULT_REGION\n=us-east-1\n4\nAWS_BUCKET\n=<your-bucket-name>\n5\nAWS_USE_PATH_STYLE_ENDPOINT\n=false\nFor convenience, these environment variables match the naming convention used by the AWS CLI.\nFTP Driver Configuration\nBefore using the FTP driver, you will need to install the Flysystem FTP package via the Composer package manager:\n1\ncomposer\nrequire\nleague\/flysystem-ftp\n\"\n^3.0\n\"\nLaravel's Flysystem integrations work great with FTP; however, a sample configuration is not included with the framework's default\nconfig\/filesystems.php\nconfiguration file. If you need to configure an FTP filesystem, you may use the configuration example below:\n1\n'\nftp\n'\n=>\n[\n2\n'\ndriver\n'\n=>\n'\nftp\n'\n,\n3\n'\nhost\n'\n=>\nenv\n(\n'\nFTP_HOST\n'\n),\n4\n'\nusername\n'\n=>\nenv\n(\n'\nFTP_USERNAME\n'\n),\n5\n'\npassword\n'\n=>\nenv\n(\n'\nFTP_PASSWORD\n'\n),\n6\n7\n\/\/\nOptional FTP Settings...\n8\n\/\/\n'port' => env('FTP_PORT', 21),\n9\n\/\/\n'root' => env('FTP_ROOT'),\n10\n\/\/\n'passive' => true,\n11\n\/\/\n'ssl' => true,\n12\n\/\/\n'timeout' => 30,\n13\n],\nSFTP Driver Configuration\nBefore using the SFTP driver, you will need to install the Flysystem SFTP package via the Composer package manager:\n1\ncomposer\nrequire\nleague\/flysystem-sftp-v3\n\"\n^3.0\n\"\nLaravel's Flysystem integrations work great with SFTP; however, a sample configuration is not included with the framework's default\nconfig\/filesystems.php\nconfiguration file. If you need to configure an SFTP filesystem, you may use the configuration example below:\n1\n'\nsftp\n'\n=>\n[\n2\n'\ndriver\n'\n=>\n'\nsftp\n'\n,\n3\n'\nhost\n'\n=>\nenv\n(\n'\nSFTP_HOST\n'\n),\n4\n5\n\/\/\nSettings for basic authentication...\n6\n'\nusername\n'\n=>\nenv\n(\n'\nSFTP_USERNAME\n'\n),\n7\n'\npassword\n'\n=>\nenv\n(\n'\nSFTP_PASSWORD\n'\n),\n8\n9\n\/\/\nSettings for SSH key-based authentication with encryption password...\n10\n'\nprivateKey\n'\n=>\nenv\n(\n'\nSFTP_PRIVATE_KEY\n'\n),\n11\n'\npassphrase\n'\n=>\nenv\n(\n'\nSFTP_PASSPHRASE\n'\n),\n12\n13\n\/\/\nSettings for file \/ directory permissions...\n14\n'\nvisibility\n'\n=>\n'\nprivate\n'\n,\n\/\/\n`private` = 0600, `public` = 0644\n15\n'\ndirectory_visibility\n'\n=>\n'\nprivate\n'\n,\n\/\/\n`private` = 0700, `public` = 0755\n16\n17\n\/\/\nOptional SFTP Settings...\n18\n\/\/\n'hostFingerprint' => env('SFTP_HOST_FINGERPRINT'),\n19\n\/\/\n'maxTries' => 4,\n20\n\/\/\n'passphrase' => env('SFTP_PASSPHRASE'),\n21\n\/\/\n'port' => env('SFTP_PORT', 22),\n22\n\/\/\n'root' => env('SFTP_ROOT', ''),\n23\n\/\/\n'timeout' => 30,\n24\n\/\/\n'useAgent' => true,\n25\n],\nScoped and Read-Only Filesystems\nScoped disks allow you to define a filesystem where all paths are automatically prefixed with a given path prefix. Before creating a scoped filesystem disk, you will need to install an additional Flysystem package via the Composer package manager:\n1\ncomposer\nrequire\nleague\/flysystem-path-prefixing\n\"\n^3.0\n\"\nYou may create a path scoped instance of any existing filesystem disk by defining a disk that utilizes the\nscoped\ndriver. For example, you may create a disk which scopes your existing\ns3\ndisk to a specific path prefix, and then every file operation using your scoped disk will utilize the specified prefix:\n1\n'\ns3-videos\n'\n=>\n[\n2\n'\ndriver\n'\n=>\n'\nscoped\n'\n,\n3\n'\ndisk\n'\n=>\n'\ns3\n'\n,\n4\n'\nprefix\n'\n=>\n'\npath\/to\/videos\n'\n,\n5\n],\n\"Read-only\" disks allow you to create filesystem disks that do not allow write operations. Before using the\nread-only\nconfiguration option, you will need to install an additional Flysystem package via the Composer package manager:\n1\ncomposer\nrequire\nleague\/flysystem-read-only\n\"\n^3.0\n\"\nNext, you may include the\nread-only\nconfiguration option in one or more of your disk's configuration arrays:\n1\n'\ns3-videos\n'\n=>\n[\n2\n'\ndriver\n'\n=>\n'\ns3\n'\n,\n3\n\/\/\n...\n4\n'\nread-only\n'\n=>\ntrue\n,\n5\n],\nAmazon S3 Compatible Filesystems\nBy default, your application's\nfilesystems\nconfiguration file contains a disk configuration for the\ns3\ndisk. In addition to using this disk to interact with\nAmazon S3\n, you may use it to interact with any S3-compatible file storage service such as\nRustFS\n,\nDigitalOcean Spaces\n,\nVultr Object Storage\n,\nCloudflare R2\n, or\nHetzner Cloud Storage\n.\nTypically, after updating the disk's credentials to match the credentials of the service you are planning to use, you only need to update the value of the\nendpoint\nconfiguration option. This option's value is typically defined via the\nAWS_ENDPOINT\nenvironment variable:\n1\n'\nendpoint\n'\n=>\nenv\n(\n'\nAWS_ENDPOINT\n'\n,\n'\nhttps:\/\/rustfs:9000\n'\n),\nObtaining Disk Instances\nThe\nStorage\nfacade may be used to interact with any of your configured disks. For example, you may use the\nput\nmethod on the facade to store an avatar on the default disk. If you call methods on the\nStorage\nfacade without first calling the\ndisk\nmethod, the method will automatically be passed to the default disk:\n1\nuse\nIlluminate\\Support\\Facades\\\nStorage\n;\n2\n3\nStorage\n::\nput\n(\n'\navatars\/1\n'\n,\n$content\n);\nIf your application interacts with multiple disks, you may use the\ndisk\nmethod on the\nStorage\nfacade to work with files on a particular disk:\n1\nStorage\n::\ndisk\n(\n'\ns3\n'\n)\n->\nput\n(\n'\navatars\/1\n'\n,\n$content\n);\nOn-Demand Disks\nSometimes you may wish to create a disk at runtime using a given configuration without that configuration actually being present in your application's\nfilesystems\nconfiguration file. To accomplish this, you may pass a configuration array to the\nStorage\nfacade's\nbuild\nmethod:\n1\nuse\nIlluminate\\Support\\Facades\\\nStorage\n;\n2\n3\n$disk\n=\nStorage\n::\nbuild\n([\n4\n'\ndriver\n'\n=>\n'\nlocal\n'\n,\n5\n'\nroot\n'\n=>\n'\n\/path\/to\/root\n'\n,\n6\n]);\n7\n8\n$disk\n->\nput\n(\n'\nimage.jpg\n'\n,\n$content\n);\nRetrieving Files\nThe\nget\nmethod may be used to retrieve the contents of a file. The raw string contents of the file will be returned by the method. Remember, all file paths should be specified relative to the disk's \"root\" location:\n1\n$contents\n=\nStorage\n::\nget\n(\n'\nfile.jpg\n'\n);\nIf the file you are retrieving contains JSON, you may use the\njson\nmethod to retrieve the file and decode its contents:\n1\n$orders\n=\nStorage\n::\njson\n(\n'\norders.json\n'\n);\nThe\nexists\nmethod may be used to determine if a file exists on the disk:\n1\nif\n(\nStorage\n::\ndisk\n(\n'\ns3\n'\n)\n->\nexists\n(\n'\nfile.jpg\n'\n)) {\n2\n\/\/\n...\n3\n}\nThe\nmissing\nmethod may be used to determine if a file is missing from the disk:\n1\nif\n(\nStorage\n::\ndisk\n(\n'\ns3\n'\n)\n->\nmissing\n(\n'\nfile.jpg\n'\n)) {\n2\n\/\/\n...\n3\n}\nDownloading Files\nThe\ndownload\nmethod may be used to generate a response that forces the user's browser to download the file at the given path. The\ndownload\nmethod accepts a filename as the second argument to the method, which will determine the filename that is seen by the user downloading the file. Finally, you may pass an array of HTTP headers as the third argument to the method:\n1\nreturn\nStorage\n::\ndownload\n(\n'\nfile.jpg\n'\n);\n2\n3\nreturn\nStorage\n::\ndownload\n(\n'\nfile.jpg\n'\n,\n$name\n,\n$headers\n);\nFile URLs\nYou may use the\nurl\nmethod to get the URL for a given file. If you are using the\nlocal\ndriver, this will typically just prepend\n\/storage\nto the given path and return a relative URL to the file. If you are using the\ns3\ndriver, the fully qualified remote URL will be returned:\n1\nuse\nIlluminate\\Support\\Facades\\\nStorage\n;\n2\n3\n$url\n=\nStorage\n::\nurl\n(\n'\nfile.jpg\n'\n);\nWhen using the\nlocal\ndriver, all files that should be publicly accessible should be placed in the\nstorage\/app\/public\ndirectory. Furthermore, you should\ncreate a symbolic link\nat\npublic\/storage\nwhich points to the\nstorage\/app\/public\ndirectory.\nWhen using the\nlocal\ndriver, the return value of\nurl\nis not URL encoded. For this reason, we recommend always storing your files using names that will create valid URLs.\nURL Host Customization\nIf you would like to modify the host for URLs generated using the\nStorage\nfacade, you may add or change the\nurl\noption in the disk's configuration array:\n1\n'\npublic\n'\n=>\n[\n2\n'\ndriver\n'\n=>\n'\nlocal\n'\n,\n3\n'\nroot\n'\n=>\nstorage_path\n(\n'\napp\/public\n'\n),\n4\n'\nurl\n'\n=>\nenv\n(\n'\nAPP_URL\n'\n)\n.\n'\n\/storage\n'\n,\n5\n'\nvisibility\n'\n=>\n'\npublic\n'\n,\n6\n'\nthrow\n'\n=>\nfalse\n,\n7\n],\nTemporary URLs\nUsing the\ntemporaryUrl\nmethod, you may create temporary URLs to files stored using the\nlocal\nand\ns3\ndrivers. This method accepts a path and a\nDateTime\ninstance specifying when the URL should expire:\n1\nuse\nIlluminate\\Support\\Facades\\\nStorage\n;\n2\n3\n$url\n=\nStorage\n::\ntemporaryUrl\n(\n4\n'\nfile.jpg\n'\n,\nnow\n()\n->\nplus\n(minutes:\n5\n)\n5\n);\nEnabling Local Temporary URLs\nIf you started developing your application before support for temporary URLs was introduced to the\nlocal\ndriver, you may need to enable local temporary URLs. To do so, add the\nserve\noption to your\nlocal\ndisk's configuration array within the\nconfig\/filesystems.php\nconfiguration file:\n1\n'\nlocal\n'\n=>\n[\n2\n'\ndriver\n'\n=>\n'\nlocal\n'\n,\n3\n'\nroot\n'\n=>\nstorage_path\n(\n'\napp\/private\n'\n),\n4\n'\nserve\n'\n=>\ntrue\n,\n5\n'\nthrow\n'\n=>\nfalse\n,\n6\n],\nS3 Request Parameters\nIf you need to specify additional\nS3 request parameters\n, you may pass the array of request parameters as the third argument to the\ntemporaryUrl\nmethod:\n1\n$url\n=\nStorage\n::\ntemporaryUrl\n(\n2\n'\nfile.jpg\n'\n,\n3\nnow\n()\n->\nplus\n(minutes:\n5\n),\n4\n[\n5\n'\nResponseContentType\n'\n=>\n'\napplication\/octet-stream\n'\n,\n6\n'\nResponseContentDisposition\n'\n=>\n'\nattachment; filename=file2.jpg\n'\n,\n7\n]\n8\n);\nCustomizing Temporary URLs\nIf you need to customize how temporary URLs are created for a specific storage disk, you can use the\nbuildTemporaryUrlsUsing\nmethod. For example, this can be useful if you have a controller that allows you to download files stored via a disk that doesn't typically support temporary URLs. Usually, this method should be called from the\nboot\nmethod of a service provider:\n1\n<?php\n2\n3\nnamespace\nApp\\Providers;\n4\n5\nuse\nDateTime\n;\n6\nuse\nIlluminate\\Support\\Facades\\\nStorage\n;\n7\nuse\nIlluminate\\Support\\Facades\\\nURL\n;\n8\nuse\nIlluminate\\Support\\\nServiceProvider\n;\n9\n10\nclass\nAppServiceProvider\nextends\nServiceProvider\n11\n{\n12\n\/**\n13\n* Bootstrap any application services.\n14\n*\/\n15\npublic\nfunction\nboot\n()\n:\nvoid\n16\n{\n17\nStorage\n::\ndisk\n(\n'\nlocal\n'\n)\n->\nbuildTemporaryUrlsUsing\n(\n18\nfunction\n(\nstring\n$path\n,\nDateTime\n$expiration\n,\narray\n$options\n)\n{\n19\nreturn\nURL\n::\ntemporarySignedRoute\n(\n20\n'\nfiles.download\n'\n,\n21\n$expiration\n,\n22\narray_merge\n($\noptions\n,\n[\n'\npath\n'\n=>\n$\npath\n])\n23\n);\n24\n}\n25\n);\n26\n}\n27\n}\nTemporary Upload URLs\nThe ability to generate temporary upload URLs is only supported by the\ns3\nand\nlocal\ndrivers.\nIf you need to generate a temporary URL that can be used to upload a file directly from your client-side application, you may use the\ntemporaryUploadUrl\nmethod. This method accepts a path and a\nDateTime\ninstance specifying when the URL should expire. The\ntemporaryUploadUrl\nmethod returns an associative array which may be destructured into the upload URL and the headers that should be included with the upload request:\n1\nuse\nIlluminate\\Support\\Facades\\\nStorage\n;\n2\n3\n[\n'\nurl\n'\n=>\n$url\n,\n'\nheaders\n'\n=>\n$headers\n]\n=\nStorage\n::\ntemporaryUploadUrl\n(\n4\n'\nfile.jpg\n'\n,\nnow\n()\n->\nplus\n(minutes:\n5\n)\n5\n);\nThis method is primarily useful in serverless environments that require the client-side application to directly upload files to a cloud storage system such as Amazon S3.\nFile Metadata\nIn addition to reading and writing files, Laravel can also provide information about the files themselves. For example, the\nsize\nmethod may be used to get the size of a file in bytes:\n1\nuse\nIlluminate\\Support\\Facades\\\nStorage\n;\n2\n3\n$size\n=\nStorage\n::\nsize\n(\n'\nfile.jpg\n'\n);\nThe\nlastModified\nmethod returns the UNIX timestamp of the last time the file was modified:\n1\n$time\n=\nStorage\n::\nlastModified\n(\n'\nfile.jpg\n'\n);\nThe MIME type of a given file may be obtained via the\nmimeType\nmethod:\n1\n$mime\n=\nStorage\n::\nmimeType\n(\n'\nfile.jpg\n'\n);\nFile Paths\nYou may use the\npath\nmethod to get the path for a given file. If you are using the\nlocal\ndriver, this will return the absolute path to the file. If you are using the\ns3\ndriver, this method will return the relative path to the file in the S3 bucket:\n1\nuse\nIlluminate\\Support\\Facades\\\nStorage\n;\n2\n3\n$path\n=\nStorage\n::\npath\n(\n'\nfile.jpg\n'\n);\nStoring Files\nThe\nput\nmethod may be used to store file contents on a disk. You may also pass a PHP\nresource\nto the\nput\nmethod, which will use Flysystem's underlying stream support. Remember, all file paths should be specified relative to the \"root\" location configured for the disk:\n1\nuse\nIlluminate\\Support\\Facades\\\nStorage\n;\n2\n3\nStorage\n::\nput\n(\n'\nfile.jpg\n'\n,\n$contents\n);\n4\n5\nStorage\n::\nput\n(\n'\nfile.jpg\n'\n,\n$resource\n);\nFailed Writes\nIf the\nput\nmethod (or other \"write\" operations) is unable to write the file to disk,\nfalse\nwill be returned:\n1\nif\n(\n!\nStorage\n::\nput\n(\n'\nfile.jpg\n'\n,\n$contents\n)) {\n2\n\/\/\nThe file could not be written to disk...\n3\n}\nIf you wish, you may define the\nthrow\noption within your filesystem disk's configuration array. When this option is defined as\ntrue\n, \"write\" methods such as\nput\nwill throw an instance of\nLeague\\Flysystem\\UnableToWriteFile\nwhen write operations fail:\n1\n'\npublic\n'\n=>\n[\n2\n'\ndriver\n'\n=>\n'\nlocal\n'\n,\n3\n\/\/\n...\n4\n'\nthrow\n'\n=>\ntrue\n,\n5\n],\nPrepending and Appending To Files\nThe\nprepend\nand\nappend\nmethods allow you to write to the beginning or end of a file:\n1\nStorage\n::\nprepend\n(\n'\nfile.log\n'\n,\n'\nPrepended Text\n'\n);\n2\n3\nStorage\n::\nappend\n(\n'\nfile.log\n'\n,\n'\nAppended Text\n'\n);\nCopying and Moving Files\nThe\ncopy\nmethod may be used to copy an existing file to a new location on the disk, while the\nmove\nmethod may be used to rename or move an existing file to a new location:\n1\nStorage\n::\ncopy\n(\n'\nold\/file.jpg\n'\n,\n'\nnew\/file.jpg\n'\n);\n2\n3\nStorage\n::\nmove\n(\n'\nold\/file.jpg\n'\n,\n'\nnew\/file.jpg\n'\n);\nAutomatic Streaming\nStreaming files to storage offers significantly reduced memory usage. If you would like Laravel to automatically manage streaming a given file to your storage location, you may use the\nputFile\nor\nputFileAs\nmethod. This method accepts either an\nIlluminate\\Http\\File\nor\nIlluminate\\Http\\UploadedFile\ninstance and will automatically stream the file to your desired location:\n1\nuse\nIlluminate\\Http\\\nFile\n;\n2\nuse\nIlluminate\\Support\\Facades\\\nStorage\n;\n3\n4\n\/\/\nAutomatically generate a unique ID for filename...\n5\n$path\n=\nStorage\n::\nputFile\n(\n'\nphotos\n'\n,\nnew\nFile\n(\n'\n\/path\/to\/photo\n'\n));\n6\n7\n\/\/\nManually specify a filename...\n8\n$path\n=\nStorage\n::\nputFileAs\n(\n'\nphotos\n'\n,\nnew\nFile\n(\n'\n\/path\/to\/photo\n'\n),\n'\nphoto.jpg\n'\n);\nThere are a few important things to note about the\nputFile\nmethod. Note that we only specified a directory name and not a filename. By default, the\nputFile\nmethod will generate a unique ID to serve as the filename. The file's extension will be determined by examining the file's MIME type. The path to the file will be returned by the\nputFile\nmethod so you can store the path, including the generated filename, in your database.\nThe\nputFile\nand\nputFileAs\nmethods also accept an argument to specify the \"visibility\" of the stored file. This is particularly useful if you are storing the file on a cloud disk such as Amazon S3 and would like the file to be publicly accessible via generated URLs:\n1\nStorage\n::\nputFile\n(\n'\nphotos\n'\n,\nnew\nFile\n(\n'\n\/path\/to\/photo\n'\n),\n'\npublic\n'\n);\nFile Uploads\nIn web applications, one of the most common use-cases for storing files is storing user uploaded files such as photos and documents. Laravel makes it very easy to store uploaded files using the\nstore\nmethod on an uploaded file instance. Call the\nstore\nmethod with the path at which you wish to store the uploaded file:\n1\n<?php\n2\n3\nnamespace\nApp\\Http\\Controllers;\n4\n5\nuse\nIlluminate\\Http\\\nRequest\n;\n6\n7\nclass\nUserAvatarController\nextends\nController\n8\n{\n9\n\/**\n10\n* Update the avatar for the user.\n11\n*\/\n12\npublic\nfunction\nupdate\n(\nRequest\n$request\n)\n:\nstring\n13\n{\n14\n$path\n=\n$request\n->\nfile\n(\n'\navatar\n'\n)\n->\nstore\n(\n'\navatars\n'\n);\n15\n16\nreturn\n$path\n;\n17\n}\n18\n}\nThere are a few important things to note about this example. Note that we only specified a directory name, not a filename. By default, the\nstore\nmethod will generate a unique ID to serve as the filename. The file's extension will be determined by examining the file's MIME type. The path to the file will be returned by the\nstore\nmethod so you can store the path, including the generated filename, in your database.\nYou may also call the\nputFile\nmethod on the\nStorage\nfacade to perform the same file storage operation as the example above:\n1\n$path\n=\nStorage\n::\nputFile\n(\n'\navatars\n'\n,\n$request\n->\nfile\n(\n'\navatar\n'\n));\nSpecifying a File Name\nIf you do not want a filename to be automatically assigned to your stored file, you may use the\nstoreAs\nmethod, which receives the path, the filename, and the (optional) disk as its arguments:\n1\n$path\n=\n$request\n->\nfile\n(\n'\navatar\n'\n)\n->\nstoreAs\n(\n2\n'\navatars\n'\n,\n$request\n->\nuser\n()\n->id\n3\n);\nYou may also use the\nputFileAs\nmethod on the\nStorage\nfacade, which will perform the same file storage operation as the example above:\n1\n$path\n=\nStorage\n::\nputFileAs\n(\n2\n'\navatars\n'\n,\n$request\n->\nfile\n(\n'\navatar\n'\n),\n$request\n->\nuser\n()\n->id\n3\n);\nUnprintable and invalid unicode characters will automatically be removed from file paths. Therefore, you may wish to sanitize your file paths before passing them to Laravel's file storage methods. File paths are normalized using the\nLeague\\Flysystem\\WhitespacePathNormalizer::normalizePath\nmethod.\nSpecifying a Disk\nBy default, this uploaded file's\nstore\nmethod will use your default disk. If you would like to specify another disk, pass the disk name as the second argument to the\nstore\nmethod:\n1\n$path\n=\n$request\n->\nfile\n(\n'\navatar\n'\n)\n->\nstore\n(\n2\n'\navatars\/\n'\n.\n$request\n->\nuser\n()\n->id\n,\n'\ns3\n'\n3\n);\nIf you are using the\nstoreAs\nmethod, you may pass the disk name as the third argument to the method:\n1\n$path\n=\n$request\n->\nfile\n(\n'\navatar\n'\n)\n->\nstoreAs\n(\n2\n'\navatars\n'\n,\n3\n$request\n->\nuser\n()\n->id\n,\n4\n'\ns3\n'\n5\n);\nOther Uploaded File Information\nIf you would like to get the original name and extension of the uploaded file, you may do so using the\ngetClientOriginalName\nand\ngetClientOriginalExtension\nmethods:\n1\n$file\n=\n$request\n->\nfile\n(\n'\navatar\n'\n);\n2\n3\n$name\n=\n$file\n->\ngetClientOriginalName\n();\n4\n$extension\n=\n$file\n->\ngetClientOriginalExtension\n();\nHowever, keep in mind that the\ngetClientOriginalName\nand\ngetClientOriginalExtension\nmethods are considered unsafe, as the file name and extension may be tampered with by a malicious user. For this reason, you should typically prefer the\nhashName\nand\nextension\nmethods to get a name and an extension for the given file upload:\n1\n$file\n=\n$request\n->\nfile\n(\n'\navatar\n'\n);\n2\n3\n$name\n=\n$file\n->\nhashName\n();\n\/\/\nGenerate a unique, random name...\n4\n$extension\n=\n$file\n->\nextension\n();\n\/\/\nDetermine the file's extension based on the file's MIME type...\nFile Visibility\nIn Laravel's Flysystem integration, \"visibility\" is an abstraction of file permissions across multiple platforms. Files may either be declared\npublic\nor\nprivate\n. When a file is declared\npublic\n, you are indicating that the file should generally be accessible to others. For example, when using the S3 driver, you may retrieve URLs for\npublic\nfiles.\nYou can set the visibility when writing the file via the\nput\nmethod:\n1\nuse\nIlluminate\\Support\\Facades\\\nStorage\n;\n2\n3\nStorage\n::\nput\n(\n'\nfile.jpg\n'\n,\n$contents\n,\n'\npublic\n'\n);\nIf the file has already been stored, its visibility can be retrieved and set via the\ngetVisibility\nand\nsetVisibility\nmethods:\n1\n$visibility\n=\nStorage\n::\ngetVisibility\n(\n'\nfile.jpg\n'\n);\n2\n3\nStorage\n::\nsetVisibility\n(\n'\nfile.jpg\n'\n,\n'\npublic\n'\n);\nWhen interacting with uploaded files, you may use the\nstorePublicly\nand\nstorePubliclyAs\nmethods to store the uploaded file with\npublic\nvisibility:\n1\n$path\n=\n$request\n->\nfile\n(\n'\navatar\n'\n)\n->\nstorePublicly\n(\n'\navatars\n'\n,\n'\ns3\n'\n);\n2\n3\n$path\n=\n$request\n->\nfile\n(\n'\navatar\n'\n)\n->\nstorePubliclyAs\n(\n4\n'\navatars\n'\n,\n5\n$request\n->\nuser\n()\n->id\n,\n6\n'\ns3\n'\n7\n);\nLocal Files and Visibility\nWhen using the\nlocal\ndriver,\npublic\nvisibility\ntranslates to\n0755\npermissions for directories and\n0644\npermissions for files. You can modify the permissions mappings in your application's\nfilesystems\nconfiguration file:\n1\n'\nlocal\n'\n=>\n[\n2\n'\ndriver\n'\n=>\n'\nlocal\n'\n,\n3\n'\nroot\n'\n=>\nstorage_path\n(\n'\napp\n'\n),\n4\n'\npermissions\n'\n=>\n[\n5\n'\nfile\n'\n=>\n[\n6\n'\npublic\n'\n=>\n0644\n,\n7\n'\nprivate\n'\n=>\n0600\n,\n8\n],\n9\n'\ndir\n'\n=>\n[\n10\n'\npublic\n'\n=>\n0755\n,\n11\n'\nprivate\n'\n=>\n0700\n,\n12\n],\n13\n],\n14\n'\nthrow\n'\n=>\nfalse\n,\n15\n],\nDeleting Files\nThe\ndelete\nmethod accepts a single filename or an array of files to delete:\n1\nuse\nIlluminate\\Support\\Facades\\\nStorage\n;\n2\n3\nStorage\n::\ndelete\n(\n'\nfile.jpg\n'\n);\n4\n5\nStorage\n::\ndelete\n([\n'\nfile.jpg\n'\n,\n'\nfile2.jpg\n'\n]);\nIf necessary, you may specify the disk that the file should be deleted from:\n1\nuse\nIlluminate\\Support\\Facades\\\nStorage\n;\n2\n3\nStorage\n::\ndisk\n(\n'\ns3\n'\n)\n->\ndelete\n(\n'\npath\/file.jpg\n'\n);\nDirectories\nGet All Files Within a Directory\nThe\nfiles\nmethod returns an array of all files within a given directory. If you would like to retrieve a list of all files within a given directory including subdirectories, you may use the\nallFiles\nmethod:\n1\nuse\nIlluminate\\Support\\Facades\\\nStorage\n;\n2\n3\n$files\n=\nStorage\n::\nfiles\n(\n$directory\n);\n4\n5\n$files\n=\nStorage\n::\nallFiles\n(\n$directory\n);\nGet All Directories Within a Directory\nThe\ndirectories\nmethod returns an array of all directories within a given directory. If you would like to retrieve a list of all directories within a given directory including subdirectories, you may use the\nallDirectories\nmethod:\n1\n$directories\n=\nStorage\n::\ndirectories\n(\n$directory\n);\n2\n3\n$directories\n=\nStorage\n::\nallDirectories\n(\n$directory\n);\nCreate a Directory\nThe\nmakeDirectory\nmethod will create the given directory, including any needed subdirectories:\n1\nStorage\n::\nmakeDirectory\n(\n$directory\n);\nDelete a Directory\nFinally, the\ndeleteDirectory\nmethod may be used to remove a directory and all of its files:\n1\nStorage\n::\ndeleteDirectory\n(\n$directory\n);\nTesting\nThe\nStorage\nfacade's\nfake\nmethod allows you to easily generate a fake disk that, combined with the file generation utilities of the\nIlluminate\\Http\\UploadedFile\nclass, greatly simplifies the testing of file uploads. For example:\n1\n<?php\n2\n3\nuse\nIlluminate\\Http\\\nUploadedFile\n;\n4\nuse\nIlluminate\\Support\\Facades\\\nStorage\n;\n5\n6\ntest\n(\n'\nalbums can be uploaded\n'\n,\nfunction\n()\n{\n7\nStorage\n::\nfake\n(\n'\nphotos\n'\n);\n8\n9\n$\nresponse\n=\n$\nthis\n->\njson\n(\n'\nPOST\n'\n,\n'\n\/photos\n'\n,\n[\n10\nUploadedFile\n::\nfake\n()\n->\nimage\n(\n'\nphoto1.jpg\n'\n),\n11\nUploadedFile\n::\nfake\n()\n->\nimage\n(\n'\nphoto2.jpg\n'\n)\n12\n]);\n13\n14\n\/\/\nAssert one or more files were stored...\n15\nStorage\n::\ndisk\n(\n'\nphotos\n'\n)\n->\nassertExists\n(\n'\nphoto1.jpg\n'\n);\n16\nStorage\n::\ndisk\n(\n'\nphotos\n'\n)\n->\nassertExists\n([\n'\nphoto1.jpg\n'\n,\n'\nphoto2.jpg\n'\n]);\n17\n18\n\/\/\nAssert one or more files were not stored...\n19\nStorage\n::\ndisk\n(\n'\nphotos\n'\n)\n->\nassertMissing\n(\n'\nmissing.jpg\n'\n);\n20\nStorage\n::\ndisk\n(\n'\nphotos\n'\n)\n->\nassertMissing\n([\n'\nmissing.jpg\n'\n,\n'\nnon-existing.jpg\n'\n]);\n21\n22\n\/\/\nAssert that the number of files in a given directory matches the expected count...\n23\nStorage\n::\ndisk\n(\n'\nphotos\n'\n)\n->\nassertCount\n(\n'\n\/wallpapers\n'\n,\n2\n);\n24\n25\n\/\/\nAssert that a given directory is empty...\n26\nStorage\n::\ndisk\n(\n'\nphotos\n'\n)\n->\nassertDirectoryEmpty\n(\n'\n\/wallpapers\n'\n);\n27\n});\n1\n<?php\n2\n3\nnamespace\nTests\\Feature;\n4\n5\nuse\nIlluminate\\Http\\\nUploadedFile\n;\n6\nuse\nIlluminate\\Support\\Facades\\\nStorage\n;\n7\nuse\nTests\\\nTestCase\n;\n8\n9\nclass\nExampleTest\nextends\nTestCase\n10\n{\n11\npublic\nfunction\ntest_albums_can_be_uploaded\n()\n:\nvoid\n12\n{\n13\nStorage\n::\nfake\n(\n'\nphotos\n'\n);\n14\n15\n$response\n=\n$this\n->\njson\n(\n'\nPOST\n'\n,\n'\n\/photos\n'\n, [\n16\nUploadedFile\n::\nfake\n()\n->\nimage\n(\n'\nphoto1.jpg\n'\n),\n17\nUploadedFile\n::\nfake\n()\n->\nimage\n(\n'\nphoto2.jpg\n'\n)\n18\n]);\n19\n20\n\/\/\nAssert one or more files were stored...\n21\nStorage\n::\ndisk\n(\n'\nphotos\n'\n)\n->\nassertExists\n(\n'\nphoto1.jpg\n'\n);\n22\nStorage\n::\ndisk\n(\n'\nphotos\n'\n)\n->\nassertExists\n([\n'\nphoto1.jpg\n'\n,\n'\nphoto2.jpg\n'\n]);\n23\n24\n\/\/\nAssert one or more files were not stored...\n25\nStorage\n::\ndisk\n(\n'\nphotos\n'\n)\n->\nassertMissing\n(\n'\nmissing.jpg\n'\n);\n26\nStorage\n::\ndisk\n(\n'\nphotos\n'\n)\n->\nassertMissing\n([\n'\nmissing.jpg\n'\n,\n'\nnon-existing.jpg\n'\n]);\n27\n28\n\/\/\nAssert that the number of files in a given directory matches the expected count...\n29\nStorage\n::\ndisk\n(\n'\nphotos\n'\n)\n->\nassertCount\n(\n'\n\/wallpapers\n'\n,\n2\n);\n30\n31\n\/\/\nAssert that a given directory is empty...\n32\nStorage\n::\ndisk\n(\n'\nphotos\n'\n)\n->\nassertDirectoryEmpty\n(\n'\n\/wallpapers\n'\n);\n33\n}\n34\n}\nBy default, the\nfake\nmethod will delete all files in its temporary directory. If you would like to keep these files, you may use the \"persistentFake\" method instead. For more information on testing file uploads, you may consult the\nHTTP testing documentation's information on file uploads\n.\nThe\nimage\nmethod requires the\nGD extension\n.\nCustom Filesystems\nLaravel's Flysystem integration provides support for several \"drivers\" out of the box; however, Flysystem is not limited to these and has adapters for many other storage systems. You can create a custom driver if you want to use one of these additional adapters in your Laravel application.\nIn order to define a custom filesystem you will need a Flysystem adapter. Let's add a community maintained Dropbox adapter to our project:\n1\ncomposer\nrequire\nspatie\/flysystem-dropbox\nNext, you can register the driver within the\nboot\nmethod of one of your application's\nservice providers\n. To accomplish this, you should use the\nextend\nmethod of the\nStorage\nfacade:\n1\n<?php\n2\n3\nnamespace\nApp\\Providers;\n4\n5\nuse\nIlluminate\\Contracts\\Foundation\\\nApplication\n;\n6\nuse\nIlluminate\\Filesystem\\\nFilesystemAdapter\n;\n7\nuse\nIlluminate\\Support\\Facades\\\nStorage\n;\n8\nuse\nIlluminate\\Support\\\nServiceProvider\n;\n9\nuse\nLeague\\Flysystem\\\nFilesystem\n;\n10\nuse\nSpatie\\Dropbox\\\nClient\nas\nDropboxClient;\n11\nuse\nSpatie\\FlysystemDropbox\\\nDropboxAdapter\n;\n12\n13\nclass\nAppServiceProvider\nextends\nServiceProvider\n14\n{\n15\n\/**\n16\n* Register any application services.\n17\n*\/\n18\npublic\nfunction\nregister\n()\n:\nvoid\n19\n{\n20\n\/\/\n...\n21\n}\n22\n23\n\/**\n24\n* Bootstrap any application services.\n25\n*\/\n26\npublic\nfunction\nboot\n()\n:\nvoid\n27\n{\n28\nStorage\n::\nextend\n(\n'\ndropbox\n'\n,\nfunction\n(\nApplication\n$app\n,\narray\n$config\n)\n{\n29\n$adapter\n=\nnew\nDropboxAdapter\n(\nnew\nDropboxClient\n(\n30\n$config\n[\n'\nauthorization_token\n'\n]\n31\n));\n32\n33\nreturn\nnew\nFilesystemAdapter\n(\n34\nnew\nFilesystem\n(\n$adapter\n,\n$config\n),\n35\n$adapter\n,\n36\n$config\n37\n);\n38\n});\n39\n}\n40\n}\nThe first argument of the\nextend\nmethod is the name of the driver and the second is a closure that receives the\n$app\nand\n$config\nvariables. The closure must return an instance of\nIlluminate\\Filesystem\\FilesystemAdapter\n. The\n$config\nvariable contains the values defined in\nconfig\/filesystems.php\nfor the specified disk.\nOnce you have created and registered the extension's service provider, you may use the\ndropbox\ndriver in your\nconfig\/filesystems.php\nconfiguration file.","attrs_markdown":"- [Home](https:\/\/laravel.com\/)\n\nSearch\n\n```K`\n\n⌘K\n\nSwitch to light mode\n\n[Skip to content](https:\/\/laravel.com\/docs\/12.x\/filesystem#main-content)\n\n- ## Prologue\n  - [Release Notes](https:\/\/laravel.com\/docs\/12.x\/releases)\n  - [Upgrade Guide](https:\/\/laravel.com\/docs\/12.x\/upgrade)\n  - [Contribution Guide](https:\/\/laravel.com\/docs\/12.x\/contributions)\n- ## Getting Started\n  - [Installation](https:\/\/laravel.com\/docs\/12.x\/installation)\n  - [Configuration](https:\/\/laravel.com\/docs\/12.x\/configuration)\n  - [Agentic Development](https:\/\/laravel.com\/docs\/12.x\/ai)\n  - [Directory Structure](https:\/\/laravel.com\/docs\/12.x\/structure)\n  - [Frontend](https:\/\/laravel.com\/docs\/12.x\/frontend)\n  - [Starter Kits](https:\/\/laravel.com\/docs\/12.x\/starter-kits)\n  - [Deployment](https:\/\/laravel.com\/docs\/12.x\/deployment)\n- ## Architecture Concepts\n  - [Request Lifecycle](https:\/\/laravel.com\/docs\/12.x\/lifecycle)\n  - [Service Container](https:\/\/laravel.com\/docs\/12.x\/container)\n  - [Service Providers](https:\/\/laravel.com\/docs\/12.x\/providers)\n  - [Facades](https:\/\/laravel.com\/docs\/12.x\/facades)\n- ## The Basics\n  - [Routing](https:\/\/laravel.com\/docs\/12.x\/routing)\n  - [Middleware](https:\/\/laravel.com\/docs\/12.x\/middleware)\n  - [CSRF Protection](https:\/\/laravel.com\/docs\/12.x\/csrf)\n  - [Controllers](https:\/\/laravel.com\/docs\/12.x\/controllers)\n  - [Requests](https:\/\/laravel.com\/docs\/12.x\/requests)\n  - [Responses](https:\/\/laravel.com\/docs\/12.x\/responses)\n  - [Views](https:\/\/laravel.com\/docs\/12.x\/views)\n  - [Blade Templates](https:\/\/laravel.com\/docs\/12.x\/blade)\n  - [Asset Bundling](https:\/\/laravel.com\/docs\/12.x\/vite)\n  - [URL Generation](https:\/\/laravel.com\/docs\/12.x\/urls)\n  - [Session](https:\/\/laravel.com\/docs\/12.x\/session)\n  - [Validation](https:\/\/laravel.com\/docs\/12.x\/validation)\n  - [Error Handling](https:\/\/laravel.com\/docs\/12.x\/errors)\n  - [Logging](https:\/\/laravel.com\/docs\/12.x\/logging)\n- ## Digging Deeper\n  - [Artisan Console](https:\/\/laravel.com\/docs\/12.x\/artisan)\n  - [Broadcasting](https:\/\/laravel.com\/docs\/12.x\/broadcasting)\n  - [Cache](https:\/\/laravel.com\/docs\/12.x\/cache)\n  - [Collections](https:\/\/laravel.com\/docs\/12.x\/collections)\n  - [Concurrency](https:\/\/laravel.com\/docs\/12.x\/concurrency)\n  - [Context](https:\/\/laravel.com\/docs\/12.x\/context)\n  - [Contracts](https:\/\/laravel.com\/docs\/12.x\/contracts)\n  - [Events](https:\/\/laravel.com\/docs\/12.x\/events)\n  - [File Storage](https:\/\/laravel.com\/docs\/12.x\/filesystem)\n  - [Helpers](https:\/\/laravel.com\/docs\/12.x\/helpers)\n  - [HTTP Client](https:\/\/laravel.com\/docs\/12.x\/http-client)\n  - [Localization](https:\/\/laravel.com\/docs\/12.x\/localization)\n  - [Mail](https:\/\/laravel.com\/docs\/12.x\/mail)\n  - [Notifications](https:\/\/laravel.com\/docs\/12.x\/notifications)\n  - [Package Development](https:\/\/laravel.com\/docs\/12.x\/packages)\n  - [Processes](https:\/\/laravel.com\/docs\/12.x\/processes)\n  - [Queues](https:\/\/laravel.com\/docs\/12.x\/queues)\n  - [Rate Limiting](https:\/\/laravel.com\/docs\/12.x\/rate-limiting)\n  - [Search](https:\/\/laravel.com\/docs\/12.x\/search)\n  - [Strings](https:\/\/laravel.com\/docs\/12.x\/strings)\n  - [Task Scheduling](https:\/\/laravel.com\/docs\/12.x\/scheduling)\n- ## Security\n  - [Authentication](https:\/\/laravel.com\/docs\/12.x\/authentication)\n  - [Authorization](https:\/\/laravel.com\/docs\/12.x\/authorization)\n  - [Email Verification](https:\/\/laravel.com\/docs\/12.x\/verification)\n  - [Encryption](https:\/\/laravel.com\/docs\/12.x\/encryption)\n  - [Hashing](https:\/\/laravel.com\/docs\/12.x\/hashing)\n  - [Password Reset](https:\/\/laravel.com\/docs\/12.x\/passwords)\n- ## Database\n  - [Getting Started](https:\/\/laravel.com\/docs\/12.x\/database)\n  - [Query Builder](https:\/\/laravel.com\/docs\/12.x\/queries)\n  - [Pagination](https:\/\/laravel.com\/docs\/12.x\/pagination)\n  - [Migrations](https:\/\/laravel.com\/docs\/12.x\/migrations)\n  - [Seeding](https:\/\/laravel.com\/docs\/12.x\/seeding)\n  - [Redis](https:\/\/laravel.com\/docs\/12.x\/redis)\n  - [MongoDB](https:\/\/laravel.com\/docs\/12.x\/mongodb)\n- ## Eloquent ORM\n  - [Getting Started](https:\/\/laravel.com\/docs\/12.x\/eloquent)\n  - [Relationships](https:\/\/laravel.com\/docs\/12.x\/eloquent-relationships)\n  - [Collections](https:\/\/laravel.com\/docs\/12.x\/eloquent-collections)\n  - [Mutators \/ Casts](https:\/\/laravel.com\/docs\/12.x\/eloquent-mutators)\n  - [API Resources](https:\/\/laravel.com\/docs\/12.x\/eloquent-resources)\n  - [Serialization](https:\/\/laravel.com\/docs\/12.x\/eloquent-serialization)\n  - [Factories](https:\/\/laravel.com\/docs\/12.x\/eloquent-factories)\n- ## AI\n  - [AI SDK](https:\/\/laravel.com\/docs\/12.x\/ai-sdk)\n  - [MCP](https:\/\/laravel.com\/docs\/12.x\/mcp)\n  - [Boost](https:\/\/laravel.com\/docs\/12.x\/boost)\n- ## Testing\n  - [Getting Started](https:\/\/laravel.com\/docs\/12.x\/testing)\n  - [HTTP Tests](https:\/\/laravel.com\/docs\/12.x\/http-tests)\n  - [Console Tests](https:\/\/laravel.com\/docs\/12.x\/console-tests)\n  - [Browser Tests](https:\/\/laravel.com\/docs\/12.x\/dusk)\n  - [Database](https:\/\/laravel.com\/docs\/12.x\/database-testing)\n  - [Mocking](https:\/\/laravel.com\/docs\/12.x\/mocking)\n- ## Packages\n  - [Cashier (Stripe)](https:\/\/laravel.com\/docs\/12.x\/billing)\n  - [Cashier (Paddle)](https:\/\/laravel.com\/docs\/12.x\/cashier-paddle)\n  - [Dusk](https:\/\/laravel.com\/docs\/12.x\/dusk)\n  - [Envoy](https:\/\/laravel.com\/docs\/12.x\/envoy)\n  - [Fortify](https:\/\/laravel.com\/docs\/12.x\/fortify)\n  - [Folio](https:\/\/laravel.com\/docs\/12.x\/folio)\n  - [Homestead](https:\/\/laravel.com\/docs\/12.x\/homestead)\n  - [Horizon](https:\/\/laravel.com\/docs\/12.x\/horizon)\n  - [Mix](https:\/\/laravel.com\/docs\/12.x\/mix)\n  - [Octane](https:\/\/laravel.com\/docs\/12.x\/octane)\n  - [Passport](https:\/\/laravel.com\/docs\/12.x\/passport)\n  - [Pennant](https:\/\/laravel.com\/docs\/12.x\/pennant)\n  - [Pint](https:\/\/laravel.com\/docs\/12.x\/pint)\n  - [Precognition](https:\/\/laravel.com\/docs\/12.x\/precognition)\n  - [Prompts](https:\/\/laravel.com\/docs\/12.x\/prompts)\n  - [Pulse](https:\/\/laravel.com\/docs\/12.x\/pulse)\n  - [Reverb](https:\/\/laravel.com\/docs\/12.x\/reverb)\n  - [Sail](https:\/\/laravel.com\/docs\/12.x\/sail)\n  - [Sanctum](https:\/\/laravel.com\/docs\/12.x\/sanctum)\n  - [Scout](https:\/\/laravel.com\/docs\/12.x\/scout)\n  - [Socialite](https:\/\/laravel.com\/docs\/12.x\/socialite)\n  - [Telescope](https:\/\/laravel.com\/docs\/12.x\/telescope)\n  - [Valet](https:\/\/laravel.com\/docs\/12.x\/valet)\n- ## [API Documentation](https:\/\/api.laravel.com\/docs\/12.x\/index.html)\n- ## [Changelog](https:\/\/laravel.com\/docs\/changelog)\n\n> **WARNING** You're browsing the documentation for an old version of Laravel. Consider upgrading your project to [Laravel 13.x](https:\/\/laravel.com\/docs\/13.x\/filesystem).\n\n# File Storage\n- [Introduction](https:\/\/laravel.com\/docs\/12.x\/filesystem#introduction)\n- [Configuration](https:\/\/laravel.com\/docs\/12.x\/filesystem#configuration)\n  - [The Local Driver](https:\/\/laravel.com\/docs\/12.x\/filesystem#the-local-driver)\n  - [The Public Disk](https:\/\/laravel.com\/docs\/12.x\/filesystem#the-public-disk)\n  - [Driver Prerequisites](https:\/\/laravel.com\/docs\/12.x\/filesystem#driver-prerequisites)\n  - [Scoped and Read-Only Filesystems](https:\/\/laravel.com\/docs\/12.x\/filesystem#scoped-and-read-only-filesystems)\n  - [Amazon S3 Compatible Filesystems](https:\/\/laravel.com\/docs\/12.x\/filesystem#amazon-s3-compatible-filesystems)\n- [Obtaining Disk Instances](https:\/\/laravel.com\/docs\/12.x\/filesystem#obtaining-disk-instances)\n  - [On-Demand Disks](https:\/\/laravel.com\/docs\/12.x\/filesystem#on-demand-disks)\n- [Retrieving Files](https:\/\/laravel.com\/docs\/12.x\/filesystem#retrieving-files)\n  - [Downloading Files](https:\/\/laravel.com\/docs\/12.x\/filesystem#downloading-files)\n  - [File URLs](https:\/\/laravel.com\/docs\/12.x\/filesystem#file-urls)\n  - [Temporary URLs](https:\/\/laravel.com\/docs\/12.x\/filesystem#temporary-urls)\n  - [File Metadata](https:\/\/laravel.com\/docs\/12.x\/filesystem#file-metadata)\n- [Storing Files](https:\/\/laravel.com\/docs\/12.x\/filesystem#storing-files)\n  - [Prepending and Appending To Files](https:\/\/laravel.com\/docs\/12.x\/filesystem#prepending-appending-to-files)\n  - [Copying and Moving Files](https:\/\/laravel.com\/docs\/12.x\/filesystem#copying-moving-files)\n  - [Automatic Streaming](https:\/\/laravel.com\/docs\/12.x\/filesystem#automatic-streaming)\n  - [File Uploads](https:\/\/laravel.com\/docs\/12.x\/filesystem#file-uploads)\n  - [File Visibility](https:\/\/laravel.com\/docs\/12.x\/filesystem#file-visibility)\n- [Deleting Files](https:\/\/laravel.com\/docs\/12.x\/filesystem#deleting-files)\n- [Directories](https:\/\/laravel.com\/docs\/12.x\/filesystem#directories)\n- [Testing](https:\/\/laravel.com\/docs\/12.x\/filesystem#testing)\n- [Custom Filesystems](https:\/\/laravel.com\/docs\/12.x\/filesystem#custom-filesystems)\n## [Introduction](https:\/\/laravel.com\/docs\/12.x\/filesystem#introduction)\nLaravel provides a powerful filesystem abstraction thanks to the wonderful [Flysystem](https:\/\/github.com\/thephpleague\/flysystem) PHP package by Frank de Jonge. The Laravel Flysystem integration provides simple drivers for working with local filesystems, SFTP, and Amazon S3. Even better, it's amazingly simple to switch between these storage options between your local development machine and production server as the API remains the same for each system.\n\n## [Configuration](https:\/\/laravel.com\/docs\/12.x\/filesystem#configuration)\nLaravel's filesystem configuration file is located at `config\/filesystems.php`. Within this file, you may configure all of your filesystem \"disks\". Each disk represents a particular storage driver and storage location. Example configurations for each supported driver are included in the configuration file so you can modify the configuration to reflect your storage preferences and credentials.\n\nThe `local` driver interacts with files stored locally on the server running the Laravel application, while the `sftp` storage driver is used for SSH key-based FTP. The `s3` driver is used to write to Amazon's S3 cloud storage service.\n\nYou may configure as many disks as you like and may even have multiple disks that use the same driver.\n\n### [The Local Driver](https:\/\/laravel.com\/docs\/12.x\/filesystem#the-local-driver)\nWhen using the `local` driver, all file operations are relative to the `root` directory defined in your `filesystems` configuration file. By default, this value is set to the `storage\/app\/private` directory. Therefore, the following method would write to `storage\/app\/private\/example.txt`:\n```\n1use Illuminate\\Support\\Facades\\Storage;23Storage::disk('local')->put('example.txt', 'Contents');use Illuminate\\Support\\Facades\\Storage; Storage::disk('local')->put('example.txt', 'Contents');\n```\n### [The Public Disk](https:\/\/laravel.com\/docs\/12.x\/filesystem#the-public-disk)\nThe `public` disk included in your application's `filesystems` configuration file is intended for files that are going to be publicly accessible. By default, the `public` disk uses the `local` driver and stores its files in `storage\/app\/public`.\n\nIf your `public` disk uses the `local` driver and you want to make these files accessible from the web, you should create a symbolic link from source directory `storage\/app\/public` to target directory `public\/storage`:\n\nTo create the symbolic link, you may use the `storage:link` Artisan command:\n```\n1php artisan storage:linkphp artisan storage:link\n```\nOnce a file has been stored and the symbolic link has been created, you can create a URL to the files using the `asset` helper:\n```\n1echo asset('storage\/file.txt');echo asset('storage\/file.txt');\n```\nYou may configure additional symbolic links in your `filesystems` configuration file. Each of the configured links will be created when you run the `storage:link` command:\n```\n1'links' => [2 public_path('storage') => storage_path('app\/public'),3 public_path('images') => storage_path('app\/images'),4],'links' => [ public_path('storage') => storage_path('app\/public'), public_path('images') => storage_path('app\/images'), ],\n```\nThe `storage:unlink` command may be used to destroy your configured symbolic links:\n```\n1php artisan storage:unlinkphp artisan storage:unlink\n```\n### [Driver Prerequisites](https:\/\/laravel.com\/docs\/12.x\/filesystem#driver-prerequisites)\n#### [S3 Driver Configuration](https:\/\/laravel.com\/docs\/12.x\/filesystem#s3-driver-configuration)\nBefore using the S3 driver, you will need to install the Flysystem S3 package via the Composer package manager:\n```\n1composer require league\/flysystem-aws-s3-v3 \"^3.0\" --with-all-dependenciescomposer require league\/flysystem-aws-s3-v3 \"^3.0\" --with-all-dependencies\n```\nAn S3 disk configuration array is located in your `config\/filesystems.php` configuration file. Typically, you should configure your S3 information and credentials using the following environment variables which are referenced by the `config\/filesystems.php` configuration file:\n```\n1AWS_ACCESS_KEY_ID=<your-key-id>2AWS_SECRET_ACCESS_KEY=<your-secret-access-key>3AWS_DEFAULT_REGION=us-east-14AWS_BUCKET=<your-bucket-name>5AWS_USE_PATH_STYLE_ENDPOINT=falseAWS_ACCESS_KEY_ID=<your-key-id> AWS_SECRET_ACCESS_KEY=<your-secret-access-key> AWS_DEFAULT_REGION=us-east-1 AWS_BUCKET=<your-bucket-name> AWS_USE_PATH_STYLE_ENDPOINT=false\n```\nFor convenience, these environment variables match the naming convention used by the AWS CLI.\n\n#### [FTP Driver Configuration](https:\/\/laravel.com\/docs\/12.x\/filesystem#ftp-driver-configuration)\nBefore using the FTP driver, you will need to install the Flysystem FTP package via the Composer package manager:\n```\n1composer require league\/flysystem-ftp \"^3.0\"composer require league\/flysystem-ftp \"^3.0\"\n```\nLaravel's Flysystem integrations work great with FTP; however, a sample configuration is not included with the framework's default `config\/filesystems.php` configuration file. If you need to configure an FTP filesystem, you may use the configuration example below:\n```\n1'ftp' => [2 'driver' => 'ftp',3 'host' => env('FTP_HOST'),4 'username' => env('FTP_USERNAME'),5 'password' => env('FTP_PASSWORD'),67 \/\/ Optional FTP Settings...8 \/\/ 'port' => env('FTP_PORT', 21),9 \/\/ 'root' => env('FTP_ROOT'),10 \/\/ 'passive' => true,11 \/\/ 'ssl' => true,12 \/\/ 'timeout' => 30,13],'ftp' => [ 'driver' => 'ftp', 'host' => env('FTP_HOST'), 'username' => env('FTP_USERNAME'), 'password' => env('FTP_PASSWORD'), \/\/ Optional FTP Settings... \/\/ 'port' => env('FTP_PORT', 21), \/\/ 'root' => env('FTP_ROOT'), \/\/ 'passive' => true, \/\/ 'ssl' => true, \/\/ 'timeout' => 30, ],\n```\n#### [SFTP Driver Configuration](https:\/\/laravel.com\/docs\/12.x\/filesystem#sftp-driver-configuration)\nBefore using the SFTP driver, you will need to install the Flysystem SFTP package via the Composer package manager:\n```\n1composer require league\/flysystem-sftp-v3 \"^3.0\"composer require league\/flysystem-sftp-v3 \"^3.0\"\n```\nLaravel's Flysystem integrations work great with SFTP; however, a sample configuration is not included with the framework's default `config\/filesystems.php` configuration file. If you need to configure an SFTP filesystem, you may use the configuration example below:\n```\n1'sftp' => [2 'driver' => 'sftp',3 'host' => env('SFTP_HOST'),45 \/\/ Settings for basic authentication...6 'username' => env('SFTP_USERNAME'),7 'password' => env('SFTP_PASSWORD'),89 \/\/ Settings for SSH key-based authentication with encryption password...10 'privateKey' => env('SFTP_PRIVATE_KEY'),11 'passphrase' => env('SFTP_PASSPHRASE'),1213 \/\/ Settings for file \/ directory permissions...14 'visibility' => 'private', \/\/ `private` = 0600, `public` = 064415 'directory_visibility' => 'private', \/\/ `private` = 0700, `public` = 07551617 \/\/ Optional SFTP Settings...18 \/\/ 'hostFingerprint' => env('SFTP_HOST_FINGERPRINT'),19 \/\/ 'maxTries' => 4,20 \/\/ 'passphrase' => env('SFTP_PASSPHRASE'),21 \/\/ 'port' => env('SFTP_PORT', 22),22 \/\/ 'root' => env('SFTP_ROOT', ''),23 \/\/ 'timeout' => 30,24 \/\/ 'useAgent' => true,25],'sftp' => [ 'driver' => 'sftp', 'host' => env('SFTP_HOST'), \/\/ Settings for basic authentication... 'username' => env('SFTP_USERNAME'), 'password' => env('SFTP_PASSWORD'), \/\/ Settings for SSH key-based authentication with encryption password... 'privateKey' => env('SFTP_PRIVATE_KEY'), 'passphrase' => env('SFTP_PASSPHRASE'), \/\/ Settings for file \/ directory permissions... 'visibility' => 'private', \/\/ `private` = 0600, `public` = 0644 'directory_visibility' => 'private', \/\/ `private` = 0700, `public` = 0755 \/\/ Optional SFTP Settings... \/\/ 'hostFingerprint' => env('SFTP_HOST_FINGERPRINT'), \/\/ 'maxTries' => 4, \/\/ 'passphrase' => env('SFTP_PASSPHRASE'), \/\/ 'port' => env('SFTP_PORT', 22), \/\/ 'root' => env('SFTP_ROOT', ''), \/\/ 'timeout' => 30, \/\/ 'useAgent' => true, ],\n```\n### [Scoped and Read-Only Filesystems](https:\/\/laravel.com\/docs\/12.x\/filesystem#scoped-and-read-only-filesystems)\nScoped disks allow you to define a filesystem where all paths are automatically prefixed with a given path prefix. Before creating a scoped filesystem disk, you will need to install an additional Flysystem package via the Composer package manager:\n```\n1composer require league\/flysystem-path-prefixing \"^3.0\"composer require league\/flysystem-path-prefixing \"^3.0\"\n```\nYou may create a path scoped instance of any existing filesystem disk by defining a disk that utilizes the `scoped` driver. For example, you may create a disk which scopes your existing `s3` disk to a specific path prefix, and then every file operation using your scoped disk will utilize the specified prefix:\n```\n1's3-videos' => [2 'driver' => 'scoped',3 'disk' => 's3',4 'prefix' => 'path\/to\/videos',5],'s3-videos' => [ 'driver' => 'scoped', 'disk' => 's3', 'prefix' => 'path\/to\/videos', ],\n```\n\"Read-only\" disks allow you to create filesystem disks that do not allow write operations. Before using the `read-only` configuration option, you will need to install an additional Flysystem package via the Composer package manager:\n```\n1composer require league\/flysystem-read-only \"^3.0\"composer require league\/flysystem-read-only \"^3.0\"\n```\nNext, you may include the `read-only` configuration option in one or more of your disk's configuration arrays:\n```\n1's3-videos' => [2 'driver' => 's3',3 \/\/ ...4 'read-only' => true,5],'s3-videos' => [ 'driver' => 's3', \/\/ ... 'read-only' => true, ],\n```\n### [Amazon S3 Compatible Filesystems](https:\/\/laravel.com\/docs\/12.x\/filesystem#amazon-s3-compatible-filesystems)\nBy default, your application's `filesystems` configuration file contains a disk configuration for the `s3` disk. In addition to using this disk to interact with [Amazon S3](https:\/\/aws.amazon.com\/s3\/), you may use it to interact with any S3-compatible file storage service such as [RustFS](https:\/\/github.com\/rustfs\/rustfs), [DigitalOcean Spaces](https:\/\/www.digitalocean.com\/products\/spaces\/), [Vultr Object Storage](https:\/\/www.vultr.com\/products\/object-storage\/), [Cloudflare R2](https:\/\/www.cloudflare.com\/developer-platform\/products\/r2\/), or [Hetzner Cloud Storage](https:\/\/www.hetzner.com\/storage\/object-storage\/).\n\nTypically, after updating the disk's credentials to match the credentials of the service you are planning to use, you only need to update the value of the `endpoint` configuration option. This option's value is typically defined via the `AWS_ENDPOINT` environment variable:\n```\n1'endpoint' => env('AWS_ENDPOINT', 'https:\/\/rustfs:9000'),'endpoint' => env('AWS_ENDPOINT', 'https:\/\/rustfs:9000'),\n```\n## [Obtaining Disk Instances](https:\/\/laravel.com\/docs\/12.x\/filesystem#obtaining-disk-instances)\nThe `Storage` facade may be used to interact with any of your configured disks. For example, you may use the `put` method on the facade to store an avatar on the default disk. If you call methods on the `Storage` facade without first calling the `disk` method, the method will automatically be passed to the default disk:\n```\n1use Illuminate\\Support\\Facades\\Storage;23Storage::put('avatars\/1', $content);use Illuminate\\Support\\Facades\\Storage; Storage::put('avatars\/1', $content);\n```\nIf your application interacts with multiple disks, you may use the `disk` method on the `Storage` facade to work with files on a particular disk:\n```\n1Storage::disk('s3')->put('avatars\/1', $content);Storage::disk('s3')->put('avatars\/1', $content);\n```\n### [On-Demand Disks](https:\/\/laravel.com\/docs\/12.x\/filesystem#on-demand-disks)\nSometimes you may wish to create a disk at runtime using a given configuration without that configuration actually being present in your application's `filesystems` configuration file. To accomplish this, you may pass a configuration array to the `Storage` facade's `build` method:\n```\n1use Illuminate\\Support\\Facades\\Storage;23$disk = Storage::build([4 'driver' => 'local',5 'root' => '\/path\/to\/root',6]);78$disk->put('image.jpg', $content);use Illuminate\\Support\\Facades\\Storage; $disk = Storage::build([ 'driver' => 'local', 'root' => '\/path\/to\/root', ]); $disk->put('image.jpg', $content);\n```\n## [Retrieving Files](https:\/\/laravel.com\/docs\/12.x\/filesystem#retrieving-files)\nThe `get` method may be used to retrieve the contents of a file. The raw string contents of the file will be returned by the method. Remember, all file paths should be specified relative to the disk's \"root\" location:\n```\n1$contents = Storage::get('file.jpg');$contents = Storage::get('file.jpg');\n```\nIf the file you are retrieving contains JSON, you may use the `json` method to retrieve the file and decode its contents:\n```\n1$orders = Storage::json('orders.json');$orders = Storage::json('orders.json');\n```\nThe `exists` method may be used to determine if a file exists on the disk:\n```\n1if (Storage::disk('s3')->exists('file.jpg')) {2 \/\/ ...3}if (Storage::disk('s3')->exists('file.jpg')) { \/\/ ... }\n```\nThe `missing` method may be used to determine if a file is missing from the disk:\n```\n1if (Storage::disk('s3')->missing('file.jpg')) {2 \/\/ ...3}if (Storage::disk('s3')->missing('file.jpg')) { \/\/ ... }\n```\n### [Downloading Files](https:\/\/laravel.com\/docs\/12.x\/filesystem#downloading-files)\nThe `download` method may be used to generate a response that forces the user's browser to download the file at the given path. The `download` method accepts a filename as the second argument to the method, which will determine the filename that is seen by the user downloading the file. Finally, you may pass an array of HTTP headers as the third argument to the method:\n```\n1return Storage::download('file.jpg');23return Storage::download('file.jpg', $name, $headers);return Storage::download('file.jpg'); return Storage::download('file.jpg', $name, $headers);\n```\n### [File URLs](https:\/\/laravel.com\/docs\/12.x\/filesystem#file-urls)\nYou may use the `url` method to get the URL for a given file. If you are using the `local` driver, this will typically just prepend `\/storage` to the given path and return a relative URL to the file. If you are using the `s3` driver, the fully qualified remote URL will be returned:\n```\n1use Illuminate\\Support\\Facades\\Storage;23$url = Storage::url('file.jpg');use Illuminate\\Support\\Facades\\Storage; $url = Storage::url('file.jpg');\n```\nWhen using the `local` driver, all files that should be publicly accessible should be placed in the `storage\/app\/public` directory. Furthermore, you should [create a symbolic link](https:\/\/laravel.com\/docs\/12.x\/filesystem#the-public-disk) at `public\/storage` which points to the `storage\/app\/public` directory.\n\nWhen using the `local` driver, the return value of `url` is not URL encoded. For this reason, we recommend always storing your files using names that will create valid URLs.\n\n#### [URL Host Customization](https:\/\/laravel.com\/docs\/12.x\/filesystem#url-host-customization)\nIf you would like to modify the host for URLs generated using the `Storage` facade, you may add or change the `url` option in the disk's configuration array:\n```\n1'public' => [2 'driver' => 'local',3 'root' => storage_path('app\/public'),4 'url' => env('APP_URL').'\/storage',5 'visibility' => 'public',6 'throw' => false,7],'public' => [ 'driver' => 'local', 'root' => storage_path('app\/public'), 'url' => env('APP_URL').'\/storage', 'visibility' => 'public', 'throw' => false, ],\n```\n### [Temporary URLs](https:\/\/laravel.com\/docs\/12.x\/filesystem#temporary-urls)\nUsing the `temporaryUrl` method, you may create temporary URLs to files stored using the `local` and `s3` drivers. This method accepts a path and a `DateTime` instance specifying when the URL should expire:\n```\n1use Illuminate\\Support\\Facades\\Storage;23$url = Storage::temporaryUrl(4 'file.jpg', now()->plus(minutes: 5)5);use Illuminate\\Support\\Facades\\Storage; $url = Storage::temporaryUrl( 'file.jpg', now()->plus(minutes: 5) );\n```\n#### [Enabling Local Temporary URLs](https:\/\/laravel.com\/docs\/12.x\/filesystem#enabling-local-temporary-urls)\nIf you started developing your application before support for temporary URLs was introduced to the `local` driver, you may need to enable local temporary URLs. To do so, add the `serve` option to your `local` disk's configuration array within the `config\/filesystems.php` configuration file:\n```\n1'local' => [2 'driver' => 'local',3 'root' => storage_path('app\/private'),4 'serve' => true,5 'throw' => false,6],'local' => [ 'driver' => 'local', 'root' => storage_path('app\/private'), 'serve' => true, 'throw' => false, ],\n```\n#### [S3 Request Parameters](https:\/\/laravel.com\/docs\/12.x\/filesystem#s3-request-parameters)\nIf you need to specify additional [S3 request parameters](https:\/\/docs.aws.amazon.com\/AmazonS3\/latest\/API\/RESTObjectGET.html#RESTObjectGET-requests), you may pass the array of request parameters as the third argument to the `temporaryUrl` method:\n```\n1$url = Storage::temporaryUrl(2 'file.jpg',3 now()->plus(minutes: 5),4 [5 'ResponseContentType' => 'application\/octet-stream',6 'ResponseContentDisposition' => 'attachment; filename=file2.jpg',7 ]8);$url = Storage::temporaryUrl( 'file.jpg', now()->plus(minutes: 5), [ 'ResponseContentType' => 'application\/octet-stream', 'ResponseContentDisposition' => 'attachment; filename=file2.jpg', ] );\n```\n#### [Customizing Temporary URLs](https:\/\/laravel.com\/docs\/12.x\/filesystem#customizing-temporary-urls)\nIf you need to customize how temporary URLs are created for a specific storage disk, you can use the `buildTemporaryUrlsUsing` method. For example, this can be useful if you have a controller that allows you to download files stored via a disk that doesn't typically support temporary URLs. Usually, this method should be called from the `boot` method of a service provider:\n```\n1<?php23namespace App\\Providers;45use DateTime;6use Illuminate\\Support\\Facades\\Storage;7use Illuminate\\Support\\Facades\\URL;8use Illuminate\\Support\\ServiceProvider;910class AppServiceProvider extends ServiceProvider11{12 \/**13 * Bootstrap any application services.14 *\/15 public function boot(): void16 {17 Storage::disk('local')->buildTemporaryUrlsUsing(18 function (string $path, DateTime $expiration, array $options) {19 return URL::temporarySignedRoute(20 'files.download',21 $expiration,22 array_merge($options, ['path' => $path])23 );24 }25 );26 }27}<?php namespace App\\Providers; use DateTime; use Illuminate\\Support\\Facades\\Storage; use Illuminate\\Support\\Facades\\URL; use Illuminate\\Support\\ServiceProvider; class AppServiceProvider extends ServiceProvider { \/** * Bootstrap any application services. *\/ public function boot(): void { Storage::disk('local')->buildTemporaryUrlsUsing( function (string $path, DateTime $expiration, array $options) { return URL::temporarySignedRoute( 'files.download', $expiration, array_merge($options, ['path' => $path]) ); } ); } }\n```\n#### [Temporary Upload URLs](https:\/\/laravel.com\/docs\/12.x\/filesystem#temporary-upload-urls)\nThe ability to generate temporary upload URLs is only supported by the `s3` and `local` drivers.\n\nIf you need to generate a temporary URL that can be used to upload a file directly from your client-side application, you may use the `temporaryUploadUrl` method. This method accepts a path and a `DateTime` instance specifying when the URL should expire. The `temporaryUploadUrl` method returns an associative array which may be destructured into the upload URL and the headers that should be included with the upload request:\n```\n1use Illuminate\\Support\\Facades\\Storage;23['url' => $url, 'headers' => $headers] = Storage::temporaryUploadUrl(4 'file.jpg', now()->plus(minutes: 5)5);use Illuminate\\Support\\Facades\\Storage; ['url' => $url, 'headers' => $headers] = Storage::temporaryUploadUrl( 'file.jpg', now()->plus(minutes: 5) );\n```\nThis method is primarily useful in serverless environments that require the client-side application to directly upload files to a cloud storage system such as Amazon S3.\n\n### [File Metadata](https:\/\/laravel.com\/docs\/12.x\/filesystem#file-metadata)\nIn addition to reading and writing files, Laravel can also provide information about the files themselves. For example, the `size` method may be used to get the size of a file in bytes:\n```\n1use Illuminate\\Support\\Facades\\Storage;23$size = Storage::size('file.jpg');use Illuminate\\Support\\Facades\\Storage; $size = Storage::size('file.jpg');\n```\nThe `lastModified` method returns the UNIX timestamp of the last time the file was modified:\n```\n1$time = Storage::lastModified('file.jpg');$time = Storage::lastModified('file.jpg');\n```\nThe MIME type of a given file may be obtained via the `mimeType` method:\n```\n1$mime = Storage::mimeType('file.jpg');$mime = Storage::mimeType('file.jpg');\n```\n#### [File Paths](https:\/\/laravel.com\/docs\/12.x\/filesystem#file-paths)\nYou may use the `path` method to get the path for a given file. If you are using the `local` driver, this will return the absolute path to the file. If you are using the `s3` driver, this method will return the relative path to the file in the S3 bucket:\n```\n1use Illuminate\\Support\\Facades\\Storage;23$path = Storage::path('file.jpg');use Illuminate\\Support\\Facades\\Storage; $path = Storage::path('file.jpg');\n```\n## [Storing Files](https:\/\/laravel.com\/docs\/12.x\/filesystem#storing-files)\nThe `put` method may be used to store file contents on a disk. You may also pass a PHP `resource` to the `put` method, which will use Flysystem's underlying stream support. Remember, all file paths should be specified relative to the \"root\" location configured for the disk:\n```\n1use Illuminate\\Support\\Facades\\Storage;23Storage::put('file.jpg', $contents);45Storage::put('file.jpg', $resource);use Illuminate\\Support\\Facades\\Storage; Storage::put('file.jpg', $contents); Storage::put('file.jpg', $resource);\n```\n#### [Failed Writes](https:\/\/laravel.com\/docs\/12.x\/filesystem#failed-writes)\nIf the `put` method (or other \"write\" operations) is unable to write the file to disk, `false` will be returned:\n```\n1if (! Storage::put('file.jpg', $contents)) {2 \/\/ The file could not be written to disk...3}if (! Storage::put('file.jpg', $contents)) { \/\/ The file could not be written to disk... }\n```\nIf you wish, you may define the `throw` option within your filesystem disk's configuration array. When this option is defined as `true`, \"write\" methods such as `put` will throw an instance of `League\\Flysystem\\UnableToWriteFile` when write operations fail:\n```\n1'public' => [2 'driver' => 'local',3 \/\/ ...4 'throw' => true,5],'public' => [ 'driver' => 'local', \/\/ ... 'throw' => true, ],\n```\n### [Prepending and Appending To Files](https:\/\/laravel.com\/docs\/12.x\/filesystem#prepending-appending-to-files)\nThe `prepend` and `append` methods allow you to write to the beginning or end of a file:\n```\n1Storage::prepend('file.log', 'Prepended Text');23Storage::append('file.log', 'Appended Text');Storage::prepend('file.log', 'Prepended Text'); Storage::append('file.log', 'Appended Text');\n```\n### [Copying and Moving Files](https:\/\/laravel.com\/docs\/12.x\/filesystem#copying-moving-files)\nThe `copy` method may be used to copy an existing file to a new location on the disk, while the `move` method may be used to rename or move an existing file to a new location:\n```\n1Storage::copy('old\/file.jpg', 'new\/file.jpg');23Storage::move('old\/file.jpg', 'new\/file.jpg');Storage::copy('old\/file.jpg', 'new\/file.jpg'); Storage::move('old\/file.jpg', 'new\/file.jpg');\n```\n### [Automatic Streaming](https:\/\/laravel.com\/docs\/12.x\/filesystem#automatic-streaming)\nStreaming files to storage offers significantly reduced memory usage. If you would like Laravel to automatically manage streaming a given file to your storage location, you may use the `putFile` or `putFileAs` method. This method accepts either an `Illuminate\\Http\\File` or `Illuminate\\Http\\UploadedFile` instance and will automatically stream the file to your desired location:\n```\n1use Illuminate\\Http\\File;2use Illuminate\\Support\\Facades\\Storage;34\/\/ Automatically generate a unique ID for filename...5$path = Storage::putFile('photos', new File('\/path\/to\/photo'));67\/\/ Manually specify a filename...8$path = Storage::putFileAs('photos', new File('\/path\/to\/photo'), 'photo.jpg');use Illuminate\\Http\\File; use Illuminate\\Support\\Facades\\Storage; \/\/ Automatically generate a unique ID for filename... $path = Storage::putFile('photos', new File('\/path\/to\/photo')); \/\/ Manually specify a filename... $path = Storage::putFileAs('photos', new File('\/path\/to\/photo'), 'photo.jpg');\n```\nThere are a few important things to note about the `putFile` method. Note that we only specified a directory name and not a filename. By default, the `putFile` method will generate a unique ID to serve as the filename. The file's extension will be determined by examining the file's MIME type. The path to the file will be returned by the `putFile` method so you can store the path, including the generated filename, in your database.\n\nThe `putFile` and `putFileAs` methods also accept an argument to specify the \"visibility\" of the stored file. This is particularly useful if you are storing the file on a cloud disk such as Amazon S3 and would like the file to be publicly accessible via generated URLs:\n```\n1Storage::putFile('photos', new File('\/path\/to\/photo'), 'public');Storage::putFile('photos', new File('\/path\/to\/photo'), 'public');\n```\n### [File Uploads](https:\/\/laravel.com\/docs\/12.x\/filesystem#file-uploads)\nIn web applications, one of the most common use-cases for storing files is storing user uploaded files such as photos and documents. Laravel makes it very easy to store uploaded files using the `store` method on an uploaded file instance. Call the `store` method with the path at which you wish to store the uploaded file:\n```\n1<?php23namespace App\\Http\\Controllers;45use Illuminate\\Http\\Request;67class UserAvatarController extends Controller8{9 \/**10 * Update the avatar for the user.11 *\/12 public function update(Request $request): string13 {14 $path = $request->file('avatar')->store('avatars');1516 return $path;17 }18}<?php namespace App\\Http\\Controllers; use Illuminate\\Http\\Request; class UserAvatarController extends Controller { \/** * Update the avatar for the user. *\/ public function update(Request $request): string { $path = $request->file('avatar')->store('avatars'); return $path; } }\n```\nThere are a few important things to note about this example. Note that we only specified a directory name, not a filename. By default, the `store` method will generate a unique ID to serve as the filename. The file's extension will be determined by examining the file's MIME type. The path to the file will be returned by the `store` method so you can store the path, including the generated filename, in your database.\n\nYou may also call the `putFile` method on the `Storage` facade to perform the same file storage operation as the example above:\n```\n1$path = Storage::putFile('avatars', $request->file('avatar'));$path = Storage::putFile('avatars', $request->file('avatar'));\n```\n#### [Specifying a File Name](https:\/\/laravel.com\/docs\/12.x\/filesystem#specifying-a-file-name)\nIf you do not want a filename to be automatically assigned to your stored file, you may use the `storeAs` method, which receives the path, the filename, and the (optional) disk as its arguments:\n```\n1$path = $request->file('avatar')->storeAs(2 'avatars', $request->user()->id3);$path = $request->file('avatar')->storeAs( 'avatars', $request->user()->id );\n```\nYou may also use the `putFileAs` method on the `Storage` facade, which will perform the same file storage operation as the example above:\n```\n1$path = Storage::putFileAs(2 'avatars', $request->file('avatar'), $request->user()->id3);$path = Storage::putFileAs( 'avatars', $request->file('avatar'), $request->user()->id );\n```\nUnprintable and invalid unicode characters will automatically be removed from file paths. Therefore, you may wish to sanitize your file paths before passing them to Laravel's file storage methods. File paths are normalized using the `League\\Flysystem\\WhitespacePathNormalizer::normalizePath` method.\n\n#### [Specifying a Disk](https:\/\/laravel.com\/docs\/12.x\/filesystem#specifying-a-disk)\nBy default, this uploaded file's `store` method will use your default disk. If you would like to specify another disk, pass the disk name as the second argument to the `store` method:\n```\n1$path = $request->file('avatar')->store(2 'avatars\/'.$request->user()->id, 's3'3);$path = $request->file('avatar')->store( 'avatars\/'.$request->user()->id, 's3' );\n```\nIf you are using the `storeAs` method, you may pass the disk name as the third argument to the method:\n```\n1$path = $request->file('avatar')->storeAs(2 'avatars',3 $request->user()->id,4 's3'5);$path = $request->file('avatar')->storeAs( 'avatars', $request->user()->id, 's3' );\n```\n#### [Other Uploaded File Information](https:\/\/laravel.com\/docs\/12.x\/filesystem#other-uploaded-file-information)\nIf you would like to get the original name and extension of the uploaded file, you may do so using the `getClientOriginalName` and `getClientOriginalExtension` methods:\n```\n1$file = $request->file('avatar');23$name = $file->getClientOriginalName();4$extension = $file->getClientOriginalExtension();$file = $request->file('avatar'); $name = $file->getClientOriginalName(); $extension = $file->getClientOriginalExtension();\n```\nHowever, keep in mind that the `getClientOriginalName` and `getClientOriginalExtension` methods are considered unsafe, as the file name and extension may be tampered with by a malicious user. For this reason, you should typically prefer the `hashName` and `extension` methods to get a name and an extension for the given file upload:\n```\n1$file = $request->file('avatar');23$name = $file->hashName(); \/\/ Generate a unique, random name...4$extension = $file->extension(); \/\/ Determine the file's extension based on the file's MIME type...$file = $request->file('avatar'); $name = $file->hashName(); \/\/ Generate a unique, random name... $extension = $file->extension(); \/\/ Determine the file's extension based on the file's MIME type...\n```\n### [File Visibility](https:\/\/laravel.com\/docs\/12.x\/filesystem#file-visibility)\nIn Laravel's Flysystem integration, \"visibility\" is an abstraction of file permissions across multiple platforms. Files may either be declared `public` or `private`. When a file is declared `public`, you are indicating that the file should generally be accessible to others. For example, when using the S3 driver, you may retrieve URLs for `public` files.\n\nYou can set the visibility when writing the file via the `put` method:\n```\n1use Illuminate\\Support\\Facades\\Storage;23Storage::put('file.jpg', $contents, 'public');use Illuminate\\Support\\Facades\\Storage; Storage::put('file.jpg', $contents, 'public');\n```\nIf the file has already been stored, its visibility can be retrieved and set via the `getVisibility` and `setVisibility` methods:\n```\n1$visibility = Storage::getVisibility('file.jpg');23Storage::setVisibility('file.jpg', 'public');$visibility = Storage::getVisibility('file.jpg'); Storage::setVisibility('file.jpg', 'public');\n```\nWhen interacting with uploaded files, you may use the `storePublicly` and `storePubliclyAs` methods to store the uploaded file with `public` visibility:\n```\n1$path = $request->file('avatar')->storePublicly('avatars', 's3');23$path = $request->file('avatar')->storePubliclyAs(4 'avatars',5 $request->user()->id,6 's3'7);$path = $request->file('avatar')->storePublicly('avatars', 's3'); $path = $request->file('avatar')->storePubliclyAs( 'avatars', $request->user()->id, 's3' );\n```\n#### [Local Files and Visibility](https:\/\/laravel.com\/docs\/12.x\/filesystem#local-files-and-visibility)\nWhen using the `local` driver, `public` [visibility](https:\/\/laravel.com\/docs\/12.x\/filesystem#file-visibility) translates to `0755` permissions for directories and `0644` permissions for files. You can modify the permissions mappings in your application's `filesystems` configuration file:\n```\n1'local' => [2 'driver' => 'local',3 'root' => storage_path('app'),4 'permissions' => [5 'file' => [6 'public' => 0644,7 'private' => 0600,8 ],9 'dir' => [10 'public' => 0755,11 'private' => 0700,12 ],13 ],14 'throw' => false,15],'local' => [ 'driver' => 'local', 'root' => storage_path('app'), 'permissions' => [ 'file' => [ 'public' => 0644, 'private' => 0600, ], 'dir' => [ 'public' => 0755, 'private' => 0700, ], ], 'throw' => false, ],\n```\n## [Deleting Files](https:\/\/laravel.com\/docs\/12.x\/filesystem#deleting-files)\nThe `delete` method accepts a single filename or an array of files to delete:\n```\n1use Illuminate\\Support\\Facades\\Storage;23Storage::delete('file.jpg');45Storage::delete(['file.jpg', 'file2.jpg']);use Illuminate\\Support\\Facades\\Storage; Storage::delete('file.jpg'); Storage::delete(['file.jpg', 'file2.jpg']);\n```\nIf necessary, you may specify the disk that the file should be deleted from:\n```\n1use Illuminate\\Support\\Facades\\Storage;23Storage::disk('s3')->delete('path\/file.jpg');use Illuminate\\Support\\Facades\\Storage; Storage::disk('s3')->delete('path\/file.jpg');\n```\n## [Directories](https:\/\/laravel.com\/docs\/12.x\/filesystem#directories)\n#### [Get All Files Within a Directory](https:\/\/laravel.com\/docs\/12.x\/filesystem#get-all-files-within-a-directory)\nThe `files` method returns an array of all files within a given directory. If you would like to retrieve a list of all files within a given directory including subdirectories, you may use the `allFiles` method:\n```\n1use Illuminate\\Support\\Facades\\Storage;23$files = Storage::files($directory);45$files = Storage::allFiles($directory);use Illuminate\\Support\\Facades\\Storage; $files = Storage::files($directory); $files = Storage::allFiles($directory);\n```\n#### [Get All Directories Within a Directory](https:\/\/laravel.com\/docs\/12.x\/filesystem#get-all-directories-within-a-directory)\nThe `directories` method returns an array of all directories within a given directory. If you would like to retrieve a list of all directories within a given directory including subdirectories, you may use the `allDirectories` method:\n```\n1$directories = Storage::directories($directory);23$directories = Storage::allDirectories($directory);$directories = Storage::directories($directory); $directories = Storage::allDirectories($directory);\n```\n#### [Create a Directory](https:\/\/laravel.com\/docs\/12.x\/filesystem#create-a-directory)\nThe `makeDirectory` method will create the given directory, including any needed subdirectories:\n```\n1Storage::makeDirectory($directory);Storage::makeDirectory($directory);\n```\n#### [Delete a Directory](https:\/\/laravel.com\/docs\/12.x\/filesystem#delete-a-directory)\nFinally, the `deleteDirectory` method may be used to remove a directory and all of its files:\n```\n1Storage::deleteDirectory($directory);Storage::deleteDirectory($directory);\n```\n## [Testing](https:\/\/laravel.com\/docs\/12.x\/filesystem#testing)\nThe `Storage` facade's `fake` method allows you to easily generate a fake disk that, combined with the file generation utilities of the `Illuminate\\Http\\UploadedFile` class, greatly simplifies the testing of file uploads. For example:\n\nPest\n\nPHPUnit\n\n```\n1<?php23use Illuminate\\Http\\UploadedFile;4use Illuminate\\Support\\Facades\\Storage;56test('albums can be uploaded', function () {7 Storage::fake('photos');89 $response = $this->json('POST', '\/photos', [10 UploadedFile::fake()->image('photo1.jpg'),11 UploadedFile::fake()->image('photo2.jpg')12 ]);1314 \/\/ Assert one or more files were stored...15 Storage::disk('photos')->assertExists('photo1.jpg');16 Storage::disk('photos')->assertExists(['photo1.jpg', 'photo2.jpg']);1718 \/\/ Assert one or more files were not stored...19 Storage::disk('photos')->assertMissing('missing.jpg');20 Storage::disk('photos')->assertMissing(['missing.jpg', 'non-existing.jpg']);2122 \/\/ Assert that the number of files in a given directory matches the expected count...23 Storage::disk('photos')->assertCount('\/wallpapers', 2);2425 \/\/ Assert that a given directory is empty...26 Storage::disk('photos')->assertDirectoryEmpty('\/wallpapers');27});<?php use Illuminate\\Http\\UploadedFile; use Illuminate\\Support\\Facades\\Storage; test('albums can be uploaded', function () { Storage::fake('photos'); $response = $this->json('POST', '\/photos', [ UploadedFile::fake()->image('photo1.jpg'), UploadedFile::fake()->image('photo2.jpg') ]); \/\/ Assert one or more files were stored... Storage::disk('photos')->assertExists('photo1.jpg'); Storage::disk('photos')->assertExists(['photo1.jpg', 'photo2.jpg']); \/\/ Assert one or more files were not stored... Storage::disk('photos')->assertMissing('missing.jpg'); Storage::disk('photos')->assertMissing(['missing.jpg', 'non-existing.jpg']); \/\/ Assert that the number of files in a given directory matches the expected count... Storage::disk('photos')->assertCount('\/wallpapers', 2); \/\/ Assert that a given directory is empty... Storage::disk('photos')->assertDirectoryEmpty('\/wallpapers'); });\n```\n```\n1<?php23namespace Tests\\Feature;45use Illuminate\\Http\\UploadedFile;6use Illuminate\\Support\\Facades\\Storage;7use Tests\\TestCase;89class ExampleTest extends TestCase10{11 public function test_albums_can_be_uploaded(): void12 {13 Storage::fake('photos');1415 $response = $this->json('POST', '\/photos', [16 UploadedFile::fake()->image('photo1.jpg'),17 UploadedFile::fake()->image('photo2.jpg')18 ]);1920 \/\/ Assert one or more files were stored...21 Storage::disk('photos')->assertExists('photo1.jpg');22 Storage::disk('photos')->assertExists(['photo1.jpg', 'photo2.jpg']);2324 \/\/ Assert one or more files were not stored...25 Storage::disk('photos')->assertMissing('missing.jpg');26 Storage::disk('photos')->assertMissing(['missing.jpg', 'non-existing.jpg']);2728 \/\/ Assert that the number of files in a given directory matches the expected count...29 Storage::disk('photos')->assertCount('\/wallpapers', 2);3031 \/\/ Assert that a given directory is empty...32 Storage::disk('photos')->assertDirectoryEmpty('\/wallpapers');33 }34}<?php namespace Tests\\Feature; use Illuminate\\Http\\UploadedFile; use Illuminate\\Support\\Facades\\Storage; use Tests\\TestCase; class ExampleTest extends TestCase { public function test_albums_can_be_uploaded(): void { Storage::fake('photos'); $response = $this->json('POST', '\/photos', [ UploadedFile::fake()->image('photo1.jpg'), UploadedFile::fake()->image('photo2.jpg') ]); \/\/ Assert one or more files were stored... Storage::disk('photos')->assertExists('photo1.jpg'); Storage::disk('photos')->assertExists(['photo1.jpg', 'photo2.jpg']); \/\/ Assert one or more files were not stored... Storage::disk('photos')->assertMissing('missing.jpg'); Storage::disk('photos')->assertMissing(['missing.jpg', 'non-existing.jpg']); \/\/ Assert that the number of files in a given directory matches the expected count... Storage::disk('photos')->assertCount('\/wallpapers', 2); \/\/ Assert that a given directory is empty... Storage::disk('photos')->assertDirectoryEmpty('\/wallpapers'); } }\n```\n\nBy default, the `fake` method will delete all files in its temporary directory. If you would like to keep these files, you may use the \"persistentFake\" method instead. For more information on testing file uploads, you may consult the [HTTP testing documentation's information on file uploads](https:\/\/laravel.com\/docs\/12.x\/http-tests#testing-file-uploads).\n\nThe `image` method requires the [GD extension](https:\/\/www.php.net\/manual\/en\/book.image.php).\n\n## [Custom Filesystems](https:\/\/laravel.com\/docs\/12.x\/filesystem#custom-filesystems)\nLaravel's Flysystem integration provides support for several \"drivers\" out of the box; however, Flysystem is not limited to these and has adapters for many other storage systems. You can create a custom driver if you want to use one of these additional adapters in your Laravel application.\n\nIn order to define a custom filesystem you will need a Flysystem adapter. Let's add a community maintained Dropbox adapter to our project:\n```\n1composer require spatie\/flysystem-dropboxcomposer require spatie\/flysystem-dropbox\n```\nNext, you can register the driver within the `boot` method of one of your application's [service providers](https:\/\/laravel.com\/docs\/12.x\/providers). To accomplish this, you should use the `extend` method of the `Storage` facade:\n```\n1<?php23namespace App\\Providers;45use Illuminate\\Contracts\\Foundation\\Application;6use Illuminate\\Filesystem\\FilesystemAdapter;7use Illuminate\\Support\\Facades\\Storage;8use Illuminate\\Support\\ServiceProvider;9use League\\Flysystem\\Filesystem;10use Spatie\\Dropbox\\Client as DropboxClient;11use Spatie\\FlysystemDropbox\\DropboxAdapter;1213class AppServiceProvider extends ServiceProvider14{15 \/**16 * Register any application services.17 *\/18 public function register(): void19 {20 \/\/ ...21 }2223 \/**24 * Bootstrap any application services.25 *\/26 public function boot(): void27 {28 Storage::extend('dropbox', function (Application $app, array $config) {29 $adapter = new DropboxAdapter(new DropboxClient(30 $config['authorization_token']31 ));3233 return new FilesystemAdapter(34 new Filesystem($adapter, $config),35 $adapter,36 $config37 );38 });39 }40}<?php namespace App\\Providers; use Illuminate\\Contracts\\Foundation\\Application; use Illuminate\\Filesystem\\FilesystemAdapter; use Illuminate\\Support\\Facades\\Storage; use Illuminate\\Support\\ServiceProvider; use League\\Flysystem\\Filesystem; use Spatie\\Dropbox\\Client as DropboxClient; use Spatie\\FlysystemDropbox\\DropboxAdapter; class AppServiceProvider extends ServiceProvider { \/** * Register any application services. *\/ public function register(): void { \/\/ ... } \/** * Bootstrap any application services. *\/ public function boot(): void { Storage::extend('dropbox', function (Application $app, array $config) { $adapter = new DropboxAdapter(new DropboxClient( $config['authorization_token'] )); return new FilesystemAdapter( new Filesystem($adapter, $config), $adapter, $config ); }); } }\n```\nThe first argument of the `extend` method is the name of the driver and the second is a closure that receives the `$app` and `$config` variables. The closure must return an instance of `Illuminate\\Filesystem\\FilesystemAdapter`. The `$config` variable contains the values defined in `config\/filesystems.php` for the specified disk.\n\nOnce you have created and registered the extension's service provider, you may use the `dropbox` driver in your `config\/filesystems.php` configuration file.\n\nCopy as markdown\n\n### On this page\n- [Introduction](https:\/\/laravel.com\/docs\/12.x\/filesystem#introduction)\n- [Configuration](https:\/\/laravel.com\/docs\/12.x\/filesystem#configuration)\n  - [The Local Driver](https:\/\/laravel.com\/docs\/12.x\/filesystem#the-local-driver)\n  - [The Public Disk](https:\/\/laravel.com\/docs\/12.x\/filesystem#the-public-disk)\n  - [Driver Prerequisites](https:\/\/laravel.com\/docs\/12.x\/filesystem#driver-prerequisites)\n  - [Scoped and Read-Only Filesystems](https:\/\/laravel.com\/docs\/12.x\/filesystem#scoped-and-read-only-filesystems)\n  - [Amazon S3 Compatible Filesystems](https:\/\/laravel.com\/docs\/12.x\/filesystem#amazon-s3-compatible-filesystems)\n- [Obtaining Disk Instances](https:\/\/laravel.com\/docs\/12.x\/filesystem#obtaining-disk-instances)\n  - [On-Demand Disks](https:\/\/laravel.com\/docs\/12.x\/filesystem#on-demand-disks)\n- [Retrieving Files](https:\/\/laravel.com\/docs\/12.x\/filesystem#retrieving-files)\n  - [Downloading Files](https:\/\/laravel.com\/docs\/12.x\/filesystem#downloading-files)\n  - [File URLs](https:\/\/laravel.com\/docs\/12.x\/filesystem#file-urls)\n  - [Temporary URLs](https:\/\/laravel.com\/docs\/12.x\/filesystem#temporary-urls)\n  - [File Metadata](https:\/\/laravel.com\/docs\/12.x\/filesystem#file-metadata)\n- [Storing Files](https:\/\/laravel.com\/docs\/12.x\/filesystem#storing-files)\n  - [Prepending and Appending To Files](https:\/\/laravel.com\/docs\/12.x\/filesystem#prepending-appending-to-files)\n  - [Copying and Moving Files](https:\/\/laravel.com\/docs\/12.x\/filesystem#copying-moving-files)\n  - [Automatic Streaming](https:\/\/laravel.com\/docs\/12.x\/filesystem#automatic-streaming)\n  - [File Uploads](https:\/\/laravel.com\/docs\/12.x\/filesystem#file-uploads)\n  - [File Visibility](https:\/\/laravel.com\/docs\/12.x\/filesystem#file-visibility)\n- [Deleting Files](https:\/\/laravel.com\/docs\/12.x\/filesystem#deleting-files)\n- [Directories](https:\/\/laravel.com\/docs\/12.x\/filesystem#directories)\n- [Testing](https:\/\/laravel.com\/docs\/12.x\/filesystem#testing)\n- [Custom Filesystems](https:\/\/laravel.com\/docs\/12.x\/filesystem#custom-filesystems)\n\n[![Laracon US 2026](https:\/\/fls-9f826fcc-b2ad-40d8-813f-9cf7dac049fa.laravel.cloud\/docs-ads\/01KN5AKNREF0WREDYFPKVYBPG3.png)](https:\/\/laracon.us\/)\n\nLaravel is the most productive way to  \n build, deploy, and monitor software.\n\n- © 2026 Laravel\n- [Legal](https:\/\/laravel.com\/legal)\n- [Status](https:\/\/status.laravel.com\/)\n\n#### Products\n- [Cloud](https:\/\/cloud.laravel.com\/)\n- [Forge](https:\/\/forge.laravel.com\/)\n- [Nightwatch](https:\/\/nightwatch.laravel.com\/)\n- [Vapor](https:\/\/vapor.laravel.com\/)\n- [Nova](https:\/\/nova.laravel.com\/)\n\n#### Packages\n- [Cashier](https:\/\/laravel.com\/docs\/billing)\n- [Dusk](https:\/\/laravel.com\/docs\/dusk)\n- [Horizon](https:\/\/laravel.com\/docs\/horizon)\n- [Octane](https:\/\/laravel.com\/docs\/octane)\n- [Scout](https:\/\/laravel.com\/docs\/scout)\n- [Pennant](https:\/\/laravel.com\/docs\/pennant)\n- [Pint](https:\/\/laravel.com\/docs\/pint)\n- [Sail](https:\/\/laravel.com\/docs\/sail)\n- [Sanctum](https:\/\/laravel.com\/docs\/sanctum)\n- [Socialite](https:\/\/laravel.com\/docs\/socialite)\n- [Telescope](https:\/\/laravel.com\/docs\/telescope)\n- [Pulse](https:\/\/laravel.com\/docs\/pulse)\n- [Reverb](https:\/\/laravel.com\/docs\/reverb)\n- [Echo](https:\/\/laravel.com\/docs\/broadcasting)\n\n#### Resources\n- [Documentation](https:\/\/laravel.com\/docs)\n- [Starter Kits](https:\/\/laravel.com\/starter-kits)\n- [Release Notes](https:\/\/laravel.com\/docs\/releases)\n- [Blog](https:\/\/laravel.com\/blog)\n- [News](https:\/\/laravel-news.com\/)\n- [Community](https:\/\/laravel.com\/community)\n- [Larabelles](https:\/\/larabelles.com\/)\n- [Learn](https:\/\/laravel.com\/learn)\n- [Jobs](https:\/\/larajobs.com\/?partner=5)\n- [Careers](https:\/\/laravel.com\/careers)\n- [Trust](https:\/\/trust.laravel.com\/)\n\n#### Partners\n- [UCodeSoft](https:\/\/laravel.com\/partners\/ucodesoft)\n- [CACI Limited](https:\/\/laravel.com\/partners\/caci-limited)\n- [Redberry](https:\/\/laravel.com\/partners\/redberry)\n- [Vehikl](https:\/\/laravel.com\/partners\/vehikl)\n- [Pixel](https:\/\/laravel.com\/partners\/pixel)\n- [64 Robots](https:\/\/laravel.com\/partners\/64-robots)\n- [Jump24](https:\/\/laravel.com\/partners\/jump24)\n- [Curotec](https:\/\/laravel.com\/partners\/curotec)\n- [byte5](https:\/\/laravel.com\/partners\/byte5)\n- [Threadable](https:\/\/laravel.com\/partners\/threadable)\n- [See All](https:\/\/laravel.com\/partners)","attrs_readable_markdown":"> **WARNING** You're browsing the documentation for an old version of Laravel. Consider upgrading your project to [Laravel 13.x](https:\/\/laravel.com\/docs\/13.x\/filesystem).\n\n- [Introduction](https:\/\/laravel.com\/docs\/12.x\/filesystem#introduction)\n- [Configuration](https:\/\/laravel.com\/docs\/12.x\/filesystem#configuration)\n  - [The Local Driver](https:\/\/laravel.com\/docs\/12.x\/filesystem#the-local-driver)\n  - [The Public Disk](https:\/\/laravel.com\/docs\/12.x\/filesystem#the-public-disk)\n  - [Driver Prerequisites](https:\/\/laravel.com\/docs\/12.x\/filesystem#driver-prerequisites)\n  - [Scoped and Read-Only Filesystems](https:\/\/laravel.com\/docs\/12.x\/filesystem#scoped-and-read-only-filesystems)\n  - [Amazon S3 Compatible Filesystems](https:\/\/laravel.com\/docs\/12.x\/filesystem#amazon-s3-compatible-filesystems)\n- [Obtaining Disk Instances](https:\/\/laravel.com\/docs\/12.x\/filesystem#obtaining-disk-instances)\n  - [On-Demand Disks](https:\/\/laravel.com\/docs\/12.x\/filesystem#on-demand-disks)\n- [Retrieving Files](https:\/\/laravel.com\/docs\/12.x\/filesystem#retrieving-files)\n  - [Downloading Files](https:\/\/laravel.com\/docs\/12.x\/filesystem#downloading-files)\n  - [File URLs](https:\/\/laravel.com\/docs\/12.x\/filesystem#file-urls)\n  - [Temporary URLs](https:\/\/laravel.com\/docs\/12.x\/filesystem#temporary-urls)\n  - [File Metadata](https:\/\/laravel.com\/docs\/12.x\/filesystem#file-metadata)\n- [Storing Files](https:\/\/laravel.com\/docs\/12.x\/filesystem#storing-files)\n  - [Prepending and Appending To Files](https:\/\/laravel.com\/docs\/12.x\/filesystem#prepending-appending-to-files)\n  - [Copying and Moving Files](https:\/\/laravel.com\/docs\/12.x\/filesystem#copying-moving-files)\n  - [Automatic Streaming](https:\/\/laravel.com\/docs\/12.x\/filesystem#automatic-streaming)\n  - [File Uploads](https:\/\/laravel.com\/docs\/12.x\/filesystem#file-uploads)\n  - [File Visibility](https:\/\/laravel.com\/docs\/12.x\/filesystem#file-visibility)\n- [Deleting Files](https:\/\/laravel.com\/docs\/12.x\/filesystem#deleting-files)\n- [Directories](https:\/\/laravel.com\/docs\/12.x\/filesystem#directories)\n- [Testing](https:\/\/laravel.com\/docs\/12.x\/filesystem#testing)\n- [Custom Filesystems](https:\/\/laravel.com\/docs\/12.x\/filesystem#custom-filesystems)\n## [Introduction](https:\/\/laravel.com\/docs\/12.x\/filesystem#introduction)\nLaravel provides a powerful filesystem abstraction thanks to the wonderful [Flysystem](https:\/\/github.com\/thephpleague\/flysystem) PHP package by Frank de Jonge. The Laravel Flysystem integration provides simple drivers for working with local filesystems, SFTP, and Amazon S3. Even better, it's amazingly simple to switch between these storage options between your local development machine and production server as the API remains the same for each system.\n\n## [Configuration](https:\/\/laravel.com\/docs\/12.x\/filesystem#configuration)\nLaravel's filesystem configuration file is located at `config\/filesystems.php`. Within this file, you may configure all of your filesystem \"disks\". Each disk represents a particular storage driver and storage location. Example configurations for each supported driver are included in the configuration file so you can modify the configuration to reflect your storage preferences and credentials.\n\nThe `local` driver interacts with files stored locally on the server running the Laravel application, while the `sftp` storage driver is used for SSH key-based FTP. The `s3` driver is used to write to Amazon's S3 cloud storage service.\n\nYou may configure as many disks as you like and may even have multiple disks that use the same driver.\n\n### [The Local Driver](https:\/\/laravel.com\/docs\/12.x\/filesystem#the-local-driver)\nWhen using the `local` driver, all file operations are relative to the `root` directory defined in your `filesystems` configuration file. By default, this value is set to the `storage\/app\/private` directory. Therefore, the following method would write to `storage\/app\/private\/example.txt`:\n```\n1use Illuminate\\Support\\Facades\\Storage;23Storage::disk('local')->put('example.txt', 'Contents');\n```\n### [The Public Disk](https:\/\/laravel.com\/docs\/12.x\/filesystem#the-public-disk)\nThe `public` disk included in your application's `filesystems` configuration file is intended for files that are going to be publicly accessible. By default, the `public` disk uses the `local` driver and stores its files in `storage\/app\/public`.\n\nIf your `public` disk uses the `local` driver and you want to make these files accessible from the web, you should create a symbolic link from source directory `storage\/app\/public` to target directory `public\/storage`:\n\nTo create the symbolic link, you may use the `storage:link` Artisan command:\n```\n1php artisan storage:link\n```\nOnce a file has been stored and the symbolic link has been created, you can create a URL to the files using the `asset` helper:\n```\n1echo asset('storage\/file.txt');\n```\nYou may configure additional symbolic links in your `filesystems` configuration file. Each of the configured links will be created when you run the `storage:link` command:\n```\n1'links' => [2 public_path('storage') => storage_path('app\/public'),3 public_path('images') => storage_path('app\/images'),4],\n```\nThe `storage:unlink` command may be used to destroy your configured symbolic links:\n```\n1php artisan storage:unlink\n```\n### [Driver Prerequisites](https:\/\/laravel.com\/docs\/12.x\/filesystem#driver-prerequisites)\n#### [S3 Driver Configuration](https:\/\/laravel.com\/docs\/12.x\/filesystem#s3-driver-configuration)\nBefore using the S3 driver, you will need to install the Flysystem S3 package via the Composer package manager:\n```\n1composer require league\/flysystem-aws-s3-v3 \"^3.0\" --with-all-dependencies\n```\nAn S3 disk configuration array is located in your `config\/filesystems.php` configuration file. Typically, you should configure your S3 information and credentials using the following environment variables which are referenced by the `config\/filesystems.php` configuration file:\n```\n1AWS_ACCESS_KEY_ID=<your-key-id>2AWS_SECRET_ACCESS_KEY=<your-secret-access-key>3AWS_DEFAULT_REGION=us-east-14AWS_BUCKET=<your-bucket-name>5AWS_USE_PATH_STYLE_ENDPOINT=false\n```\nFor convenience, these environment variables match the naming convention used by the AWS CLI.\n\n#### [FTP Driver Configuration](https:\/\/laravel.com\/docs\/12.x\/filesystem#ftp-driver-configuration)\nBefore using the FTP driver, you will need to install the Flysystem FTP package via the Composer package manager:\n```\n1composer require league\/flysystem-ftp \"^3.0\"\n```\nLaravel's Flysystem integrations work great with FTP; however, a sample configuration is not included with the framework's default `config\/filesystems.php` configuration file. If you need to configure an FTP filesystem, you may use the configuration example below:\n```\n1'ftp' => [2 'driver' => 'ftp',3 'host' => env('FTP_HOST'),4 'username' => env('FTP_USERNAME'),5 'password' => env('FTP_PASSWORD'),67 \/\/ Optional FTP Settings...8 \/\/ 'port' => env('FTP_PORT', 21),9 \/\/ 'root' => env('FTP_ROOT'),10 \/\/ 'passive' => true,11 \/\/ 'ssl' => true,12 \/\/ 'timeout' => 30,13],\n```\n#### [SFTP Driver Configuration](https:\/\/laravel.com\/docs\/12.x\/filesystem#sftp-driver-configuration)\nBefore using the SFTP driver, you will need to install the Flysystem SFTP package via the Composer package manager:\n```\n1composer require league\/flysystem-sftp-v3 \"^3.0\"\n```\nLaravel's Flysystem integrations work great with SFTP; however, a sample configuration is not included with the framework's default `config\/filesystems.php` configuration file. If you need to configure an SFTP filesystem, you may use the configuration example below:\n```\n1'sftp' => [2 'driver' => 'sftp',3 'host' => env('SFTP_HOST'),45 \/\/ Settings for basic authentication...6 'username' => env('SFTP_USERNAME'),7 'password' => env('SFTP_PASSWORD'),89 \/\/ Settings for SSH key-based authentication with encryption password...10 'privateKey' => env('SFTP_PRIVATE_KEY'),11 'passphrase' => env('SFTP_PASSPHRASE'),1213 \/\/ Settings for file \/ directory permissions...14 'visibility' => 'private', \/\/ `private` = 0600, `public` = 064415 'directory_visibility' => 'private', \/\/ `private` = 0700, `public` = 07551617 \/\/ Optional SFTP Settings...18 \/\/ 'hostFingerprint' => env('SFTP_HOST_FINGERPRINT'),19 \/\/ 'maxTries' => 4,20 \/\/ 'passphrase' => env('SFTP_PASSPHRASE'),21 \/\/ 'port' => env('SFTP_PORT', 22),22 \/\/ 'root' => env('SFTP_ROOT', ''),23 \/\/ 'timeout' => 30,24 \/\/ 'useAgent' => true,25],\n```\n### [Scoped and Read-Only Filesystems](https:\/\/laravel.com\/docs\/12.x\/filesystem#scoped-and-read-only-filesystems)\nScoped disks allow you to define a filesystem where all paths are automatically prefixed with a given path prefix. Before creating a scoped filesystem disk, you will need to install an additional Flysystem package via the Composer package manager:\n```\n1composer require league\/flysystem-path-prefixing \"^3.0\"\n```\nYou may create a path scoped instance of any existing filesystem disk by defining a disk that utilizes the `scoped` driver. For example, you may create a disk which scopes your existing `s3` disk to a specific path prefix, and then every file operation using your scoped disk will utilize the specified prefix:\n```\n1's3-videos' => [2 'driver' => 'scoped',3 'disk' => 's3',4 'prefix' => 'path\/to\/videos',5],\n```\n\"Read-only\" disks allow you to create filesystem disks that do not allow write operations. Before using the `read-only` configuration option, you will need to install an additional Flysystem package via the Composer package manager:\n```\n1composer require league\/flysystem-read-only \"^3.0\"\n```\nNext, you may include the `read-only` configuration option in one or more of your disk's configuration arrays:\n```\n1's3-videos' => [2 'driver' => 's3',3 \/\/ ...4 'read-only' => true,5],\n```\n### [Amazon S3 Compatible Filesystems](https:\/\/laravel.com\/docs\/12.x\/filesystem#amazon-s3-compatible-filesystems)\nBy default, your application's `filesystems` configuration file contains a disk configuration for the `s3` disk. In addition to using this disk to interact with [Amazon S3](https:\/\/aws.amazon.com\/s3\/), you may use it to interact with any S3-compatible file storage service such as [RustFS](https:\/\/github.com\/rustfs\/rustfs), [DigitalOcean Spaces](https:\/\/www.digitalocean.com\/products\/spaces\/), [Vultr Object Storage](https:\/\/www.vultr.com\/products\/object-storage\/), [Cloudflare R2](https:\/\/www.cloudflare.com\/developer-platform\/products\/r2\/), or [Hetzner Cloud Storage](https:\/\/www.hetzner.com\/storage\/object-storage\/).\n\nTypically, after updating the disk's credentials to match the credentials of the service you are planning to use, you only need to update the value of the `endpoint` configuration option. This option's value is typically defined via the `AWS_ENDPOINT` environment variable:\n```\n1'endpoint' => env('AWS_ENDPOINT', 'https:\/\/rustfs:9000'),\n```\n## [Obtaining Disk Instances](https:\/\/laravel.com\/docs\/12.x\/filesystem#obtaining-disk-instances)\nThe `Storage` facade may be used to interact with any of your configured disks. For example, you may use the `put` method on the facade to store an avatar on the default disk. If you call methods on the `Storage` facade without first calling the `disk` method, the method will automatically be passed to the default disk:\n```\n1use Illuminate\\Support\\Facades\\Storage;23Storage::put('avatars\/1', $content);\n```\nIf your application interacts with multiple disks, you may use the `disk` method on the `Storage` facade to work with files on a particular disk:\n```\n1Storage::disk('s3')->put('avatars\/1', $content);\n```\n### [On-Demand Disks](https:\/\/laravel.com\/docs\/12.x\/filesystem#on-demand-disks)\nSometimes you may wish to create a disk at runtime using a given configuration without that configuration actually being present in your application's `filesystems` configuration file. To accomplish this, you may pass a configuration array to the `Storage` facade's `build` method:\n```\n1use Illuminate\\Support\\Facades\\Storage;23$disk = Storage::build([4 'driver' => 'local',5 'root' => '\/path\/to\/root',6]);78$disk->put('image.jpg', $content);\n```\n## [Retrieving Files](https:\/\/laravel.com\/docs\/12.x\/filesystem#retrieving-files)\nThe `get` method may be used to retrieve the contents of a file. The raw string contents of the file will be returned by the method. Remember, all file paths should be specified relative to the disk's \"root\" location:\n```\n1$contents = Storage::get('file.jpg');\n```\nIf the file you are retrieving contains JSON, you may use the `json` method to retrieve the file and decode its contents:\n```\n1$orders = Storage::json('orders.json');\n```\nThe `exists` method may be used to determine if a file exists on the disk:\n```\n1if (Storage::disk('s3')->exists('file.jpg')) {2 \/\/ ...3}\n```\nThe `missing` method may be used to determine if a file is missing from the disk:\n```\n1if (Storage::disk('s3')->missing('file.jpg')) {2 \/\/ ...3}\n```\n### [Downloading Files](https:\/\/laravel.com\/docs\/12.x\/filesystem#downloading-files)\nThe `download` method may be used to generate a response that forces the user's browser to download the file at the given path. The `download` method accepts a filename as the second argument to the method, which will determine the filename that is seen by the user downloading the file. Finally, you may pass an array of HTTP headers as the third argument to the method:\n```\n1return Storage::download('file.jpg');23return Storage::download('file.jpg', $name, $headers);\n```\n### [File URLs](https:\/\/laravel.com\/docs\/12.x\/filesystem#file-urls)\nYou may use the `url` method to get the URL for a given file. If you are using the `local` driver, this will typically just prepend `\/storage` to the given path and return a relative URL to the file. If you are using the `s3` driver, the fully qualified remote URL will be returned:\n```\n1use Illuminate\\Support\\Facades\\Storage;23$url = Storage::url('file.jpg');\n```\nWhen using the `local` driver, all files that should be publicly accessible should be placed in the `storage\/app\/public` directory. Furthermore, you should [create a symbolic link](https:\/\/laravel.com\/docs\/12.x\/filesystem#the-public-disk) at `public\/storage` which points to the `storage\/app\/public` directory.\n\nWhen using the `local` driver, the return value of `url` is not URL encoded. For this reason, we recommend always storing your files using names that will create valid URLs.\n\n#### [URL Host Customization](https:\/\/laravel.com\/docs\/12.x\/filesystem#url-host-customization)\nIf you would like to modify the host for URLs generated using the `Storage` facade, you may add or change the `url` option in the disk's configuration array:\n```\n1'public' => [2 'driver' => 'local',3 'root' => storage_path('app\/public'),4 'url' => env('APP_URL').'\/storage',5 'visibility' => 'public',6 'throw' => false,7],\n```\n### [Temporary URLs](https:\/\/laravel.com\/docs\/12.x\/filesystem#temporary-urls)\nUsing the `temporaryUrl` method, you may create temporary URLs to files stored using the `local` and `s3` drivers. This method accepts a path and a `DateTime` instance specifying when the URL should expire:\n```\n1use Illuminate\\Support\\Facades\\Storage;23$url = Storage::temporaryUrl(4 'file.jpg', now()->plus(minutes: 5)5);\n```\n#### [Enabling Local Temporary URLs](https:\/\/laravel.com\/docs\/12.x\/filesystem#enabling-local-temporary-urls)\nIf you started developing your application before support for temporary URLs was introduced to the `local` driver, you may need to enable local temporary URLs. To do so, add the `serve` option to your `local` disk's configuration array within the `config\/filesystems.php` configuration file:\n```\n1'local' => [2 'driver' => 'local',3 'root' => storage_path('app\/private'),4 'serve' => true,5 'throw' => false,6],\n```\n#### [S3 Request Parameters](https:\/\/laravel.com\/docs\/12.x\/filesystem#s3-request-parameters)\nIf you need to specify additional [S3 request parameters](https:\/\/docs.aws.amazon.com\/AmazonS3\/latest\/API\/RESTObjectGET.html#RESTObjectGET-requests), you may pass the array of request parameters as the third argument to the `temporaryUrl` method:\n```\n1$url = Storage::temporaryUrl(2 'file.jpg',3 now()->plus(minutes: 5),4 [5 'ResponseContentType' => 'application\/octet-stream',6 'ResponseContentDisposition' => 'attachment; filename=file2.jpg',7 ]8);\n```\n#### [Customizing Temporary URLs](https:\/\/laravel.com\/docs\/12.x\/filesystem#customizing-temporary-urls)\nIf you need to customize how temporary URLs are created for a specific storage disk, you can use the `buildTemporaryUrlsUsing` method. For example, this can be useful if you have a controller that allows you to download files stored via a disk that doesn't typically support temporary URLs. Usually, this method should be called from the `boot` method of a service provider:\n```\n1<?php23namespace App\\Providers;45use DateTime;6use Illuminate\\Support\\Facades\\Storage;7use Illuminate\\Support\\Facades\\URL;8use Illuminate\\Support\\ServiceProvider;910class AppServiceProvider extends ServiceProvider11{12 \/**13 * Bootstrap any application services.14 *\/15 public function boot(): void16 {17 Storage::disk('local')->buildTemporaryUrlsUsing(18 function (string $path, DateTime $expiration, array $options) {19 return URL::temporarySignedRoute(20 'files.download',21 $expiration,22 array_merge($options, ['path' => $path])23 );24 }25 );26 }27}\n```\n#### [Temporary Upload URLs](https:\/\/laravel.com\/docs\/12.x\/filesystem#temporary-upload-urls)\nThe ability to generate temporary upload URLs is only supported by the `s3` and `local` drivers.\n\nIf you need to generate a temporary URL that can be used to upload a file directly from your client-side application, you may use the `temporaryUploadUrl` method. This method accepts a path and a `DateTime` instance specifying when the URL should expire. The `temporaryUploadUrl` method returns an associative array which may be destructured into the upload URL and the headers that should be included with the upload request:\n```\n1use Illuminate\\Support\\Facades\\Storage;23['url' => $url, 'headers' => $headers] = Storage::temporaryUploadUrl(4 'file.jpg', now()->plus(minutes: 5)5);\n```\nThis method is primarily useful in serverless environments that require the client-side application to directly upload files to a cloud storage system such as Amazon S3.\n\n### [File Metadata](https:\/\/laravel.com\/docs\/12.x\/filesystem#file-metadata)\nIn addition to reading and writing files, Laravel can also provide information about the files themselves. For example, the `size` method may be used to get the size of a file in bytes:\n```\n1use Illuminate\\Support\\Facades\\Storage;23$size = Storage::size('file.jpg');\n```\nThe `lastModified` method returns the UNIX timestamp of the last time the file was modified:\n```\n1$time = Storage::lastModified('file.jpg');\n```\nThe MIME type of a given file may be obtained via the `mimeType` method:\n```\n1$mime = Storage::mimeType('file.jpg');\n```\n#### [File Paths](https:\/\/laravel.com\/docs\/12.x\/filesystem#file-paths)\nYou may use the `path` method to get the path for a given file. If you are using the `local` driver, this will return the absolute path to the file. If you are using the `s3` driver, this method will return the relative path to the file in the S3 bucket:\n```\n1use Illuminate\\Support\\Facades\\Storage;23$path = Storage::path('file.jpg');\n```\n## [Storing Files](https:\/\/laravel.com\/docs\/12.x\/filesystem#storing-files)\nThe `put` method may be used to store file contents on a disk. You may also pass a PHP `resource` to the `put` method, which will use Flysystem's underlying stream support. Remember, all file paths should be specified relative to the \"root\" location configured for the disk:\n```\n1use Illuminate\\Support\\Facades\\Storage;23Storage::put('file.jpg', $contents);45Storage::put('file.jpg', $resource);\n```\n#### [Failed Writes](https:\/\/laravel.com\/docs\/12.x\/filesystem#failed-writes)\nIf the `put` method (or other \"write\" operations) is unable to write the file to disk, `false` will be returned:\n```\n1if (! Storage::put('file.jpg', $contents)) {2 \/\/ The file could not be written to disk...3}\n```\nIf you wish, you may define the `throw` option within your filesystem disk's configuration array. When this option is defined as `true`, \"write\" methods such as `put` will throw an instance of `League\\Flysystem\\UnableToWriteFile` when write operations fail:\n```\n1'public' => [2 'driver' => 'local',3 \/\/ ...4 'throw' => true,5],\n```\n### [Prepending and Appending To Files](https:\/\/laravel.com\/docs\/12.x\/filesystem#prepending-appending-to-files)\nThe `prepend` and `append` methods allow you to write to the beginning or end of a file:\n```\n1Storage::prepend('file.log', 'Prepended Text');23Storage::append('file.log', 'Appended Text');\n```\n### [Copying and Moving Files](https:\/\/laravel.com\/docs\/12.x\/filesystem#copying-moving-files)\nThe `copy` method may be used to copy an existing file to a new location on the disk, while the `move` method may be used to rename or move an existing file to a new location:\n```\n1Storage::copy('old\/file.jpg', 'new\/file.jpg');23Storage::move('old\/file.jpg', 'new\/file.jpg');\n```\n### [Automatic Streaming](https:\/\/laravel.com\/docs\/12.x\/filesystem#automatic-streaming)\nStreaming files to storage offers significantly reduced memory usage. If you would like Laravel to automatically manage streaming a given file to your storage location, you may use the `putFile` or `putFileAs` method. This method accepts either an `Illuminate\\Http\\File` or `Illuminate\\Http\\UploadedFile` instance and will automatically stream the file to your desired location:\n```\n1use Illuminate\\Http\\File;2use Illuminate\\Support\\Facades\\Storage;34\/\/ Automatically generate a unique ID for filename...5$path = Storage::putFile('photos', new File('\/path\/to\/photo'));67\/\/ Manually specify a filename...8$path = Storage::putFileAs('photos', new File('\/path\/to\/photo'), 'photo.jpg');\n```\nThere are a few important things to note about the `putFile` method. Note that we only specified a directory name and not a filename. By default, the `putFile` method will generate a unique ID to serve as the filename. The file's extension will be determined by examining the file's MIME type. The path to the file will be returned by the `putFile` method so you can store the path, including the generated filename, in your database.\n\nThe `putFile` and `putFileAs` methods also accept an argument to specify the \"visibility\" of the stored file. This is particularly useful if you are storing the file on a cloud disk such as Amazon S3 and would like the file to be publicly accessible via generated URLs:\n```\n1Storage::putFile('photos', new File('\/path\/to\/photo'), 'public');\n```\n### [File Uploads](https:\/\/laravel.com\/docs\/12.x\/filesystem#file-uploads)\nIn web applications, one of the most common use-cases for storing files is storing user uploaded files such as photos and documents. Laravel makes it very easy to store uploaded files using the `store` method on an uploaded file instance. Call the `store` method with the path at which you wish to store the uploaded file:\n```\n1<?php23namespace App\\Http\\Controllers;45use Illuminate\\Http\\Request;67class UserAvatarController extends Controller8{9 \/**10 * Update the avatar for the user.11 *\/12 public function update(Request $request): string13 {14 $path = $request->file('avatar')->store('avatars');1516 return $path;17 }18}\n```\nThere are a few important things to note about this example. Note that we only specified a directory name, not a filename. By default, the `store` method will generate a unique ID to serve as the filename. The file's extension will be determined by examining the file's MIME type. The path to the file will be returned by the `store` method so you can store the path, including the generated filename, in your database.\n\nYou may also call the `putFile` method on the `Storage` facade to perform the same file storage operation as the example above:\n```\n1$path = Storage::putFile('avatars', $request->file('avatar'));\n```\n#### [Specifying a File Name](https:\/\/laravel.com\/docs\/12.x\/filesystem#specifying-a-file-name)\nIf you do not want a filename to be automatically assigned to your stored file, you may use the `storeAs` method, which receives the path, the filename, and the (optional) disk as its arguments:\n```\n1$path = $request->file('avatar')->storeAs(2 'avatars', $request->user()->id3);\n```\nYou may also use the `putFileAs` method on the `Storage` facade, which will perform the same file storage operation as the example above:\n```\n1$path = Storage::putFileAs(2 'avatars', $request->file('avatar'), $request->user()->id3);\n```\nUnprintable and invalid unicode characters will automatically be removed from file paths. Therefore, you may wish to sanitize your file paths before passing them to Laravel's file storage methods. File paths are normalized using the `League\\Flysystem\\WhitespacePathNormalizer::normalizePath` method.\n\n#### [Specifying a Disk](https:\/\/laravel.com\/docs\/12.x\/filesystem#specifying-a-disk)\nBy default, this uploaded file's `store` method will use your default disk. If you would like to specify another disk, pass the disk name as the second argument to the `store` method:\n```\n1$path = $request->file('avatar')->store(2 'avatars\/'.$request->user()->id, 's3'3);\n```\nIf you are using the `storeAs` method, you may pass the disk name as the third argument to the method:\n```\n1$path = $request->file('avatar')->storeAs(2 'avatars',3 $request->user()->id,4 's3'5);\n```\n#### [Other Uploaded File Information](https:\/\/laravel.com\/docs\/12.x\/filesystem#other-uploaded-file-information)\nIf you would like to get the original name and extension of the uploaded file, you may do so using the `getClientOriginalName` and `getClientOriginalExtension` methods:\n```\n1$file = $request->file('avatar');23$name = $file->getClientOriginalName();4$extension = $file->getClientOriginalExtension();\n```\nHowever, keep in mind that the `getClientOriginalName` and `getClientOriginalExtension` methods are considered unsafe, as the file name and extension may be tampered with by a malicious user. For this reason, you should typically prefer the `hashName` and `extension` methods to get a name and an extension for the given file upload:\n```\n1$file = $request->file('avatar');23$name = $file->hashName(); \/\/ Generate a unique, random name...4$extension = $file->extension(); \/\/ Determine the file's extension based on the file's MIME type...\n```\n### [File Visibility](https:\/\/laravel.com\/docs\/12.x\/filesystem#file-visibility)\nIn Laravel's Flysystem integration, \"visibility\" is an abstraction of file permissions across multiple platforms. Files may either be declared `public` or `private`. When a file is declared `public`, you are indicating that the file should generally be accessible to others. For example, when using the S3 driver, you may retrieve URLs for `public` files.\n\nYou can set the visibility when writing the file via the `put` method:\n```\n1use Illuminate\\Support\\Facades\\Storage;23Storage::put('file.jpg', $contents, 'public');\n```\nIf the file has already been stored, its visibility can be retrieved and set via the `getVisibility` and `setVisibility` methods:\n```\n1$visibility = Storage::getVisibility('file.jpg');23Storage::setVisibility('file.jpg', 'public');\n```\nWhen interacting with uploaded files, you may use the `storePublicly` and `storePubliclyAs` methods to store the uploaded file with `public` visibility:\n```\n1$path = $request->file('avatar')->storePublicly('avatars', 's3');23$path = $request->file('avatar')->storePubliclyAs(4 'avatars',5 $request->user()->id,6 's3'7);\n```\n#### [Local Files and Visibility](https:\/\/laravel.com\/docs\/12.x\/filesystem#local-files-and-visibility)\nWhen using the `local` driver, `public` [visibility](https:\/\/laravel.com\/docs\/12.x\/filesystem#file-visibility) translates to `0755` permissions for directories and `0644` permissions for files. You can modify the permissions mappings in your application's `filesystems` configuration file:\n```\n1'local' => [2 'driver' => 'local',3 'root' => storage_path('app'),4 'permissions' => [5 'file' => [6 'public' => 0644,7 'private' => 0600,8 ],9 'dir' => [10 'public' => 0755,11 'private' => 0700,12 ],13 ],14 'throw' => false,15],\n```\n## [Deleting Files](https:\/\/laravel.com\/docs\/12.x\/filesystem#deleting-files)\nThe `delete` method accepts a single filename or an array of files to delete:\n```\n1use Illuminate\\Support\\Facades\\Storage;23Storage::delete('file.jpg');45Storage::delete(['file.jpg', 'file2.jpg']);\n```\nIf necessary, you may specify the disk that the file should be deleted from:\n```\n1use Illuminate\\Support\\Facades\\Storage;23Storage::disk('s3')->delete('path\/file.jpg');\n```\n## [Directories](https:\/\/laravel.com\/docs\/12.x\/filesystem#directories)\n#### [Get All Files Within a Directory](https:\/\/laravel.com\/docs\/12.x\/filesystem#get-all-files-within-a-directory)\nThe `files` method returns an array of all files within a given directory. If you would like to retrieve a list of all files within a given directory including subdirectories, you may use the `allFiles` method:\n```\n1use Illuminate\\Support\\Facades\\Storage;23$files = Storage::files($directory);45$files = Storage::allFiles($directory);\n```\n#### [Get All Directories Within a Directory](https:\/\/laravel.com\/docs\/12.x\/filesystem#get-all-directories-within-a-directory)\nThe `directories` method returns an array of all directories within a given directory. If you would like to retrieve a list of all directories within a given directory including subdirectories, you may use the `allDirectories` method:\n```\n1$directories = Storage::directories($directory);23$directories = Storage::allDirectories($directory);\n```\n#### [Create a Directory](https:\/\/laravel.com\/docs\/12.x\/filesystem#create-a-directory)\nThe `makeDirectory` method will create the given directory, including any needed subdirectories:\n```\n1Storage::makeDirectory($directory);\n```\n#### [Delete a Directory](https:\/\/laravel.com\/docs\/12.x\/filesystem#delete-a-directory)\nFinally, the `deleteDirectory` method may be used to remove a directory and all of its files:\n```\n1Storage::deleteDirectory($directory);\n```\n## [Testing](https:\/\/laravel.com\/docs\/12.x\/filesystem#testing)\nThe `Storage` facade's `fake` method allows you to easily generate a fake disk that, combined with the file generation utilities of the `Illuminate\\Http\\UploadedFile` class, greatly simplifies the testing of file uploads. For example:\n\n```\n1<?php23use Illuminate\\Http\\UploadedFile;4use Illuminate\\Support\\Facades\\Storage;56test('albums can be uploaded', function () {7 Storage::fake('photos');89 $response = $this->json('POST', '\/photos', [10 UploadedFile::fake()->image('photo1.jpg'),11 UploadedFile::fake()->image('photo2.jpg')12 ]);1314 \/\/ Assert one or more files were stored...15 Storage::disk('photos')->assertExists('photo1.jpg');16 Storage::disk('photos')->assertExists(['photo1.jpg', 'photo2.jpg']);1718 \/\/ Assert one or more files were not stored...19 Storage::disk('photos')->assertMissing('missing.jpg');20 Storage::disk('photos')->assertMissing(['missing.jpg', 'non-existing.jpg']);2122 \/\/ Assert that the number of files in a given directory matches the expected count...23 Storage::disk('photos')->assertCount('\/wallpapers', 2);2425 \/\/ Assert that a given directory is empty...26 Storage::disk('photos')->assertDirectoryEmpty('\/wallpapers');27});\n```\n```\n1<?php23namespace Tests\\Feature;45use Illuminate\\Http\\UploadedFile;6use Illuminate\\Support\\Facades\\Storage;7use Tests\\TestCase;89class ExampleTest extends TestCase10{11 public function test_albums_can_be_uploaded(): void12 {13 Storage::fake('photos');1415 $response = $this->json('POST', '\/photos', [16 UploadedFile::fake()->image('photo1.jpg'),17 UploadedFile::fake()->image('photo2.jpg')18 ]);1920 \/\/ Assert one or more files were stored...21 Storage::disk('photos')->assertExists('photo1.jpg');22 Storage::disk('photos')->assertExists(['photo1.jpg', 'photo2.jpg']);2324 \/\/ Assert one or more files were not stored...25 Storage::disk('photos')->assertMissing('missing.jpg');26 Storage::disk('photos')->assertMissing(['missing.jpg', 'non-existing.jpg']);2728 \/\/ Assert that the number of files in a given directory matches the expected count...29 Storage::disk('photos')->assertCount('\/wallpapers', 2);3031 \/\/ Assert that a given directory is empty...32 Storage::disk('photos')->assertDirectoryEmpty('\/wallpapers');33 }34}\n```\n\nBy default, the `fake` method will delete all files in its temporary directory. If you would like to keep these files, you may use the \"persistentFake\" method instead. For more information on testing file uploads, you may consult the [HTTP testing documentation's information on file uploads](https:\/\/laravel.com\/docs\/12.x\/http-tests#testing-file-uploads).\n\nThe `image` method requires the [GD extension](https:\/\/www.php.net\/manual\/en\/book.image.php).\n\n## [Custom Filesystems](https:\/\/laravel.com\/docs\/12.x\/filesystem#custom-filesystems)\nLaravel's Flysystem integration provides support for several \"drivers\" out of the box; however, Flysystem is not limited to these and has adapters for many other storage systems. You can create a custom driver if you want to use one of these additional adapters in your Laravel application.\n\nIn order to define a custom filesystem you will need a Flysystem adapter. Let's add a community maintained Dropbox adapter to our project:\n```\n1composer require spatie\/flysystem-dropbox\n```\nNext, you can register the driver within the `boot` method of one of your application's [service providers](https:\/\/laravel.com\/docs\/12.x\/providers). To accomplish this, you should use the `extend` method of the `Storage` facade:\n```\n1<?php23namespace App\\Providers;45use Illuminate\\Contracts\\Foundation\\Application;6use Illuminate\\Filesystem\\FilesystemAdapter;7use Illuminate\\Support\\Facades\\Storage;8use Illuminate\\Support\\ServiceProvider;9use League\\Flysystem\\Filesystem;10use Spatie\\Dropbox\\Client as DropboxClient;11use Spatie\\FlysystemDropbox\\DropboxAdapter;1213class AppServiceProvider extends ServiceProvider14{15 \/**16 * Register any application services.17 *\/18 public function register(): void19 {20 \/\/ ...21 }2223 \/**24 * Bootstrap any application services.25 *\/26 public function boot(): void27 {28 Storage::extend('dropbox', function (Application $app, array $config) {29 $adapter = new DropboxAdapter(new DropboxClient(30 $config['authorization_token']31 ));3233 return new FilesystemAdapter(34 new Filesystem($adapter, $config),35 $adapter,36 $config37 );38 });39 }40}\n```\nThe first argument of the `extend` method is the name of the driver and the second is a closure that receives the `$app` and `$config` variables. The closure must return an instance of `Illuminate\\Filesystem\\FilesystemAdapter`. The `$config` variable contains the values defined in `config\/filesystems.php` for the specified disk.\n\nOnce you have created and registered the extension's service provider, you may use the `dropbox` driver in your `config\/filesystems.php` configuration file.","meta_canonical":"com,laravel!\/docs\/13.x\/filesystem s443"}

3. Robots.txt Check

Query:

Response:

4. Spam/Ban Check

Query:

Response:

5. Seen Status Check

ℹ️ Skipped - page is already crawled

🚫

NOT INDEXABLE

✅

CRAWLED

51 minutes ago

🤖

ROBOTS ALLOWED

Page Info Filters

Filter	Status	Condition	Details
HTTP status	PASS	`download_http_code = 200`	HTTP 200
Age cutoff	PASS	`download_stamp > now() - 6 MONTH`	0 months ago
History drop	PASS	`isNull(history_drop_reason)`	No drop reason
Spam/ban	PASS	`fh_dont_index != 1 AND ml_spam_score = 0`	ml_spam_score=0
Canonical	FAIL	`meta_canonical IS NULL OR = '' OR = src_unparsed`	com,laravel!/docs/13.x/filesystem s443

Page Details

Property	Value
URL	https://laravel.com/docs/12.x/filesystem
Last Crawled	2026-04-13 01:31:34 (51 minutes ago)
First Indexed	2025-02-24 16:47:35 (1 year ago)
HTTP Status Code	200
Meta Title	File Storage \| Laravel 12.x - The clean stack for Artisans and agents
Meta Description	Laravel is a PHP web application framework with expressive, elegant syntax. We've already laid the foundation — freeing you to create without sweating the small things.
Meta Canonical	com,laravel!/docs/13.x/filesystem s443
Boilerpipe Text	WARNING You're browsing the documentation for an old version of Laravel. Consider upgrading your project to Laravel 13.x . Introduction Configuration The Local Driver The Public Disk Driver Prerequisites Scoped and Read-Only Filesystems Amazon S3 Compatible Filesystems Obtaining Disk Instances On-Demand Disks Retrieving Files Downloading Files File URLs Temporary URLs File Metadata Storing Files Prepending and Appending To Files Copying and Moving Files Automatic Streaming File Uploads File Visibility Deleting Files Directories Testing Custom Filesystems Introduction Laravel provides a powerful filesystem abstraction thanks to the wonderful Flysystem PHP package by Frank de Jonge. The Laravel Flysystem integration provides simple drivers for working with local filesystems, SFTP, and Amazon S3. Even better, it's amazingly simple to switch between these storage options between your local development machine and production server as the API remains the same for each system. Configuration Laravel's filesystem configuration file is located at config/filesystems.php . Within this file, you may configure all of your filesystem "disks". Each disk represents a particular storage driver and storage location. Example configurations for each supported driver are included in the configuration file so you can modify the configuration to reflect your storage preferences and credentials. The local driver interacts with files stored locally on the server running the Laravel application, while the sftp storage driver is used for SSH key-based FTP. The s3 driver is used to write to Amazon's S3 cloud storage service. You may configure as many disks as you like and may even have multiple disks that use the same driver. The Local Driver When using the local driver, all file operations are relative to the root directory defined in your filesystems configuration file. By default, this value is set to the storage/app/private directory. Therefore, the following method would write to storage/app/private/example.txt : 1 use Illuminate\Support\Facades\ Storage ; 2 3 Storage :: disk ( ' local ' ) -> put ( ' example.txt ' , ' Contents ' ); The Public Disk The public disk included in your application's filesystems configuration file is intended for files that are going to be publicly accessible. By default, the public disk uses the local driver and stores its files in storage/app/public . If your public disk uses the local driver and you want to make these files accessible from the web, you should create a symbolic link from source directory storage/app/public to target directory public/storage : To create the symbolic link, you may use the storage:link Artisan command: 1 php artisan storage:link Once a file has been stored and the symbolic link has been created, you can create a URL to the files using the asset helper: 1 echo asset ( ' storage/file.txt ' ); You may configure additional symbolic links in your filesystems configuration file. Each of the configured links will be created when you run the storage:link command: 1 ' links ' => [ 2 public_path ( ' storage ' ) => storage_path ( ' app/public ' ), 3 public_path ( ' images ' ) => storage_path ( ' app/images ' ), 4 ], The storage:unlink command may be used to destroy your configured symbolic links: 1 php artisan storage:unlink Driver Prerequisites S3 Driver Configuration Before using the S3 driver, you will need to install the Flysystem S3 package via the Composer package manager: 1 composer require league/flysystem-aws-s3-v3 " ^3.0 " --with-all-dependencies An S3 disk configuration array is located in your config/filesystems.php configuration file. Typically, you should configure your S3 information and credentials using the following environment variables which are referenced by the config/filesystems.php configuration file: 1 AWS_ACCESS_KEY_ID =<your-key-id> 2 AWS_SECRET_ACCESS_KEY =<your-secret-access-key> 3 AWS_DEFAULT_REGION =us-east-1 4 AWS_BUCKET =<your-bucket-name> 5 AWS_USE_PATH_STYLE_ENDPOINT =false For convenience, these environment variables match the naming convention used by the AWS CLI. FTP Driver Configuration Before using the FTP driver, you will need to install the Flysystem FTP package via the Composer package manager: 1 composer require league/flysystem-ftp " ^3.0 " Laravel's Flysystem integrations work great with FTP; however, a sample configuration is not included with the framework's default config/filesystems.php configuration file. If you need to configure an FTP filesystem, you may use the configuration example below: 1 ' ftp ' => [ 2 ' driver ' => ' ftp ' , 3 ' host ' => env ( ' FTP_HOST ' ), 4 ' username ' => env ( ' FTP_USERNAME ' ), 5 ' password ' => env ( ' FTP_PASSWORD ' ), 6 7 // Optional FTP Settings... 8 // 'port' => env('FTP_PORT', 21), 9 // 'root' => env('FTP_ROOT'), 10 // 'passive' => true, 11 // 'ssl' => true, 12 // 'timeout' => 30, 13 ], SFTP Driver Configuration Before using the SFTP driver, you will need to install the Flysystem SFTP package via the Composer package manager: 1 composer require league/flysystem-sftp-v3 " ^3.0 " Laravel's Flysystem integrations work great with SFTP; however, a sample configuration is not included with the framework's default config/filesystems.php configuration file. If you need to configure an SFTP filesystem, you may use the configuration example below: 1 ' sftp ' => [ 2 ' driver ' => ' sftp ' , 3 ' host ' => env ( ' SFTP_HOST ' ), 4 5 // Settings for basic authentication... 6 ' username ' => env ( ' SFTP_USERNAME ' ), 7 ' password ' => env ( ' SFTP_PASSWORD ' ), 8 9 // Settings for SSH key-based authentication with encryption password... 10 ' privateKey ' => env ( ' SFTP_PRIVATE_KEY ' ), 11 ' passphrase ' => env ( ' SFTP_PASSPHRASE ' ), 12 13 // Settings for file / directory permissions... 14 ' visibility ' => ' private ' , // `private` = 0600, `public` = 0644 15 ' directory_visibility ' => ' private ' , // `private` = 0700, `public` = 0755 16 17 // Optional SFTP Settings... 18 // 'hostFingerprint' => env('SFTP_HOST_FINGERPRINT'), 19 // 'maxTries' => 4, 20 // 'passphrase' => env('SFTP_PASSPHRASE'), 21 // 'port' => env('SFTP_PORT', 22), 22 // 'root' => env('SFTP_ROOT', ''), 23 // 'timeout' => 30, 24 // 'useAgent' => true, 25 ], Scoped and Read-Only Filesystems Scoped disks allow you to define a filesystem where all paths are automatically prefixed with a given path prefix. Before creating a scoped filesystem disk, you will need to install an additional Flysystem package via the Composer package manager: 1 composer require league/flysystem-path-prefixing " ^3.0 " You may create a path scoped instance of any existing filesystem disk by defining a disk that utilizes the scoped driver. For example, you may create a disk which scopes your existing s3 disk to a specific path prefix, and then every file operation using your scoped disk will utilize the specified prefix: 1 ' s3-videos ' => [ 2 ' driver ' => ' scoped ' , 3 ' disk ' => ' s3 ' , 4 ' prefix ' => ' path/to/videos ' , 5 ], "Read-only" disks allow you to create filesystem disks that do not allow write operations. Before using the read-only configuration option, you will need to install an additional Flysystem package via the Composer package manager: 1 composer require league/flysystem-read-only " ^3.0 " Next, you may include the read-only configuration option in one or more of your disk's configuration arrays: 1 ' s3-videos ' => [ 2 ' driver ' => ' s3 ' , 3 // ... 4 ' read-only ' => true , 5 ], Amazon S3 Compatible Filesystems By default, your application's filesystems configuration file contains a disk configuration for the s3 disk. In addition to using this disk to interact with Amazon S3 , you may use it to interact with any S3-compatible file storage service such as RustFS , DigitalOcean Spaces , Vultr Object Storage , Cloudflare R2 , or Hetzner Cloud Storage . Typically, after updating the disk's credentials to match the credentials of the service you are planning to use, you only need to update the value of the endpoint configuration option. This option's value is typically defined via the AWS_ENDPOINT environment variable: 1 ' endpoint ' => env ( ' AWS_ENDPOINT ' , ' https://rustfs:9000 ' ), Obtaining Disk Instances The Storage facade may be used to interact with any of your configured disks. For example, you may use the put method on the facade to store an avatar on the default disk. If you call methods on the Storage facade without first calling the disk method, the method will automatically be passed to the default disk: 1 use Illuminate\Support\Facades\ Storage ; 2 3 Storage :: put ( ' avatars/1 ' , $content ); If your application interacts with multiple disks, you may use the disk method on the Storage facade to work with files on a particular disk: 1 Storage :: disk ( ' s3 ' ) -> put ( ' avatars/1 ' , $content ); On-Demand Disks Sometimes you may wish to create a disk at runtime using a given configuration without that configuration actually being present in your application's filesystems configuration file. To accomplish this, you may pass a configuration array to the Storage facade's build method: 1 use Illuminate\Support\Facades\ Storage ; 2 3 $disk = Storage :: build ([ 4 ' driver ' => ' local ' , 5 ' root ' => ' /path/to/root ' , 6 ]); 7 8 $disk -> put ( ' image.jpg ' , $content ); Retrieving Files The get method may be used to retrieve the contents of a file. The raw string contents of the file will be returned by the method. Remember, all file paths should be specified relative to the disk's "root" location: 1 $contents = Storage :: get ( ' file.jpg ' ); If the file you are retrieving contains JSON, you may use the json method to retrieve the file and decode its contents: 1 $orders = Storage :: json ( ' orders.json ' ); The exists method may be used to determine if a file exists on the disk: 1 if ( Storage :: disk ( ' s3 ' ) -> exists ( ' file.jpg ' )) { 2 // ... 3 } The missing method may be used to determine if a file is missing from the disk: 1 if ( Storage :: disk ( ' s3 ' ) -> missing ( ' file.jpg ' )) { 2 // ... 3 } Downloading Files The download method may be used to generate a response that forces the user's browser to download the file at the given path. The download method accepts a filename as the second argument to the method, which will determine the filename that is seen by the user downloading the file. Finally, you may pass an array of HTTP headers as the third argument to the method: 1 return Storage :: download ( ' file.jpg ' ); 2 3 return Storage :: download ( ' file.jpg ' , $name , $headers ); File URLs You may use the url method to get the URL for a given file. If you are using the local driver, this will typically just prepend /storage to the given path and return a relative URL to the file. If you are using the s3 driver, the fully qualified remote URL will be returned: 1 use Illuminate\Support\Facades\ Storage ; 2 3 $url = Storage :: url ( ' file.jpg ' ); When using the local driver, all files that should be publicly accessible should be placed in the storage/app/public directory. Furthermore, you should create a symbolic link at public/storage which points to the storage/app/public directory. When using the local driver, the return value of url is not URL encoded. For this reason, we recommend always storing your files using names that will create valid URLs. URL Host Customization If you would like to modify the host for URLs generated using the Storage facade, you may add or change the url option in the disk's configuration array: 1 ' public ' => [ 2 ' driver ' => ' local ' , 3 ' root ' => storage_path ( ' app/public ' ), 4 ' url ' => env ( ' APP_URL ' ) . ' /storage ' , 5 ' visibility ' => ' public ' , 6 ' throw ' => false , 7 ], Temporary URLs Using the temporaryUrl method, you may create temporary URLs to files stored using the local and s3 drivers. This method accepts a path and a DateTime instance specifying when the URL should expire: 1 use Illuminate\Support\Facades\ Storage ; 2 3 $url = Storage :: temporaryUrl ( 4 ' file.jpg ' , now () -> plus (minutes: 5 ) 5 ); Enabling Local Temporary URLs If you started developing your application before support for temporary URLs was introduced to the local driver, you may need to enable local temporary URLs. To do so, add the serve option to your local disk's configuration array within the config/filesystems.php configuration file: 1 ' local ' => [ 2 ' driver ' => ' local ' , 3 ' root ' => storage_path ( ' app/private ' ), 4 ' serve ' => true , 5 ' throw ' => false , 6 ], S3 Request Parameters If you need to specify additional S3 request parameters , you may pass the array of request parameters as the third argument to the temporaryUrl method: 1 $url = Storage :: temporaryUrl ( 2 ' file.jpg ' , 3 now () -> plus (minutes: 5 ), 4 [ 5 ' ResponseContentType ' => ' application/octet-stream ' , 6 ' ResponseContentDisposition ' => ' attachment; filename=file2.jpg ' , 7 ] 8 ); Customizing Temporary URLs If you need to customize how temporary URLs are created for a specific storage disk, you can use the buildTemporaryUrlsUsing method. For example, this can be useful if you have a controller that allows you to download files stored via a disk that doesn't typically support temporary URLs. Usually, this method should be called from the boot method of a service provider: 1 <?php 2 3 namespace App\Providers; 4 5 use DateTime ; 6 use Illuminate\Support\Facades\ Storage ; 7 use Illuminate\Support\Facades\ URL ; 8 use Illuminate\Support\ ServiceProvider ; 9 10 class AppServiceProvider extends ServiceProvider 11 { 12 /** 13 * Bootstrap any application services. 14 / 15 public function boot () : void 16 { 17 Storage :: disk ( ' local ' ) -> buildTemporaryUrlsUsing ( 18 function ( string $path , DateTime $expiration , array $options ) { 19 return URL :: temporarySignedRoute ( 20 ' files.download ' , 21 $expiration , 22 array_merge ($ options , [ ' path ' => $ path ]) 23 ); 24 } 25 ); 26 } 27 } Temporary Upload URLs The ability to generate temporary upload URLs is only supported by the s3 and local drivers. If you need to generate a temporary URL that can be used to upload a file directly from your client-side application, you may use the temporaryUploadUrl method. This method accepts a path and a DateTime instance specifying when the URL should expire. The temporaryUploadUrl method returns an associative array which may be destructured into the upload URL and the headers that should be included with the upload request: 1 use Illuminate\Support\Facades\ Storage ; 2 3 [ ' url ' => $url , ' headers ' => $headers ] = Storage :: temporaryUploadUrl ( 4 ' file.jpg ' , now () -> plus (minutes: 5 ) 5 ); This method is primarily useful in serverless environments that require the client-side application to directly upload files to a cloud storage system such as Amazon S3. File Metadata In addition to reading and writing files, Laravel can also provide information about the files themselves. For example, the size method may be used to get the size of a file in bytes: 1 use Illuminate\Support\Facades\ Storage ; 2 3 $size = Storage :: size ( ' file.jpg ' ); The lastModified method returns the UNIX timestamp of the last time the file was modified: 1 $time = Storage :: lastModified ( ' file.jpg ' ); The MIME type of a given file may be obtained via the mimeType method: 1 $mime = Storage :: mimeType ( ' file.jpg ' ); File Paths You may use the path method to get the path for a given file. If you are using the local driver, this will return the absolute path to the file. If you are using the s3 driver, this method will return the relative path to the file in the S3 bucket: 1 use Illuminate\Support\Facades\ Storage ; 2 3 $path = Storage :: path ( ' file.jpg ' ); Storing Files The put method may be used to store file contents on a disk. You may also pass a PHP resource to the put method, which will use Flysystem's underlying stream support. Remember, all file paths should be specified relative to the "root" location configured for the disk: 1 use Illuminate\Support\Facades\ Storage ; 2 3 Storage :: put ( ' file.jpg ' , $contents ); 4 5 Storage :: put ( ' file.jpg ' , $resource ); Failed Writes If the put method (or other "write" operations) is unable to write the file to disk, false will be returned: 1 if ( ! Storage :: put ( ' file.jpg ' , $contents )) { 2 // The file could not be written to disk... 3 } If you wish, you may define the throw option within your filesystem disk's configuration array. When this option is defined as true , "write" methods such as put will throw an instance of League\Flysystem\UnableToWriteFile when write operations fail: 1 ' public ' => [ 2 ' driver ' => ' local ' , 3 // ... 4 ' throw ' => true , 5 ], Prepending and Appending To Files The prepend and append methods allow you to write to the beginning or end of a file: 1 Storage :: prepend ( ' file.log ' , ' Prepended Text ' ); 2 3 Storage :: append ( ' file.log ' , ' Appended Text ' ); Copying and Moving Files The copy method may be used to copy an existing file to a new location on the disk, while the move method may be used to rename or move an existing file to a new location: 1 Storage :: copy ( ' old/file.jpg ' , ' new/file.jpg ' ); 2 3 Storage :: move ( ' old/file.jpg ' , ' new/file.jpg ' ); Automatic Streaming Streaming files to storage offers significantly reduced memory usage. If you would like Laravel to automatically manage streaming a given file to your storage location, you may use the putFile or putFileAs method. This method accepts either an Illuminate\Http\File or Illuminate\Http\UploadedFile instance and will automatically stream the file to your desired location: 1 use Illuminate\Http\ File ; 2 use Illuminate\Support\Facades\ Storage ; 3 4 // Automatically generate a unique ID for filename... 5 $path = Storage :: putFile ( ' photos ' , new File ( ' /path/to/photo ' )); 6 7 // Manually specify a filename... 8 $path = Storage :: putFileAs ( ' photos ' , new File ( ' /path/to/photo ' ), ' photo.jpg ' ); There are a few important things to note about the putFile method. Note that we only specified a directory name and not a filename. By default, the putFile method will generate a unique ID to serve as the filename. The file's extension will be determined by examining the file's MIME type. The path to the file will be returned by the putFile method so you can store the path, including the generated filename, in your database. The putFile and putFileAs methods also accept an argument to specify the "visibility" of the stored file. This is particularly useful if you are storing the file on a cloud disk such as Amazon S3 and would like the file to be publicly accessible via generated URLs: 1 Storage :: putFile ( ' photos ' , new File ( ' /path/to/photo ' ), ' public ' ); File Uploads In web applications, one of the most common use-cases for storing files is storing user uploaded files such as photos and documents. Laravel makes it very easy to store uploaded files using the store method on an uploaded file instance. Call the store method with the path at which you wish to store the uploaded file: 1 <?php 2 3 namespace App\Http\Controllers; 4 5 use Illuminate\Http\ Request ; 6 7 class UserAvatarController extends Controller 8 { 9 /* 10 * Update the avatar for the user. 11 / 12 public function update ( Request $request ) : string 13 { 14 $path = $request -> file ( ' avatar ' ) -> store ( ' avatars ' ); 15 16 return $path ; 17 } 18 } There are a few important things to note about this example. Note that we only specified a directory name, not a filename. By default, the store method will generate a unique ID to serve as the filename. The file's extension will be determined by examining the file's MIME type. The path to the file will be returned by the store method so you can store the path, including the generated filename, in your database. You may also call the putFile method on the Storage facade to perform the same file storage operation as the example above: 1 $path = Storage :: putFile ( ' avatars ' , $request -> file ( ' avatar ' )); Specifying a File Name If you do not want a filename to be automatically assigned to your stored file, you may use the storeAs method, which receives the path, the filename, and the (optional) disk as its arguments: 1 $path = $request -> file ( ' avatar ' ) -> storeAs ( 2 ' avatars ' , $request -> user () ->id 3 ); You may also use the putFileAs method on the Storage facade, which will perform the same file storage operation as the example above: 1 $path = Storage :: putFileAs ( 2 ' avatars ' , $request -> file ( ' avatar ' ), $request -> user () ->id 3 ); Unprintable and invalid unicode characters will automatically be removed from file paths. Therefore, you may wish to sanitize your file paths before passing them to Laravel's file storage methods. File paths are normalized using the League\Flysystem\WhitespacePathNormalizer::normalizePath method. Specifying a Disk By default, this uploaded file's store method will use your default disk. If you would like to specify another disk, pass the disk name as the second argument to the store method: 1 $path = $request -> file ( ' avatar ' ) -> store ( 2 ' avatars/ ' . $request -> user () ->id , ' s3 ' 3 ); If you are using the storeAs method, you may pass the disk name as the third argument to the method: 1 $path = $request -> file ( ' avatar ' ) -> storeAs ( 2 ' avatars ' , 3 $request -> user () ->id , 4 ' s3 ' 5 ); Other Uploaded File Information If you would like to get the original name and extension of the uploaded file, you may do so using the getClientOriginalName and getClientOriginalExtension methods: 1 $file = $request -> file ( ' avatar ' ); 2 3 $name = $file -> getClientOriginalName (); 4 $extension = $file -> getClientOriginalExtension (); However, keep in mind that the getClientOriginalName and getClientOriginalExtension methods are considered unsafe, as the file name and extension may be tampered with by a malicious user. For this reason, you should typically prefer the hashName and extension methods to get a name and an extension for the given file upload: 1 $file = $request -> file ( ' avatar ' ); 2 3 $name = $file -> hashName (); // Generate a unique, random name... 4 $extension = $file -> extension (); // Determine the file's extension based on the file's MIME type... File Visibility In Laravel's Flysystem integration, "visibility" is an abstraction of file permissions across multiple platforms. Files may either be declared public or private . When a file is declared public , you are indicating that the file should generally be accessible to others. For example, when using the S3 driver, you may retrieve URLs for public files. You can set the visibility when writing the file via the put method: 1 use Illuminate\Support\Facades\ Storage ; 2 3 Storage :: put ( ' file.jpg ' , $contents , ' public ' ); If the file has already been stored, its visibility can be retrieved and set via the getVisibility and setVisibility methods: 1 $visibility = Storage :: getVisibility ( ' file.jpg ' ); 2 3 Storage :: setVisibility ( ' file.jpg ' , ' public ' ); When interacting with uploaded files, you may use the storePublicly and storePubliclyAs methods to store the uploaded file with public visibility: 1 $path = $request -> file ( ' avatar ' ) -> storePublicly ( ' avatars ' , ' s3 ' ); 2 3 $path = $request -> file ( ' avatar ' ) -> storePubliclyAs ( 4 ' avatars ' , 5 $request -> user () ->id , 6 ' s3 ' 7 ); Local Files and Visibility When using the local driver, public visibility translates to 0755 permissions for directories and 0644 permissions for files. You can modify the permissions mappings in your application's filesystems configuration file: 1 ' local ' => [ 2 ' driver ' => ' local ' , 3 ' root ' => storage_path ( ' app ' ), 4 ' permissions ' => [ 5 ' file ' => [ 6 ' public ' => 0644 , 7 ' private ' => 0600 , 8 ], 9 ' dir ' => [ 10 ' public ' => 0755 , 11 ' private ' => 0700 , 12 ], 13 ], 14 ' throw ' => false , 15 ], Deleting Files The delete method accepts a single filename or an array of files to delete: 1 use Illuminate\Support\Facades\ Storage ; 2 3 Storage :: delete ( ' file.jpg ' ); 4 5 Storage :: delete ([ ' file.jpg ' , ' file2.jpg ' ]); If necessary, you may specify the disk that the file should be deleted from: 1 use Illuminate\Support\Facades\ Storage ; 2 3 Storage :: disk ( ' s3 ' ) -> delete ( ' path/file.jpg ' ); Directories Get All Files Within a Directory The files method returns an array of all files within a given directory. If you would like to retrieve a list of all files within a given directory including subdirectories, you may use the allFiles method: 1 use Illuminate\Support\Facades\ Storage ; 2 3 $files = Storage :: files ( $directory ); 4 5 $files = Storage :: allFiles ( $directory ); Get All Directories Within a Directory The directories method returns an array of all directories within a given directory. If you would like to retrieve a list of all directories within a given directory including subdirectories, you may use the allDirectories method: 1 $directories = Storage :: directories ( $directory ); 2 3 $directories = Storage :: allDirectories ( $directory ); Create a Directory The makeDirectory method will create the given directory, including any needed subdirectories: 1 Storage :: makeDirectory ( $directory ); Delete a Directory Finally, the deleteDirectory method may be used to remove a directory and all of its files: 1 Storage :: deleteDirectory ( $directory ); Testing The Storage facade's fake method allows you to easily generate a fake disk that, combined with the file generation utilities of the Illuminate\Http\UploadedFile class, greatly simplifies the testing of file uploads. For example: 1 <?php 2 3 use Illuminate\Http\ UploadedFile ; 4 use Illuminate\Support\Facades\ Storage ; 5 6 test ( ' albums can be uploaded ' , function () { 7 Storage :: fake ( ' photos ' ); 8 9 $ response = $ this -> json ( ' POST ' , ' /photos ' , [ 10 UploadedFile :: fake () -> image ( ' photo1.jpg ' ), 11 UploadedFile :: fake () -> image ( ' photo2.jpg ' ) 12 ]); 13 14 // Assert one or more files were stored... 15 Storage :: disk ( ' photos ' ) -> assertExists ( ' photo1.jpg ' ); 16 Storage :: disk ( ' photos ' ) -> assertExists ([ ' photo1.jpg ' , ' photo2.jpg ' ]); 17 18 // Assert one or more files were not stored... 19 Storage :: disk ( ' photos ' ) -> assertMissing ( ' missing.jpg ' ); 20 Storage :: disk ( ' photos ' ) -> assertMissing ([ ' missing.jpg ' , ' non-existing.jpg ' ]); 21 22 // Assert that the number of files in a given directory matches the expected count... 23 Storage :: disk ( ' photos ' ) -> assertCount ( ' /wallpapers ' , 2 ); 24 25 // Assert that a given directory is empty... 26 Storage :: disk ( ' photos ' ) -> assertDirectoryEmpty ( ' /wallpapers ' ); 27 }); 1 <?php 2 3 namespace Tests\Feature; 4 5 use Illuminate\Http\ UploadedFile ; 6 use Illuminate\Support\Facades\ Storage ; 7 use Tests\ TestCase ; 8 9 class ExampleTest extends TestCase 10 { 11 public function test_albums_can_be_uploaded () : void 12 { 13 Storage :: fake ( ' photos ' ); 14 15 $response = $this -> json ( ' POST ' , ' /photos ' , [ 16 UploadedFile :: fake () -> image ( ' photo1.jpg ' ), 17 UploadedFile :: fake () -> image ( ' photo2.jpg ' ) 18 ]); 19 20 // Assert one or more files were stored... 21 Storage :: disk ( ' photos ' ) -> assertExists ( ' photo1.jpg ' ); 22 Storage :: disk ( ' photos ' ) -> assertExists ([ ' photo1.jpg ' , ' photo2.jpg ' ]); 23 24 // Assert one or more files were not stored... 25 Storage :: disk ( ' photos ' ) -> assertMissing ( ' missing.jpg ' ); 26 Storage :: disk ( ' photos ' ) -> assertMissing ([ ' missing.jpg ' , ' non-existing.jpg ' ]); 27 28 // Assert that the number of files in a given directory matches the expected count... 29 Storage :: disk ( ' photos ' ) -> assertCount ( ' /wallpapers ' , 2 ); 30 31 // Assert that a given directory is empty... 32 Storage :: disk ( ' photos ' ) -> assertDirectoryEmpty ( ' /wallpapers ' ); 33 } 34 } By default, the fake method will delete all files in its temporary directory. If you would like to keep these files, you may use the "persistentFake" method instead. For more information on testing file uploads, you may consult the HTTP testing documentation's information on file uploads . The image method requires the GD extension . Custom Filesystems Laravel's Flysystem integration provides support for several "drivers" out of the box; however, Flysystem is not limited to these and has adapters for many other storage systems. You can create a custom driver if you want to use one of these additional adapters in your Laravel application. In order to define a custom filesystem you will need a Flysystem adapter. Let's add a community maintained Dropbox adapter to our project: 1 composer require spatie/flysystem-dropbox Next, you can register the driver within the boot method of one of your application's service providers . To accomplish this, you should use the extend method of the Storage facade: 1 <?php 2 3 namespace App\Providers; 4 5 use Illuminate\Contracts\Foundation\ Application ; 6 use Illuminate\Filesystem\ FilesystemAdapter ; 7 use Illuminate\Support\Facades\ Storage ; 8 use Illuminate\Support\ ServiceProvider ; 9 use League\Flysystem\ Filesystem ; 10 use Spatie\Dropbox\ Client as DropboxClient; 11 use Spatie\FlysystemDropbox\ DropboxAdapter ; 12 13 class AppServiceProvider extends ServiceProvider 14 { 15 /* 16 * Register any application services. 17 / 18 public function register () : void 19 { 20 // ... 21 } 22 23 /* 24 * Bootstrap any application services. 25 */ 26 public function boot () : void 27 { 28 Storage :: extend ( ' dropbox ' , function ( Application $app , array $config ) { 29 $adapter = new DropboxAdapter ( new DropboxClient ( 30 $config [ ' authorization_token ' ] 31 )); 32 33 return new FilesystemAdapter ( 34 new Filesystem ( $adapter , $config ), 35 $adapter , 36 $config 37 ); 38 }); 39 } 40 } The first argument of the extend method is the name of the driver and the second is a closure that receives the $app and $config variables. The closure must return an instance of Illuminate\Filesystem\FilesystemAdapter . The $config variable contains the values defined in config/filesystems.php for the specified disk. Once you have created and registered the extension's service provider, you may use the dropbox driver in your config/filesystems.php configuration file.
Markdown	- [Home](https://laravel.com/) Search ```K` ⌘K Switch to light mode [Skip to content](https://laravel.com/docs/12.x/filesystem#main-content) - ## Prologue - [Release Notes](https://laravel.com/docs/12.x/releases) - [Upgrade Guide](https://laravel.com/docs/12.x/upgrade) - [Contribution Guide](https://laravel.com/docs/12.x/contributions) - ## Getting Started - [Installation](https://laravel.com/docs/12.x/installation) - [Configuration](https://laravel.com/docs/12.x/configuration) - [Agentic Development](https://laravel.com/docs/12.x/ai) - [Directory Structure](https://laravel.com/docs/12.x/structure) - [Frontend](https://laravel.com/docs/12.x/frontend) - [Starter Kits](https://laravel.com/docs/12.x/starter-kits) - [Deployment](https://laravel.com/docs/12.x/deployment) - ## Architecture Concepts - [Request Lifecycle](https://laravel.com/docs/12.x/lifecycle) - [Service Container](https://laravel.com/docs/12.x/container) - [Service Providers](https://laravel.com/docs/12.x/providers) - [Facades](https://laravel.com/docs/12.x/facades) - ## The Basics - [Routing](https://laravel.com/docs/12.x/routing) - [Middleware](https://laravel.com/docs/12.x/middleware) - [CSRF Protection](https://laravel.com/docs/12.x/csrf) - [Controllers](https://laravel.com/docs/12.x/controllers) - [Requests](https://laravel.com/docs/12.x/requests) - [Responses](https://laravel.com/docs/12.x/responses) - [Views](https://laravel.com/docs/12.x/views) - [Blade Templates](https://laravel.com/docs/12.x/blade) - [Asset Bundling](https://laravel.com/docs/12.x/vite) - [URL Generation](https://laravel.com/docs/12.x/urls) - [Session](https://laravel.com/docs/12.x/session) - [Validation](https://laravel.com/docs/12.x/validation) - [Error Handling](https://laravel.com/docs/12.x/errors) - [Logging](https://laravel.com/docs/12.x/logging) - ## Digging Deeper - [Artisan Console](https://laravel.com/docs/12.x/artisan) - [Broadcasting](https://laravel.com/docs/12.x/broadcasting) - [Cache](https://laravel.com/docs/12.x/cache) - [Collections](https://laravel.com/docs/12.x/collections) - [Concurrency](https://laravel.com/docs/12.x/concurrency) - [Context](https://laravel.com/docs/12.x/context) - [Contracts](https://laravel.com/docs/12.x/contracts) - [Events](https://laravel.com/docs/12.x/events) - [File Storage](https://laravel.com/docs/12.x/filesystem) - [Helpers](https://laravel.com/docs/12.x/helpers) - [HTTP Client](https://laravel.com/docs/12.x/http-client) - [Localization](https://laravel.com/docs/12.x/localization) - [Mail](https://laravel.com/docs/12.x/mail) - [Notifications](https://laravel.com/docs/12.x/notifications) - [Package Development](https://laravel.com/docs/12.x/packages) - [Processes](https://laravel.com/docs/12.x/processes) - [Queues](https://laravel.com/docs/12.x/queues) - [Rate Limiting](https://laravel.com/docs/12.x/rate-limiting) - [Search](https://laravel.com/docs/12.x/search) - [Strings](https://laravel.com/docs/12.x/strings) - [Task Scheduling](https://laravel.com/docs/12.x/scheduling) - ## Security - [Authentication](https://laravel.com/docs/12.x/authentication) - [Authorization](https://laravel.com/docs/12.x/authorization) - [Email Verification](https://laravel.com/docs/12.x/verification) - [Encryption](https://laravel.com/docs/12.x/encryption) - [Hashing](https://laravel.com/docs/12.x/hashing) - [Password Reset](https://laravel.com/docs/12.x/passwords) - ## Database - [Getting Started](https://laravel.com/docs/12.x/database) - [Query Builder](https://laravel.com/docs/12.x/queries) - [Pagination](https://laravel.com/docs/12.x/pagination) - [Migrations](https://laravel.com/docs/12.x/migrations) - [Seeding](https://laravel.com/docs/12.x/seeding) - [Redis](https://laravel.com/docs/12.x/redis) - [MongoDB](https://laravel.com/docs/12.x/mongodb) - ## Eloquent ORM - [Getting Started](https://laravel.com/docs/12.x/eloquent) - [Relationships](https://laravel.com/docs/12.x/eloquent-relationships) - [Collections](https://laravel.com/docs/12.x/eloquent-collections) - [Mutators / Casts](https://laravel.com/docs/12.x/eloquent-mutators) - [API Resources](https://laravel.com/docs/12.x/eloquent-resources) - [Serialization](https://laravel.com/docs/12.x/eloquent-serialization) - [Factories](https://laravel.com/docs/12.x/eloquent-factories) - ## AI - [AI SDK](https://laravel.com/docs/12.x/ai-sdk) - [MCP](https://laravel.com/docs/12.x/mcp) - [Boost](https://laravel.com/docs/12.x/boost) - ## Testing - [Getting Started](https://laravel.com/docs/12.x/testing) - [HTTP Tests](https://laravel.com/docs/12.x/http-tests) - [Console Tests](https://laravel.com/docs/12.x/console-tests) - [Browser Tests](https://laravel.com/docs/12.x/dusk) - [Database](https://laravel.com/docs/12.x/database-testing) - [Mocking](https://laravel.com/docs/12.x/mocking) - ## Packages - [Cashier (Stripe)](https://laravel.com/docs/12.x/billing) - [Cashier (Paddle)](https://laravel.com/docs/12.x/cashier-paddle) - [Dusk](https://laravel.com/docs/12.x/dusk) - [Envoy](https://laravel.com/docs/12.x/envoy) - [Fortify](https://laravel.com/docs/12.x/fortify) - [Folio](https://laravel.com/docs/12.x/folio) - [Homestead](https://laravel.com/docs/12.x/homestead) - [Horizon](https://laravel.com/docs/12.x/horizon) - [Mix](https://laravel.com/docs/12.x/mix) - [Octane](https://laravel.com/docs/12.x/octane) - [Passport](https://laravel.com/docs/12.x/passport) - [Pennant](https://laravel.com/docs/12.x/pennant) - [Pint](https://laravel.com/docs/12.x/pint) - [Precognition](https://laravel.com/docs/12.x/precognition) - [Prompts](https://laravel.com/docs/12.x/prompts) - [Pulse](https://laravel.com/docs/12.x/pulse) - [Reverb](https://laravel.com/docs/12.x/reverb) - [Sail](https://laravel.com/docs/12.x/sail) - [Sanctum](https://laravel.com/docs/12.x/sanctum) - [Scout](https://laravel.com/docs/12.x/scout) - [Socialite](https://laravel.com/docs/12.x/socialite) - [Telescope](https://laravel.com/docs/12.x/telescope) - [Valet](https://laravel.com/docs/12.x/valet) - ## [API Documentation](https://api.laravel.com/docs/12.x/index.html) - ## [Changelog](https://laravel.com/docs/changelog) > WARNING You're browsing the documentation for an old version of Laravel. Consider upgrading your project to [Laravel 13.x](https://laravel.com/docs/13.x/filesystem). # File Storage - [Introduction](https://laravel.com/docs/12.x/filesystem#introduction) - [Configuration](https://laravel.com/docs/12.x/filesystem#configuration) - [The Local Driver](https://laravel.com/docs/12.x/filesystem#the-local-driver) - [The Public Disk](https://laravel.com/docs/12.x/filesystem#the-public-disk) - [Driver Prerequisites](https://laravel.com/docs/12.x/filesystem#driver-prerequisites) - [Scoped and Read-Only Filesystems](https://laravel.com/docs/12.x/filesystem#scoped-and-read-only-filesystems) - [Amazon S3 Compatible Filesystems](https://laravel.com/docs/12.x/filesystem#amazon-s3-compatible-filesystems) - [Obtaining Disk Instances](https://laravel.com/docs/12.x/filesystem#obtaining-disk-instances) - [On-Demand Disks](https://laravel.com/docs/12.x/filesystem#on-demand-disks) - [Retrieving Files](https://laravel.com/docs/12.x/filesystem#retrieving-files) - [Downloading Files](https://laravel.com/docs/12.x/filesystem#downloading-files) - [File URLs](https://laravel.com/docs/12.x/filesystem#file-urls) - [Temporary URLs](https://laravel.com/docs/12.x/filesystem#temporary-urls) - [File Metadata](https://laravel.com/docs/12.x/filesystem#file-metadata) - [Storing Files](https://laravel.com/docs/12.x/filesystem#storing-files) - [Prepending and Appending To Files](https://laravel.com/docs/12.x/filesystem#prepending-appending-to-files) - [Copying and Moving Files](https://laravel.com/docs/12.x/filesystem#copying-moving-files) - [Automatic Streaming](https://laravel.com/docs/12.x/filesystem#automatic-streaming) - [File Uploads](https://laravel.com/docs/12.x/filesystem#file-uploads) - [File Visibility](https://laravel.com/docs/12.x/filesystem#file-visibility) - [Deleting Files](https://laravel.com/docs/12.x/filesystem#deleting-files) - [Directories](https://laravel.com/docs/12.x/filesystem#directories) - [Testing](https://laravel.com/docs/12.x/filesystem#testing) - [Custom Filesystems](https://laravel.com/docs/12.x/filesystem#custom-filesystems) ## [Introduction](https://laravel.com/docs/12.x/filesystem#introduction) Laravel provides a powerful filesystem abstraction thanks to the wonderful [Flysystem](https://github.com/thephpleague/flysystem) PHP package by Frank de Jonge. The Laravel Flysystem integration provides simple drivers for working with local filesystems, SFTP, and Amazon S3. Even better, it's amazingly simple to switch between these storage options between your local development machine and production server as the API remains the same for each system. ## [Configuration](https://laravel.com/docs/12.x/filesystem#configuration) Laravel's filesystem configuration file is located at `config/filesystems.php`. Within this file, you may configure all of your filesystem "disks". Each disk represents a particular storage driver and storage location. Example configurations for each supported driver are included in the configuration file so you can modify the configuration to reflect your storage preferences and credentials. The `local` driver interacts with files stored locally on the server running the Laravel application, while the `sftp` storage driver is used for SSH key-based FTP. The `s3` driver is used to write to Amazon's S3 cloud storage service. You may configure as many disks as you like and may even have multiple disks that use the same driver. ### [The Local Driver](https://laravel.com/docs/12.x/filesystem#the-local-driver) When using the `local` driver, all file operations are relative to the `root` directory defined in your `filesystems` configuration file. By default, this value is set to the `storage/app/private` directory. Therefore, the following method would write to `storage/app/private/example.txt`: ``` 1use Illuminate\Support\Facades\Storage;23Storage::disk('local')->put('example.txt', 'Contents');use Illuminate\Support\Facades\Storage; Storage::disk('local')->put('example.txt', 'Contents'); ``` ### [The Public Disk](https://laravel.com/docs/12.x/filesystem#the-public-disk) The `public` disk included in your application's `filesystems` configuration file is intended for files that are going to be publicly accessible. By default, the `public` disk uses the `local` driver and stores its files in `storage/app/public`. If your `public` disk uses the `local` driver and you want to make these files accessible from the web, you should create a symbolic link from source directory `storage/app/public` to target directory `public/storage`: To create the symbolic link, you may use the `storage:link` Artisan command: ``` 1php artisan storage:linkphp artisan storage:link ``` Once a file has been stored and the symbolic link has been created, you can create a URL to the files using the `asset` helper: ``` 1echo asset('storage/file.txt');echo asset('storage/file.txt'); ``` You may configure additional symbolic links in your `filesystems` configuration file. Each of the configured links will be created when you run the `storage:link` command: ``` 1'links' => [2 public_path('storage') => storage_path('app/public'),3 public_path('images') => storage_path('app/images'),4],'links' => [ public_path('storage') => storage_path('app/public'), public_path('images') => storage_path('app/images'), ], ``` The `storage:unlink` command may be used to destroy your configured symbolic links: ``` 1php artisan storage:unlinkphp artisan storage:unlink ``` ### [Driver Prerequisites](https://laravel.com/docs/12.x/filesystem#driver-prerequisites) #### [S3 Driver Configuration](https://laravel.com/docs/12.x/filesystem#s3-driver-configuration) Before using the S3 driver, you will need to install the Flysystem S3 package via the Composer package manager: ``` 1composer require league/flysystem-aws-s3-v3 "^3.0" --with-all-dependenciescomposer require league/flysystem-aws-s3-v3 "^3.0" --with-all-dependencies ``` An S3 disk configuration array is located in your `config/filesystems.php` configuration file. Typically, you should configure your S3 information and credentials using the following environment variables which are referenced by the `config/filesystems.php` configuration file: ``` 1AWS_ACCESS_KEY_ID=<your-key-id>2AWS_SECRET_ACCESS_KEY=<your-secret-access-key>3AWS_DEFAULT_REGION=us-east-14AWS_BUCKET=<your-bucket-name>5AWS_USE_PATH_STYLE_ENDPOINT=falseAWS_ACCESS_KEY_ID=<your-key-id> AWS_SECRET_ACCESS_KEY=<your-secret-access-key> AWS_DEFAULT_REGION=us-east-1 AWS_BUCKET=<your-bucket-name> AWS_USE_PATH_STYLE_ENDPOINT=false ``` For convenience, these environment variables match the naming convention used by the AWS CLI. #### [FTP Driver Configuration](https://laravel.com/docs/12.x/filesystem#ftp-driver-configuration) Before using the FTP driver, you will need to install the Flysystem FTP package via the Composer package manager: ``` 1composer require league/flysystem-ftp "^3.0"composer require league/flysystem-ftp "^3.0" ``` Laravel's Flysystem integrations work great with FTP; however, a sample configuration is not included with the framework's default `config/filesystems.php` configuration file. If you need to configure an FTP filesystem, you may use the configuration example below: ``` 1'ftp' => [2 'driver' => 'ftp',3 'host' => env('FTP_HOST'),4 'username' => env('FTP_USERNAME'),5 'password' => env('FTP_PASSWORD'),67 // Optional FTP Settings...8 // 'port' => env('FTP_PORT', 21),9 // 'root' => env('FTP_ROOT'),10 // 'passive' => true,11 // 'ssl' => true,12 // 'timeout' => 30,13],'ftp' => [ 'driver' => 'ftp', 'host' => env('FTP_HOST'), 'username' => env('FTP_USERNAME'), 'password' => env('FTP_PASSWORD'), // Optional FTP Settings... // 'port' => env('FTP_PORT', 21), // 'root' => env('FTP_ROOT'), // 'passive' => true, // 'ssl' => true, // 'timeout' => 30, ], ``` #### [SFTP Driver Configuration](https://laravel.com/docs/12.x/filesystem#sftp-driver-configuration) Before using the SFTP driver, you will need to install the Flysystem SFTP package via the Composer package manager: ``` 1composer require league/flysystem-sftp-v3 "^3.0"composer require league/flysystem-sftp-v3 "^3.0" ``` Laravel's Flysystem integrations work great with SFTP; however, a sample configuration is not included with the framework's default `config/filesystems.php` configuration file. If you need to configure an SFTP filesystem, you may use the configuration example below: ``` 1'sftp' => [2 'driver' => 'sftp',3 'host' => env('SFTP_HOST'),45 // Settings for basic authentication...6 'username' => env('SFTP_USERNAME'),7 'password' => env('SFTP_PASSWORD'),89 // Settings for SSH key-based authentication with encryption password...10 'privateKey' => env('SFTP_PRIVATE_KEY'),11 'passphrase' => env('SFTP_PASSPHRASE'),1213 // Settings for file / directory permissions...14 'visibility' => 'private', // `private` = 0600, `public` = 064415 'directory_visibility' => 'private', // `private` = 0700, `public` = 07551617 // Optional SFTP Settings...18 // 'hostFingerprint' => env('SFTP_HOST_FINGERPRINT'),19 // 'maxTries' => 4,20 // 'passphrase' => env('SFTP_PASSPHRASE'),21 // 'port' => env('SFTP_PORT', 22),22 // 'root' => env('SFTP_ROOT', ''),23 // 'timeout' => 30,24 // 'useAgent' => true,25],'sftp' => [ 'driver' => 'sftp', 'host' => env('SFTP_HOST'), // Settings for basic authentication... 'username' => env('SFTP_USERNAME'), 'password' => env('SFTP_PASSWORD'), // Settings for SSH key-based authentication with encryption password... 'privateKey' => env('SFTP_PRIVATE_KEY'), 'passphrase' => env('SFTP_PASSPHRASE'), // Settings for file / directory permissions... 'visibility' => 'private', // `private` = 0600, `public` = 0644 'directory_visibility' => 'private', // `private` = 0700, `public` = 0755 // Optional SFTP Settings... // 'hostFingerprint' => env('SFTP_HOST_FINGERPRINT'), // 'maxTries' => 4, // 'passphrase' => env('SFTP_PASSPHRASE'), // 'port' => env('SFTP_PORT', 22), // 'root' => env('SFTP_ROOT', ''), // 'timeout' => 30, // 'useAgent' => true, ], ``` ### [Scoped and Read-Only Filesystems](https://laravel.com/docs/12.x/filesystem#scoped-and-read-only-filesystems) Scoped disks allow you to define a filesystem where all paths are automatically prefixed with a given path prefix. Before creating a scoped filesystem disk, you will need to install an additional Flysystem package via the Composer package manager: ``` 1composer require league/flysystem-path-prefixing "^3.0"composer require league/flysystem-path-prefixing "^3.0" ``` You may create a path scoped instance of any existing filesystem disk by defining a disk that utilizes the `scoped` driver. For example, you may create a disk which scopes your existing `s3` disk to a specific path prefix, and then every file operation using your scoped disk will utilize the specified prefix: ``` 1's3-videos' => [2 'driver' => 'scoped',3 'disk' => 's3',4 'prefix' => 'path/to/videos',5],'s3-videos' => [ 'driver' => 'scoped', 'disk' => 's3', 'prefix' => 'path/to/videos', ], ``` "Read-only" disks allow you to create filesystem disks that do not allow write operations. Before using the `read-only` configuration option, you will need to install an additional Flysystem package via the Composer package manager: ``` 1composer require league/flysystem-read-only "^3.0"composer require league/flysystem-read-only "^3.0" ``` Next, you may include the `read-only` configuration option in one or more of your disk's configuration arrays: ``` 1's3-videos' => [2 'driver' => 's3',3 // ...4 'read-only' => true,5],'s3-videos' => [ 'driver' => 's3', // ... 'read-only' => true, ], ``` ### [Amazon S3 Compatible Filesystems](https://laravel.com/docs/12.x/filesystem#amazon-s3-compatible-filesystems) By default, your application's `filesystems` configuration file contains a disk configuration for the `s3` disk. In addition to using this disk to interact with [Amazon S3](https://aws.amazon.com/s3/), you may use it to interact with any S3-compatible file storage service such as [RustFS](https://github.com/rustfs/rustfs), [DigitalOcean Spaces](https://www.digitalocean.com/products/spaces/), [Vultr Object Storage](https://www.vultr.com/products/object-storage/), [Cloudflare R2](https://www.cloudflare.com/developer-platform/products/r2/), or [Hetzner Cloud Storage](https://www.hetzner.com/storage/object-storage/). Typically, after updating the disk's credentials to match the credentials of the service you are planning to use, you only need to update the value of the `endpoint` configuration option. This option's value is typically defined via the `AWS_ENDPOINT` environment variable: ``` 1'endpoint' => env('AWS_ENDPOINT', 'https://rustfs:9000'),'endpoint' => env('AWS_ENDPOINT', 'https://rustfs:9000'), ``` ## [Obtaining Disk Instances](https://laravel.com/docs/12.x/filesystem#obtaining-disk-instances) The `Storage` facade may be used to interact with any of your configured disks. For example, you may use the `put` method on the facade to store an avatar on the default disk. If you call methods on the `Storage` facade without first calling the `disk` method, the method will automatically be passed to the default disk: ``` 1use Illuminate\Support\Facades\Storage;23Storage::put('avatars/1', $content);use Illuminate\Support\Facades\Storage; Storage::put('avatars/1', $content); ``` If your application interacts with multiple disks, you may use the `disk` method on the `Storage` facade to work with files on a particular disk: ``` 1Storage::disk('s3')->put('avatars/1', $content);Storage::disk('s3')->put('avatars/1', $content); ``` ### [On-Demand Disks](https://laravel.com/docs/12.x/filesystem#on-demand-disks) Sometimes you may wish to create a disk at runtime using a given configuration without that configuration actually being present in your application's `filesystems` configuration file. To accomplish this, you may pass a configuration array to the `Storage` facade's `build` method: ``` 1use Illuminate\Support\Facades\Storage;23$disk = Storage::build([4 'driver' => 'local',5 'root' => '/path/to/root',6]);78$disk->put('image.jpg', $content);use Illuminate\Support\Facades\Storage; $disk = Storage::build([ 'driver' => 'local', 'root' => '/path/to/root', ]); $disk->put('image.jpg', $content); ``` ## [Retrieving Files](https://laravel.com/docs/12.x/filesystem#retrieving-files) The `get` method may be used to retrieve the contents of a file. The raw string contents of the file will be returned by the method. Remember, all file paths should be specified relative to the disk's "root" location: ``` 1$contents = Storage::get('file.jpg');$contents = Storage::get('file.jpg'); ``` If the file you are retrieving contains JSON, you may use the `json` method to retrieve the file and decode its contents: ``` 1$orders = Storage::json('orders.json');$orders = Storage::json('orders.json'); ``` The `exists` method may be used to determine if a file exists on the disk: ``` 1if (Storage::disk('s3')->exists('file.jpg')) {2 // ...3}if (Storage::disk('s3')->exists('file.jpg')) { // ... } ``` The `missing` method may be used to determine if a file is missing from the disk: ``` 1if (Storage::disk('s3')->missing('file.jpg')) {2 // ...3}if (Storage::disk('s3')->missing('file.jpg')) { // ... } ``` ### [Downloading Files](https://laravel.com/docs/12.x/filesystem#downloading-files) The `download` method may be used to generate a response that forces the user's browser to download the file at the given path. The `download` method accepts a filename as the second argument to the method, which will determine the filename that is seen by the user downloading the file. Finally, you may pass an array of HTTP headers as the third argument to the method: ``` 1return Storage::download('file.jpg');23return Storage::download('file.jpg', $name, $headers);return Storage::download('file.jpg'); return Storage::download('file.jpg', $name, $headers); ``` ### [File URLs](https://laravel.com/docs/12.x/filesystem#file-urls) You may use the `url` method to get the URL for a given file. If you are using the `local` driver, this will typically just prepend `/storage` to the given path and return a relative URL to the file. If you are using the `s3` driver, the fully qualified remote URL will be returned: ``` 1use Illuminate\Support\Facades\Storage;23$url = Storage::url('file.jpg');use Illuminate\Support\Facades\Storage; $url = Storage::url('file.jpg'); ``` When using the `local` driver, all files that should be publicly accessible should be placed in the `storage/app/public` directory. Furthermore, you should [create a symbolic link](https://laravel.com/docs/12.x/filesystem#the-public-disk) at `public/storage` which points to the `storage/app/public` directory. When using the `local` driver, the return value of `url` is not URL encoded. For this reason, we recommend always storing your files using names that will create valid URLs. #### [URL Host Customization](https://laravel.com/docs/12.x/filesystem#url-host-customization) If you would like to modify the host for URLs generated using the `Storage` facade, you may add or change the `url` option in the disk's configuration array: ``` 1'public' => [2 'driver' => 'local',3 'root' => storage_path('app/public'),4 'url' => env('APP_URL').'/storage',5 'visibility' => 'public',6 'throw' => false,7],'public' => [ 'driver' => 'local', 'root' => storage_path('app/public'), 'url' => env('APP_URL').'/storage', 'visibility' => 'public', 'throw' => false, ], ``` ### [Temporary URLs](https://laravel.com/docs/12.x/filesystem#temporary-urls) Using the `temporaryUrl` method, you may create temporary URLs to files stored using the `local` and `s3` drivers. This method accepts a path and a `DateTime` instance specifying when the URL should expire: ``` 1use Illuminate\Support\Facades\Storage;23$url = Storage::temporaryUrl(4 'file.jpg', now()->plus(minutes: 5)5);use Illuminate\Support\Facades\Storage; $url = Storage::temporaryUrl( 'file.jpg', now()->plus(minutes: 5) ); ``` #### [Enabling Local Temporary URLs](https://laravel.com/docs/12.x/filesystem#enabling-local-temporary-urls) If you started developing your application before support for temporary URLs was introduced to the `local` driver, you may need to enable local temporary URLs. To do so, add the `serve` option to your `local` disk's configuration array within the `config/filesystems.php` configuration file: ``` 1'local' => [2 'driver' => 'local',3 'root' => storage_path('app/private'),4 'serve' => true,5 'throw' => false,6],'local' => [ 'driver' => 'local', 'root' => storage_path('app/private'), 'serve' => true, 'throw' => false, ], ``` #### [S3 Request Parameters](https://laravel.com/docs/12.x/filesystem#s3-request-parameters) If you need to specify additional [S3 request parameters](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectGET.html#RESTObjectGET-requests), you may pass the array of request parameters as the third argument to the `temporaryUrl` method: ``` 1$url = Storage::temporaryUrl(2 'file.jpg',3 now()->plus(minutes: 5),4 [5 'ResponseContentType' => 'application/octet-stream',6 'ResponseContentDisposition' => 'attachment; filename=file2.jpg',7 ]8);$url = Storage::temporaryUrl( 'file.jpg', now()->plus(minutes: 5), [ 'ResponseContentType' => 'application/octet-stream', 'ResponseContentDisposition' => 'attachment; filename=file2.jpg', ] ); ``` #### [Customizing Temporary URLs](https://laravel.com/docs/12.x/filesystem#customizing-temporary-urls) If you need to customize how temporary URLs are created for a specific storage disk, you can use the `buildTemporaryUrlsUsing` method. For example, this can be useful if you have a controller that allows you to download files stored via a disk that doesn't typically support temporary URLs. Usually, this method should be called from the `boot` method of a service provider: ``` 1<?php23namespace App\Providers;45use DateTime;6use Illuminate\Support\Facades\Storage;7use Illuminate\Support\Facades\URL;8use Illuminate\Support\ServiceProvider;910class AppServiceProvider extends ServiceProvider11{12 /*13 Bootstrap any application services.14 /15 public function boot(): void16 {17 Storage::disk('local')->buildTemporaryUrlsUsing(18 function (string $path, DateTime $expiration, array $options) {19 return URL::temporarySignedRoute(20 'files.download',21 $expiration,22 array_merge($options, ['path' => $path])23 );24 }25 );26 }27}<?php namespace App\Providers; use DateTime; use Illuminate\Support\Facades\Storage; use Illuminate\Support\Facades\URL; use Illuminate\Support\ServiceProvider; class AppServiceProvider extends ServiceProvider { /* * Bootstrap any application services. / public function boot(): void { Storage::disk('local')->buildTemporaryUrlsUsing( function (string $path, DateTime $expiration, array $options) { return URL::temporarySignedRoute( 'files.download', $expiration, array_merge($options, ['path' => $path]) ); } ); } } ``` #### [Temporary Upload URLs](https://laravel.com/docs/12.x/filesystem#temporary-upload-urls) The ability to generate temporary upload URLs is only supported by the `s3` and `local` drivers. If you need to generate a temporary URL that can be used to upload a file directly from your client-side application, you may use the `temporaryUploadUrl` method. This method accepts a path and a `DateTime` instance specifying when the URL should expire. The `temporaryUploadUrl` method returns an associative array which may be destructured into the upload URL and the headers that should be included with the upload request: ``` 1use Illuminate\Support\Facades\Storage;23['url' => $url, 'headers' => $headers] = Storage::temporaryUploadUrl(4 'file.jpg', now()->plus(minutes: 5)5);use Illuminate\Support\Facades\Storage; ['url' => $url, 'headers' => $headers] = Storage::temporaryUploadUrl( 'file.jpg', now()->plus(minutes: 5) ); ``` This method is primarily useful in serverless environments that require the client-side application to directly upload files to a cloud storage system such as Amazon S3. ### [File Metadata](https://laravel.com/docs/12.x/filesystem#file-metadata) In addition to reading and writing files, Laravel can also provide information about the files themselves. For example, the `size` method may be used to get the size of a file in bytes: ``` 1use Illuminate\Support\Facades\Storage;23$size = Storage::size('file.jpg');use Illuminate\Support\Facades\Storage; $size = Storage::size('file.jpg'); ``` The `lastModified` method returns the UNIX timestamp of the last time the file was modified: ``` 1$time = Storage::lastModified('file.jpg');$time = Storage::lastModified('file.jpg'); ``` The MIME type of a given file may be obtained via the `mimeType` method: ``` 1$mime = Storage::mimeType('file.jpg');$mime = Storage::mimeType('file.jpg'); ``` #### [File Paths](https://laravel.com/docs/12.x/filesystem#file-paths) You may use the `path` method to get the path for a given file. If you are using the `local` driver, this will return the absolute path to the file. If you are using the `s3` driver, this method will return the relative path to the file in the S3 bucket: ``` 1use Illuminate\Support\Facades\Storage;23$path = Storage::path('file.jpg');use Illuminate\Support\Facades\Storage; $path = Storage::path('file.jpg'); ``` ## [Storing Files](https://laravel.com/docs/12.x/filesystem#storing-files) The `put` method may be used to store file contents on a disk. You may also pass a PHP `resource` to the `put` method, which will use Flysystem's underlying stream support. Remember, all file paths should be specified relative to the "root" location configured for the disk: ``` 1use Illuminate\Support\Facades\Storage;23Storage::put('file.jpg', $contents);45Storage::put('file.jpg', $resource);use Illuminate\Support\Facades\Storage; Storage::put('file.jpg', $contents); Storage::put('file.jpg', $resource); ``` #### [Failed Writes](https://laravel.com/docs/12.x/filesystem#failed-writes) If the `put` method (or other "write" operations) is unable to write the file to disk, `false` will be returned: ``` 1if (! Storage::put('file.jpg', $contents)) {2 // The file could not be written to disk...3}if (! Storage::put('file.jpg', $contents)) { // The file could not be written to disk... } ``` If you wish, you may define the `throw` option within your filesystem disk's configuration array. When this option is defined as `true`, "write" methods such as `put` will throw an instance of `League\Flysystem\UnableToWriteFile` when write operations fail: ``` 1'public' => [2 'driver' => 'local',3 // ...4 'throw' => true,5],'public' => [ 'driver' => 'local', // ... 'throw' => true, ], ``` ### [Prepending and Appending To Files](https://laravel.com/docs/12.x/filesystem#prepending-appending-to-files) The `prepend` and `append` methods allow you to write to the beginning or end of a file: ``` 1Storage::prepend('file.log', 'Prepended Text');23Storage::append('file.log', 'Appended Text');Storage::prepend('file.log', 'Prepended Text'); Storage::append('file.log', 'Appended Text'); ``` ### [Copying and Moving Files](https://laravel.com/docs/12.x/filesystem#copying-moving-files) The `copy` method may be used to copy an existing file to a new location on the disk, while the `move` method may be used to rename or move an existing file to a new location: ``` 1Storage::copy('old/file.jpg', 'new/file.jpg');23Storage::move('old/file.jpg', 'new/file.jpg');Storage::copy('old/file.jpg', 'new/file.jpg'); Storage::move('old/file.jpg', 'new/file.jpg'); ``` ### [Automatic Streaming](https://laravel.com/docs/12.x/filesystem#automatic-streaming) Streaming files to storage offers significantly reduced memory usage. If you would like Laravel to automatically manage streaming a given file to your storage location, you may use the `putFile` or `putFileAs` method. This method accepts either an `Illuminate\Http\File` or `Illuminate\Http\UploadedFile` instance and will automatically stream the file to your desired location: ``` 1use Illuminate\Http\File;2use Illuminate\Support\Facades\Storage;34// Automatically generate a unique ID for filename...5$path = Storage::putFile('photos', new File('/path/to/photo'));67// Manually specify a filename...8$path = Storage::putFileAs('photos', new File('/path/to/photo'), 'photo.jpg');use Illuminate\Http\File; use Illuminate\Support\Facades\Storage; // Automatically generate a unique ID for filename... $path = Storage::putFile('photos', new File('/path/to/photo')); // Manually specify a filename... $path = Storage::putFileAs('photos', new File('/path/to/photo'), 'photo.jpg'); ``` There are a few important things to note about the `putFile` method. Note that we only specified a directory name and not a filename. By default, the `putFile` method will generate a unique ID to serve as the filename. The file's extension will be determined by examining the file's MIME type. The path to the file will be returned by the `putFile` method so you can store the path, including the generated filename, in your database. The `putFile` and `putFileAs` methods also accept an argument to specify the "visibility" of the stored file. This is particularly useful if you are storing the file on a cloud disk such as Amazon S3 and would like the file to be publicly accessible via generated URLs: ``` 1Storage::putFile('photos', new File('/path/to/photo'), 'public');Storage::putFile('photos', new File('/path/to/photo'), 'public'); ``` ### [File Uploads](https://laravel.com/docs/12.x/filesystem#file-uploads) In web applications, one of the most common use-cases for storing files is storing user uploaded files such as photos and documents. Laravel makes it very easy to store uploaded files using the `store` method on an uploaded file instance. Call the `store` method with the path at which you wish to store the uploaded file: ``` 1<?php23namespace App\Http\Controllers;45use Illuminate\Http\Request;67class UserAvatarController extends Controller8{9 /10 Update the avatar for the user.11 /12 public function update(Request $request): string13 {14 $path = $request->file('avatar')->store('avatars');1516 return $path;17 }18}<?php namespace App\Http\Controllers; use Illuminate\Http\Request; class UserAvatarController extends Controller { /* * Update the avatar for the user. / public function update(Request $request): string { $path = $request->file('avatar')->store('avatars'); return $path; } } ``` There are a few important things to note about this example. Note that we only specified a directory name, not a filename. By default, the `store` method will generate a unique ID to serve as the filename. The file's extension will be determined by examining the file's MIME type. The path to the file will be returned by the `store` method so you can store the path, including the generated filename, in your database. You may also call the `putFile` method on the `Storage` facade to perform the same file storage operation as the example above: ``` 1$path = Storage::putFile('avatars', $request->file('avatar'));$path = Storage::putFile('avatars', $request->file('avatar')); ``` #### [Specifying a File Name](https://laravel.com/docs/12.x/filesystem#specifying-a-file-name) If you do not want a filename to be automatically assigned to your stored file, you may use the `storeAs` method, which receives the path, the filename, and the (optional) disk as its arguments: ``` 1$path = $request->file('avatar')->storeAs(2 'avatars', $request->user()->id3);$path = $request->file('avatar')->storeAs( 'avatars', $request->user()->id ); ``` You may also use the `putFileAs` method on the `Storage` facade, which will perform the same file storage operation as the example above: ``` 1$path = Storage::putFileAs(2 'avatars', $request->file('avatar'), $request->user()->id3);$path = Storage::putFileAs( 'avatars', $request->file('avatar'), $request->user()->id ); ``` Unprintable and invalid unicode characters will automatically be removed from file paths. Therefore, you may wish to sanitize your file paths before passing them to Laravel's file storage methods. File paths are normalized using the `League\Flysystem\WhitespacePathNormalizer::normalizePath` method. #### [Specifying a Disk](https://laravel.com/docs/12.x/filesystem#specifying-a-disk) By default, this uploaded file's `store` method will use your default disk. If you would like to specify another disk, pass the disk name as the second argument to the `store` method: ``` 1$path = $request->file('avatar')->store(2 'avatars/'.$request->user()->id, 's3'3);$path = $request->file('avatar')->store( 'avatars/'.$request->user()->id, 's3' ); ``` If you are using the `storeAs` method, you may pass the disk name as the third argument to the method: ``` 1$path = $request->file('avatar')->storeAs(2 'avatars',3 $request->user()->id,4 's3'5);$path = $request->file('avatar')->storeAs( 'avatars', $request->user()->id, 's3' ); ``` #### [Other Uploaded File Information](https://laravel.com/docs/12.x/filesystem#other-uploaded-file-information) If you would like to get the original name and extension of the uploaded file, you may do so using the `getClientOriginalName` and `getClientOriginalExtension` methods: ``` 1$file = $request->file('avatar');23$name = $file->getClientOriginalName();4$extension = $file->getClientOriginalExtension();$file = $request->file('avatar'); $name = $file->getClientOriginalName(); $extension = $file->getClientOriginalExtension(); ``` However, keep in mind that the `getClientOriginalName` and `getClientOriginalExtension` methods are considered unsafe, as the file name and extension may be tampered with by a malicious user. For this reason, you should typically prefer the `hashName` and `extension` methods to get a name and an extension for the given file upload: ``` 1$file = $request->file('avatar');23$name = $file->hashName(); // Generate a unique, random name...4$extension = $file->extension(); // Determine the file's extension based on the file's MIME type...$file = $request->file('avatar'); $name = $file->hashName(); // Generate a unique, random name... $extension = $file->extension(); // Determine the file's extension based on the file's MIME type... ``` ### [File Visibility](https://laravel.com/docs/12.x/filesystem#file-visibility) In Laravel's Flysystem integration, "visibility" is an abstraction of file permissions across multiple platforms. Files may either be declared `public` or `private`. When a file is declared `public`, you are indicating that the file should generally be accessible to others. For example, when using the S3 driver, you may retrieve URLs for `public` files. You can set the visibility when writing the file via the `put` method: ``` 1use Illuminate\Support\Facades\Storage;23Storage::put('file.jpg', $contents, 'public');use Illuminate\Support\Facades\Storage; Storage::put('file.jpg', $contents, 'public'); ``` If the file has already been stored, its visibility can be retrieved and set via the `getVisibility` and `setVisibility` methods: ``` 1$visibility = Storage::getVisibility('file.jpg');23Storage::setVisibility('file.jpg', 'public');$visibility = Storage::getVisibility('file.jpg'); Storage::setVisibility('file.jpg', 'public'); ``` When interacting with uploaded files, you may use the `storePublicly` and `storePubliclyAs` methods to store the uploaded file with `public` visibility: ``` 1$path = $request->file('avatar')->storePublicly('avatars', 's3');23$path = $request->file('avatar')->storePubliclyAs(4 'avatars',5 $request->user()->id,6 's3'7);$path = $request->file('avatar')->storePublicly('avatars', 's3'); $path = $request->file('avatar')->storePubliclyAs( 'avatars', $request->user()->id, 's3' ); ``` #### [Local Files and Visibility](https://laravel.com/docs/12.x/filesystem#local-files-and-visibility) When using the `local` driver, `public` [visibility](https://laravel.com/docs/12.x/filesystem#file-visibility) translates to `0755` permissions for directories and `0644` permissions for files. You can modify the permissions mappings in your application's `filesystems` configuration file: ``` 1'local' => [2 'driver' => 'local',3 'root' => storage_path('app'),4 'permissions' => [5 'file' => [6 'public' => 0644,7 'private' => 0600,8 ],9 'dir' => [10 'public' => 0755,11 'private' => 0700,12 ],13 ],14 'throw' => false,15],'local' => [ 'driver' => 'local', 'root' => storage_path('app'), 'permissions' => [ 'file' => [ 'public' => 0644, 'private' => 0600, ], 'dir' => [ 'public' => 0755, 'private' => 0700, ], ], 'throw' => false, ], ``` ## [Deleting Files](https://laravel.com/docs/12.x/filesystem#deleting-files) The `delete` method accepts a single filename or an array of files to delete: ``` 1use Illuminate\Support\Facades\Storage;23Storage::delete('file.jpg');45Storage::delete(['file.jpg', 'file2.jpg']);use Illuminate\Support\Facades\Storage; Storage::delete('file.jpg'); Storage::delete(['file.jpg', 'file2.jpg']); ``` If necessary, you may specify the disk that the file should be deleted from: ``` 1use Illuminate\Support\Facades\Storage;23Storage::disk('s3')->delete('path/file.jpg');use Illuminate\Support\Facades\Storage; Storage::disk('s3')->delete('path/file.jpg'); ``` ## [Directories](https://laravel.com/docs/12.x/filesystem#directories) #### [Get All Files Within a Directory](https://laravel.com/docs/12.x/filesystem#get-all-files-within-a-directory) The `files` method returns an array of all files within a given directory. If you would like to retrieve a list of all files within a given directory including subdirectories, you may use the `allFiles` method: ``` 1use Illuminate\Support\Facades\Storage;23$files = Storage::files($directory);45$files = Storage::allFiles($directory);use Illuminate\Support\Facades\Storage; $files = Storage::files($directory); $files = Storage::allFiles($directory); ``` #### [Get All Directories Within a Directory](https://laravel.com/docs/12.x/filesystem#get-all-directories-within-a-directory) The `directories` method returns an array of all directories within a given directory. If you would like to retrieve a list of all directories within a given directory including subdirectories, you may use the `allDirectories` method: ``` 1$directories = Storage::directories($directory);23$directories = Storage::allDirectories($directory);$directories = Storage::directories($directory); $directories = Storage::allDirectories($directory); ``` #### [Create a Directory](https://laravel.com/docs/12.x/filesystem#create-a-directory) The `makeDirectory` method will create the given directory, including any needed subdirectories: ``` 1Storage::makeDirectory($directory);Storage::makeDirectory($directory); ``` #### [Delete a Directory](https://laravel.com/docs/12.x/filesystem#delete-a-directory) Finally, the `deleteDirectory` method may be used to remove a directory and all of its files: ``` 1Storage::deleteDirectory($directory);Storage::deleteDirectory($directory); ``` ## [Testing](https://laravel.com/docs/12.x/filesystem#testing) The `Storage` facade's `fake` method allows you to easily generate a fake disk that, combined with the file generation utilities of the `Illuminate\Http\UploadedFile` class, greatly simplifies the testing of file uploads. For example: Pest PHPUnit ``` 1<?php23use Illuminate\Http\UploadedFile;4use Illuminate\Support\Facades\Storage;56test('albums can be uploaded', function () {7 Storage::fake('photos');89 $response = $this->json('POST', '/photos', [10 UploadedFile::fake()->image('photo1.jpg'),11 UploadedFile::fake()->image('photo2.jpg')12 ]);1314 // Assert one or more files were stored...15 Storage::disk('photos')->assertExists('photo1.jpg');16 Storage::disk('photos')->assertExists(['photo1.jpg', 'photo2.jpg']);1718 // Assert one or more files were not stored...19 Storage::disk('photos')->assertMissing('missing.jpg');20 Storage::disk('photos')->assertMissing(['missing.jpg', 'non-existing.jpg']);2122 // Assert that the number of files in a given directory matches the expected count...23 Storage::disk('photos')->assertCount('/wallpapers', 2);2425 // Assert that a given directory is empty...26 Storage::disk('photos')->assertDirectoryEmpty('/wallpapers');27});<?php use Illuminate\Http\UploadedFile; use Illuminate\Support\Facades\Storage; test('albums can be uploaded', function () { Storage::fake('photos'); $response = $this->json('POST', '/photos', [ UploadedFile::fake()->image('photo1.jpg'), UploadedFile::fake()->image('photo2.jpg') ]); // Assert one or more files were stored... Storage::disk('photos')->assertExists('photo1.jpg'); Storage::disk('photos')->assertExists(['photo1.jpg', 'photo2.jpg']); // Assert one or more files were not stored... Storage::disk('photos')->assertMissing('missing.jpg'); Storage::disk('photos')->assertMissing(['missing.jpg', 'non-existing.jpg']); // Assert that the number of files in a given directory matches the expected count... Storage::disk('photos')->assertCount('/wallpapers', 2); // Assert that a given directory is empty... Storage::disk('photos')->assertDirectoryEmpty('/wallpapers'); }); ``` ``` 1<?php23namespace Tests\Feature;45use Illuminate\Http\UploadedFile;6use Illuminate\Support\Facades\Storage;7use Tests\TestCase;89class ExampleTest extends TestCase10{11 public function test_albums_can_be_uploaded(): void12 {13 Storage::fake('photos');1415 $response = $this->json('POST', '/photos', [16 UploadedFile::fake()->image('photo1.jpg'),17 UploadedFile::fake()->image('photo2.jpg')18 ]);1920 // Assert one or more files were stored...21 Storage::disk('photos')->assertExists('photo1.jpg');22 Storage::disk('photos')->assertExists(['photo1.jpg', 'photo2.jpg']);2324 // Assert one or more files were not stored...25 Storage::disk('photos')->assertMissing('missing.jpg');26 Storage::disk('photos')->assertMissing(['missing.jpg', 'non-existing.jpg']);2728 // Assert that the number of files in a given directory matches the expected count...29 Storage::disk('photos')->assertCount('/wallpapers', 2);3031 // Assert that a given directory is empty...32 Storage::disk('photos')->assertDirectoryEmpty('/wallpapers');33 }34}<?php namespace Tests\Feature; use Illuminate\Http\UploadedFile; use Illuminate\Support\Facades\Storage; use Tests\TestCase; class ExampleTest extends TestCase { public function test_albums_can_be_uploaded(): void { Storage::fake('photos'); $response = $this->json('POST', '/photos', [ UploadedFile::fake()->image('photo1.jpg'), UploadedFile::fake()->image('photo2.jpg') ]); // Assert one or more files were stored... Storage::disk('photos')->assertExists('photo1.jpg'); Storage::disk('photos')->assertExists(['photo1.jpg', 'photo2.jpg']); // Assert one or more files were not stored... Storage::disk('photos')->assertMissing('missing.jpg'); Storage::disk('photos')->assertMissing(['missing.jpg', 'non-existing.jpg']); // Assert that the number of files in a given directory matches the expected count... Storage::disk('photos')->assertCount('/wallpapers', 2); // Assert that a given directory is empty... Storage::disk('photos')->assertDirectoryEmpty('/wallpapers'); } } ``` By default, the `fake` method will delete all files in its temporary directory. If you would like to keep these files, you may use the "persistentFake" method instead. For more information on testing file uploads, you may consult the [HTTP testing documentation's information on file uploads](https://laravel.com/docs/12.x/http-tests#testing-file-uploads). The `image` method requires the [GD extension](https://www.php.net/manual/en/book.image.php). ## [Custom Filesystems](https://laravel.com/docs/12.x/filesystem#custom-filesystems) Laravel's Flysystem integration provides support for several "drivers" out of the box; however, Flysystem is not limited to these and has adapters for many other storage systems. You can create a custom driver if you want to use one of these additional adapters in your Laravel application. In order to define a custom filesystem you will need a Flysystem adapter. Let's add a community maintained Dropbox adapter to our project: ``` 1composer require spatie/flysystem-dropboxcomposer require spatie/flysystem-dropbox ``` Next, you can register the driver within the `boot` method of one of your application's [service providers](https://laravel.com/docs/12.x/providers). To accomplish this, you should use the `extend` method of the `Storage` facade: ``` 1<?php23namespace App\Providers;45use Illuminate\Contracts\Foundation\Application;6use Illuminate\Filesystem\FilesystemAdapter;7use Illuminate\Support\Facades\Storage;8use Illuminate\Support\ServiceProvider;9use League\Flysystem\Filesystem;10use Spatie\Dropbox\Client as DropboxClient;11use Spatie\FlysystemDropbox\DropboxAdapter;1213class AppServiceProvider extends ServiceProvider14{15 /16 Register any application services.17 /18 public function register(): void19 {20 // ...21 }2223 /24 Bootstrap any application services.25 /26 public function boot(): void27 {28 Storage::extend('dropbox', function (Application $app, array $config) {29 $adapter = new DropboxAdapter(new DropboxClient(30 $config['authorization_token']31 ));3233 return new FilesystemAdapter(34 new Filesystem($adapter, $config),35 $adapter,36 $config37 );38 });39 }40}<?php namespace App\Providers; use Illuminate\Contracts\Foundation\Application; use Illuminate\Filesystem\FilesystemAdapter; use Illuminate\Support\Facades\Storage; use Illuminate\Support\ServiceProvider; use League\Flysystem\Filesystem; use Spatie\Dropbox\Client as DropboxClient; use Spatie\FlysystemDropbox\DropboxAdapter; class AppServiceProvider extends ServiceProvider { /* * Register any application services. / public function register(): void { // ... } /* * Bootstrap any application services. */ public function boot(): void { Storage::extend('dropbox', function (Application $app, array $config) { $adapter = new DropboxAdapter(new DropboxClient( $config['authorization_token'] )); return new FilesystemAdapter( new Filesystem($adapter, $config), $adapter, $config ); }); } } ``` The first argument of the `extend` method is the name of the driver and the second is a closure that receives the `$app` and `$config` variables. The closure must return an instance of `Illuminate\Filesystem\FilesystemAdapter`. The `$config` variable contains the values defined in `config/filesystems.php` for the specified disk. Once you have created and registered the extension's service provider, you may use the `dropbox` driver in your `config/filesystems.php` configuration file. Copy as markdown ### On this page - [Introduction](https://laravel.com/docs/12.x/filesystem#introduction) - [Configuration](https://laravel.com/docs/12.x/filesystem#configuration) - [The Local Driver](https://laravel.com/docs/12.x/filesystem#the-local-driver) - [The Public Disk](https://laravel.com/docs/12.x/filesystem#the-public-disk) - [Driver Prerequisites](https://laravel.com/docs/12.x/filesystem#driver-prerequisites) - [Scoped and Read-Only Filesystems](https://laravel.com/docs/12.x/filesystem#scoped-and-read-only-filesystems) - [Amazon S3 Compatible Filesystems](https://laravel.com/docs/12.x/filesystem#amazon-s3-compatible-filesystems) - [Obtaining Disk Instances](https://laravel.com/docs/12.x/filesystem#obtaining-disk-instances) - [On-Demand Disks](https://laravel.com/docs/12.x/filesystem#on-demand-disks) - [Retrieving Files](https://laravel.com/docs/12.x/filesystem#retrieving-files) - [Downloading Files](https://laravel.com/docs/12.x/filesystem#downloading-files) - [File URLs](https://laravel.com/docs/12.x/filesystem#file-urls) - [Temporary URLs](https://laravel.com/docs/12.x/filesystem#temporary-urls) - [File Metadata](https://laravel.com/docs/12.x/filesystem#file-metadata) - [Storing Files](https://laravel.com/docs/12.x/filesystem#storing-files) - [Prepending and Appending To Files](https://laravel.com/docs/12.x/filesystem#prepending-appending-to-files) - [Copying and Moving Files](https://laravel.com/docs/12.x/filesystem#copying-moving-files) - [Automatic Streaming](https://laravel.com/docs/12.x/filesystem#automatic-streaming) - [File Uploads](https://laravel.com/docs/12.x/filesystem#file-uploads) - [File Visibility](https://laravel.com/docs/12.x/filesystem#file-visibility) - [Deleting Files](https://laravel.com/docs/12.x/filesystem#deleting-files) - [Directories](https://laravel.com/docs/12.x/filesystem#directories) - [Testing](https://laravel.com/docs/12.x/filesystem#testing) - [Custom Filesystems](https://laravel.com/docs/12.x/filesystem#custom-filesystems) [![Laracon US 2026](https://fls-9f826fcc-b2ad-40d8-813f-9cf7dac049fa.laravel.cloud/docs-ads/01KN5AKNREF0WREDYFPKVYBPG3.png)](https://laracon.us/) Laravel is the most productive way to build, deploy, and monitor software. - © 2026 Laravel - [Legal](https://laravel.com/legal) - [Status](https://status.laravel.com/) #### Products - [Cloud](https://cloud.laravel.com/) - [Forge](https://forge.laravel.com/) - [Nightwatch](https://nightwatch.laravel.com/) - [Vapor](https://vapor.laravel.com/) - [Nova](https://nova.laravel.com/) #### Packages - [Cashier](https://laravel.com/docs/billing) - [Dusk](https://laravel.com/docs/dusk) - [Horizon](https://laravel.com/docs/horizon) - [Octane](https://laravel.com/docs/octane) - [Scout](https://laravel.com/docs/scout) - [Pennant](https://laravel.com/docs/pennant) - [Pint](https://laravel.com/docs/pint) - [Sail](https://laravel.com/docs/sail) - [Sanctum](https://laravel.com/docs/sanctum) - [Socialite](https://laravel.com/docs/socialite) - [Telescope](https://laravel.com/docs/telescope) - [Pulse](https://laravel.com/docs/pulse) - [Reverb](https://laravel.com/docs/reverb) - [Echo](https://laravel.com/docs/broadcasting) #### Resources - [Documentation](https://laravel.com/docs) - [Starter Kits](https://laravel.com/starter-kits) - [Release Notes](https://laravel.com/docs/releases) - [Blog](https://laravel.com/blog) - [News](https://laravel-news.com/) - [Community](https://laravel.com/community) - [Larabelles](https://larabelles.com/) - [Learn](https://laravel.com/learn) - [Jobs](https://larajobs.com/?partner=5) - [Careers](https://laravel.com/careers) - [Trust](https://trust.laravel.com/) #### Partners - [UCodeSoft](https://laravel.com/partners/ucodesoft) - [CACI Limited](https://laravel.com/partners/caci-limited) - [Redberry](https://laravel.com/partners/redberry) - [Vehikl](https://laravel.com/partners/vehikl) - [Pixel](https://laravel.com/partners/pixel) - [64 Robots](https://laravel.com/partners/64-robots) - [Jump24](https://laravel.com/partners/jump24) - [Curotec](https://laravel.com/partners/curotec) - [byte5](https://laravel.com/partners/byte5) - [Threadable](https://laravel.com/partners/threadable) - [See All](https://laravel.com/partners)
Readable Markdown	> WARNING You're browsing the documentation for an old version of Laravel. Consider upgrading your project to [Laravel 13.x](https://laravel.com/docs/13.x/filesystem). - [Introduction](https://laravel.com/docs/12.x/filesystem#introduction) - [Configuration](https://laravel.com/docs/12.x/filesystem#configuration) - [The Local Driver](https://laravel.com/docs/12.x/filesystem#the-local-driver) - [The Public Disk](https://laravel.com/docs/12.x/filesystem#the-public-disk) - [Driver Prerequisites](https://laravel.com/docs/12.x/filesystem#driver-prerequisites) - [Scoped and Read-Only Filesystems](https://laravel.com/docs/12.x/filesystem#scoped-and-read-only-filesystems) - [Amazon S3 Compatible Filesystems](https://laravel.com/docs/12.x/filesystem#amazon-s3-compatible-filesystems) - [Obtaining Disk Instances](https://laravel.com/docs/12.x/filesystem#obtaining-disk-instances) - [On-Demand Disks](https://laravel.com/docs/12.x/filesystem#on-demand-disks) - [Retrieving Files](https://laravel.com/docs/12.x/filesystem#retrieving-files) - [Downloading Files](https://laravel.com/docs/12.x/filesystem#downloading-files) - [File URLs](https://laravel.com/docs/12.x/filesystem#file-urls) - [Temporary URLs](https://laravel.com/docs/12.x/filesystem#temporary-urls) - [File Metadata](https://laravel.com/docs/12.x/filesystem#file-metadata) - [Storing Files](https://laravel.com/docs/12.x/filesystem#storing-files) - [Prepending and Appending To Files](https://laravel.com/docs/12.x/filesystem#prepending-appending-to-files) - [Copying and Moving Files](https://laravel.com/docs/12.x/filesystem#copying-moving-files) - [Automatic Streaming](https://laravel.com/docs/12.x/filesystem#automatic-streaming) - [File Uploads](https://laravel.com/docs/12.x/filesystem#file-uploads) - [File Visibility](https://laravel.com/docs/12.x/filesystem#file-visibility) - [Deleting Files](https://laravel.com/docs/12.x/filesystem#deleting-files) - [Directories](https://laravel.com/docs/12.x/filesystem#directories) - [Testing](https://laravel.com/docs/12.x/filesystem#testing) - [Custom Filesystems](https://laravel.com/docs/12.x/filesystem#custom-filesystems) ## [Introduction](https://laravel.com/docs/12.x/filesystem#introduction) Laravel provides a powerful filesystem abstraction thanks to the wonderful [Flysystem](https://github.com/thephpleague/flysystem) PHP package by Frank de Jonge. The Laravel Flysystem integration provides simple drivers for working with local filesystems, SFTP, and Amazon S3. Even better, it's amazingly simple to switch between these storage options between your local development machine and production server as the API remains the same for each system. ## [Configuration](https://laravel.com/docs/12.x/filesystem#configuration) Laravel's filesystem configuration file is located at `config/filesystems.php`. Within this file, you may configure all of your filesystem "disks". Each disk represents a particular storage driver and storage location. Example configurations for each supported driver are included in the configuration file so you can modify the configuration to reflect your storage preferences and credentials. The `local` driver interacts with files stored locally on the server running the Laravel application, while the `sftp` storage driver is used for SSH key-based FTP. The `s3` driver is used to write to Amazon's S3 cloud storage service. You may configure as many disks as you like and may even have multiple disks that use the same driver. ### [The Local Driver](https://laravel.com/docs/12.x/filesystem#the-local-driver) When using the `local` driver, all file operations are relative to the `root` directory defined in your `filesystems` configuration file. By default, this value is set to the `storage/app/private` directory. Therefore, the following method would write to `storage/app/private/example.txt`: ``` 1use Illuminate\Support\Facades\Storage;23Storage::disk('local')->put('example.txt', 'Contents'); ``` ### [The Public Disk](https://laravel.com/docs/12.x/filesystem#the-public-disk) The `public` disk included in your application's `filesystems` configuration file is intended for files that are going to be publicly accessible. By default, the `public` disk uses the `local` driver and stores its files in `storage/app/public`. If your `public` disk uses the `local` driver and you want to make these files accessible from the web, you should create a symbolic link from source directory `storage/app/public` to target directory `public/storage`: To create the symbolic link, you may use the `storage:link` Artisan command: ``` 1php artisan storage:link ``` Once a file has been stored and the symbolic link has been created, you can create a URL to the files using the `asset` helper: ``` 1echo asset('storage/file.txt'); ``` You may configure additional symbolic links in your `filesystems` configuration file. Each of the configured links will be created when you run the `storage:link` command: ``` 1'links' => [2 public_path('storage') => storage_path('app/public'),3 public_path('images') => storage_path('app/images'),4], ``` The `storage:unlink` command may be used to destroy your configured symbolic links: ``` 1php artisan storage:unlink ``` ### [Driver Prerequisites](https://laravel.com/docs/12.x/filesystem#driver-prerequisites) #### [S3 Driver Configuration](https://laravel.com/docs/12.x/filesystem#s3-driver-configuration) Before using the S3 driver, you will need to install the Flysystem S3 package via the Composer package manager: ``` 1composer require league/flysystem-aws-s3-v3 "^3.0" --with-all-dependencies ``` An S3 disk configuration array is located in your `config/filesystems.php` configuration file. Typically, you should configure your S3 information and credentials using the following environment variables which are referenced by the `config/filesystems.php` configuration file: ``` 1AWS_ACCESS_KEY_ID=<your-key-id>2AWS_SECRET_ACCESS_KEY=<your-secret-access-key>3AWS_DEFAULT_REGION=us-east-14AWS_BUCKET=<your-bucket-name>5AWS_USE_PATH_STYLE_ENDPOINT=false ``` For convenience, these environment variables match the naming convention used by the AWS CLI. #### [FTP Driver Configuration](https://laravel.com/docs/12.x/filesystem#ftp-driver-configuration) Before using the FTP driver, you will need to install the Flysystem FTP package via the Composer package manager: ``` 1composer require league/flysystem-ftp "^3.0" ``` Laravel's Flysystem integrations work great with FTP; however, a sample configuration is not included with the framework's default `config/filesystems.php` configuration file. If you need to configure an FTP filesystem, you may use the configuration example below: ``` 1'ftp' => [2 'driver' => 'ftp',3 'host' => env('FTP_HOST'),4 'username' => env('FTP_USERNAME'),5 'password' => env('FTP_PASSWORD'),67 // Optional FTP Settings...8 // 'port' => env('FTP_PORT', 21),9 // 'root' => env('FTP_ROOT'),10 // 'passive' => true,11 // 'ssl' => true,12 // 'timeout' => 30,13], ``` #### [SFTP Driver Configuration](https://laravel.com/docs/12.x/filesystem#sftp-driver-configuration) Before using the SFTP driver, you will need to install the Flysystem SFTP package via the Composer package manager: ``` 1composer require league/flysystem-sftp-v3 "^3.0" ``` Laravel's Flysystem integrations work great with SFTP; however, a sample configuration is not included with the framework's default `config/filesystems.php` configuration file. If you need to configure an SFTP filesystem, you may use the configuration example below: ``` 1'sftp' => [2 'driver' => 'sftp',3 'host' => env('SFTP_HOST'),45 // Settings for basic authentication...6 'username' => env('SFTP_USERNAME'),7 'password' => env('SFTP_PASSWORD'),89 // Settings for SSH key-based authentication with encryption password...10 'privateKey' => env('SFTP_PRIVATE_KEY'),11 'passphrase' => env('SFTP_PASSPHRASE'),1213 // Settings for file / directory permissions...14 'visibility' => 'private', // `private` = 0600, `public` = 064415 'directory_visibility' => 'private', // `private` = 0700, `public` = 07551617 // Optional SFTP Settings...18 // 'hostFingerprint' => env('SFTP_HOST_FINGERPRINT'),19 // 'maxTries' => 4,20 // 'passphrase' => env('SFTP_PASSPHRASE'),21 // 'port' => env('SFTP_PORT', 22),22 // 'root' => env('SFTP_ROOT', ''),23 // 'timeout' => 30,24 // 'useAgent' => true,25], ``` ### [Scoped and Read-Only Filesystems](https://laravel.com/docs/12.x/filesystem#scoped-and-read-only-filesystems) Scoped disks allow you to define a filesystem where all paths are automatically prefixed with a given path prefix. Before creating a scoped filesystem disk, you will need to install an additional Flysystem package via the Composer package manager: ``` 1composer require league/flysystem-path-prefixing "^3.0" ``` You may create a path scoped instance of any existing filesystem disk by defining a disk that utilizes the `scoped` driver. For example, you may create a disk which scopes your existing `s3` disk to a specific path prefix, and then every file operation using your scoped disk will utilize the specified prefix: ``` 1's3-videos' => [2 'driver' => 'scoped',3 'disk' => 's3',4 'prefix' => 'path/to/videos',5], ``` "Read-only" disks allow you to create filesystem disks that do not allow write operations. Before using the `read-only` configuration option, you will need to install an additional Flysystem package via the Composer package manager: ``` 1composer require league/flysystem-read-only "^3.0" ``` Next, you may include the `read-only` configuration option in one or more of your disk's configuration arrays: ``` 1's3-videos' => [2 'driver' => 's3',3 // ...4 'read-only' => true,5], ``` ### [Amazon S3 Compatible Filesystems](https://laravel.com/docs/12.x/filesystem#amazon-s3-compatible-filesystems) By default, your application's `filesystems` configuration file contains a disk configuration for the `s3` disk. In addition to using this disk to interact with [Amazon S3](https://aws.amazon.com/s3/), you may use it to interact with any S3-compatible file storage service such as [RustFS](https://github.com/rustfs/rustfs), [DigitalOcean Spaces](https://www.digitalocean.com/products/spaces/), [Vultr Object Storage](https://www.vultr.com/products/object-storage/), [Cloudflare R2](https://www.cloudflare.com/developer-platform/products/r2/), or [Hetzner Cloud Storage](https://www.hetzner.com/storage/object-storage/). Typically, after updating the disk's credentials to match the credentials of the service you are planning to use, you only need to update the value of the `endpoint` configuration option. This option's value is typically defined via the `AWS_ENDPOINT` environment variable: ``` 1'endpoint' => env('AWS_ENDPOINT', 'https://rustfs:9000'), ``` ## [Obtaining Disk Instances](https://laravel.com/docs/12.x/filesystem#obtaining-disk-instances) The `Storage` facade may be used to interact with any of your configured disks. For example, you may use the `put` method on the facade to store an avatar on the default disk. If you call methods on the `Storage` facade without first calling the `disk` method, the method will automatically be passed to the default disk: ``` 1use Illuminate\Support\Facades\Storage;23Storage::put('avatars/1', $content); ``` If your application interacts with multiple disks, you may use the `disk` method on the `Storage` facade to work with files on a particular disk: ``` 1Storage::disk('s3')->put('avatars/1', $content); ``` ### [On-Demand Disks](https://laravel.com/docs/12.x/filesystem#on-demand-disks) Sometimes you may wish to create a disk at runtime using a given configuration without that configuration actually being present in your application's `filesystems` configuration file. To accomplish this, you may pass a configuration array to the `Storage` facade's `build` method: ``` 1use Illuminate\Support\Facades\Storage;23$disk = Storage::build([4 'driver' => 'local',5 'root' => '/path/to/root',6]);78$disk->put('image.jpg', $content); ``` ## [Retrieving Files](https://laravel.com/docs/12.x/filesystem#retrieving-files) The `get` method may be used to retrieve the contents of a file. The raw string contents of the file will be returned by the method. Remember, all file paths should be specified relative to the disk's "root" location: ``` 1$contents = Storage::get('file.jpg'); ``` If the file you are retrieving contains JSON, you may use the `json` method to retrieve the file and decode its contents: ``` 1$orders = Storage::json('orders.json'); ``` The `exists` method may be used to determine if a file exists on the disk: ``` 1if (Storage::disk('s3')->exists('file.jpg')) {2 // ...3} ``` The `missing` method may be used to determine if a file is missing from the disk: ``` 1if (Storage::disk('s3')->missing('file.jpg')) {2 // ...3} ``` ### [Downloading Files](https://laravel.com/docs/12.x/filesystem#downloading-files) The `download` method may be used to generate a response that forces the user's browser to download the file at the given path. The `download` method accepts a filename as the second argument to the method, which will determine the filename that is seen by the user downloading the file. Finally, you may pass an array of HTTP headers as the third argument to the method: ``` 1return Storage::download('file.jpg');23return Storage::download('file.jpg', $name, $headers); ``` ### [File URLs](https://laravel.com/docs/12.x/filesystem#file-urls) You may use the `url` method to get the URL for a given file. If you are using the `local` driver, this will typically just prepend `/storage` to the given path and return a relative URL to the file. If you are using the `s3` driver, the fully qualified remote URL will be returned: ``` 1use Illuminate\Support\Facades\Storage;23$url = Storage::url('file.jpg'); ``` When using the `local` driver, all files that should be publicly accessible should be placed in the `storage/app/public` directory. Furthermore, you should [create a symbolic link](https://laravel.com/docs/12.x/filesystem#the-public-disk) at `public/storage` which points to the `storage/app/public` directory. When using the `local` driver, the return value of `url` is not URL encoded. For this reason, we recommend always storing your files using names that will create valid URLs. #### [URL Host Customization](https://laravel.com/docs/12.x/filesystem#url-host-customization) If you would like to modify the host for URLs generated using the `Storage` facade, you may add or change the `url` option in the disk's configuration array: ``` 1'public' => [2 'driver' => 'local',3 'root' => storage_path('app/public'),4 'url' => env('APP_URL').'/storage',5 'visibility' => 'public',6 'throw' => false,7], ``` ### [Temporary URLs](https://laravel.com/docs/12.x/filesystem#temporary-urls) Using the `temporaryUrl` method, you may create temporary URLs to files stored using the `local` and `s3` drivers. This method accepts a path and a `DateTime` instance specifying when the URL should expire: ``` 1use Illuminate\Support\Facades\Storage;23$url = Storage::temporaryUrl(4 'file.jpg', now()->plus(minutes: 5)5); ``` #### [Enabling Local Temporary URLs](https://laravel.com/docs/12.x/filesystem#enabling-local-temporary-urls) If you started developing your application before support for temporary URLs was introduced to the `local` driver, you may need to enable local temporary URLs. To do so, add the `serve` option to your `local` disk's configuration array within the `config/filesystems.php` configuration file: ``` 1'local' => [2 'driver' => 'local',3 'root' => storage_path('app/private'),4 'serve' => true,5 'throw' => false,6], ``` #### [S3 Request Parameters](https://laravel.com/docs/12.x/filesystem#s3-request-parameters) If you need to specify additional [S3 request parameters](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectGET.html#RESTObjectGET-requests), you may pass the array of request parameters as the third argument to the `temporaryUrl` method: ``` 1$url = Storage::temporaryUrl(2 'file.jpg',3 now()->plus(minutes: 5),4 [5 'ResponseContentType' => 'application/octet-stream',6 'ResponseContentDisposition' => 'attachment; filename=file2.jpg',7 ]8); ``` #### [Customizing Temporary URLs](https://laravel.com/docs/12.x/filesystem#customizing-temporary-urls) If you need to customize how temporary URLs are created for a specific storage disk, you can use the `buildTemporaryUrlsUsing` method. For example, this can be useful if you have a controller that allows you to download files stored via a disk that doesn't typically support temporary URLs. Usually, this method should be called from the `boot` method of a service provider: ``` 1<?php23namespace App\Providers;45use DateTime;6use Illuminate\Support\Facades\Storage;7use Illuminate\Support\Facades\URL;8use Illuminate\Support\ServiceProvider;910class AppServiceProvider extends ServiceProvider11{12 /*13 Bootstrap any application services.14 /15 public function boot(): void16 {17 Storage::disk('local')->buildTemporaryUrlsUsing(18 function (string $path, DateTime $expiration, array $options) {19 return URL::temporarySignedRoute(20 'files.download',21 $expiration,22 array_merge($options, ['path' => $path])23 );24 }25 );26 }27} ``` #### [Temporary Upload URLs](https://laravel.com/docs/12.x/filesystem#temporary-upload-urls) The ability to generate temporary upload URLs is only supported by the `s3` and `local` drivers. If you need to generate a temporary URL that can be used to upload a file directly from your client-side application, you may use the `temporaryUploadUrl` method. This method accepts a path and a `DateTime` instance specifying when the URL should expire. The `temporaryUploadUrl` method returns an associative array which may be destructured into the upload URL and the headers that should be included with the upload request: ``` 1use Illuminate\Support\Facades\Storage;23['url' => $url, 'headers' => $headers] = Storage::temporaryUploadUrl(4 'file.jpg', now()->plus(minutes: 5)5); ``` This method is primarily useful in serverless environments that require the client-side application to directly upload files to a cloud storage system such as Amazon S3. ### [File Metadata](https://laravel.com/docs/12.x/filesystem#file-metadata) In addition to reading and writing files, Laravel can also provide information about the files themselves. For example, the `size` method may be used to get the size of a file in bytes: ``` 1use Illuminate\Support\Facades\Storage;23$size = Storage::size('file.jpg'); ``` The `lastModified` method returns the UNIX timestamp of the last time the file was modified: ``` 1$time = Storage::lastModified('file.jpg'); ``` The MIME type of a given file may be obtained via the `mimeType` method: ``` 1$mime = Storage::mimeType('file.jpg'); ``` #### [File Paths](https://laravel.com/docs/12.x/filesystem#file-paths) You may use the `path` method to get the path for a given file. If you are using the `local` driver, this will return the absolute path to the file. If you are using the `s3` driver, this method will return the relative path to the file in the S3 bucket: ``` 1use Illuminate\Support\Facades\Storage;23$path = Storage::path('file.jpg'); ``` ## [Storing Files](https://laravel.com/docs/12.x/filesystem#storing-files) The `put` method may be used to store file contents on a disk. You may also pass a PHP `resource` to the `put` method, which will use Flysystem's underlying stream support. Remember, all file paths should be specified relative to the "root" location configured for the disk: ``` 1use Illuminate\Support\Facades\Storage;23Storage::put('file.jpg', $contents);45Storage::put('file.jpg', $resource); ``` #### [Failed Writes](https://laravel.com/docs/12.x/filesystem#failed-writes) If the `put` method (or other "write" operations) is unable to write the file to disk, `false` will be returned: ``` 1if (! Storage::put('file.jpg', $contents)) {2 // The file could not be written to disk...3} ``` If you wish, you may define the `throw` option within your filesystem disk's configuration array. When this option is defined as `true`, "write" methods such as `put` will throw an instance of `League\Flysystem\UnableToWriteFile` when write operations fail: ``` 1'public' => [2 'driver' => 'local',3 // ...4 'throw' => true,5], ``` ### [Prepending and Appending To Files](https://laravel.com/docs/12.x/filesystem#prepending-appending-to-files) The `prepend` and `append` methods allow you to write to the beginning or end of a file: ``` 1Storage::prepend('file.log', 'Prepended Text');23Storage::append('file.log', 'Appended Text'); ``` ### [Copying and Moving Files](https://laravel.com/docs/12.x/filesystem#copying-moving-files) The `copy` method may be used to copy an existing file to a new location on the disk, while the `move` method may be used to rename or move an existing file to a new location: ``` 1Storage::copy('old/file.jpg', 'new/file.jpg');23Storage::move('old/file.jpg', 'new/file.jpg'); ``` ### [Automatic Streaming](https://laravel.com/docs/12.x/filesystem#automatic-streaming) Streaming files to storage offers significantly reduced memory usage. If you would like Laravel to automatically manage streaming a given file to your storage location, you may use the `putFile` or `putFileAs` method. This method accepts either an `Illuminate\Http\File` or `Illuminate\Http\UploadedFile` instance and will automatically stream the file to your desired location: ``` 1use Illuminate\Http\File;2use Illuminate\Support\Facades\Storage;34// Automatically generate a unique ID for filename...5$path = Storage::putFile('photos', new File('/path/to/photo'));67// Manually specify a filename...8$path = Storage::putFileAs('photos', new File('/path/to/photo'), 'photo.jpg'); ``` There are a few important things to note about the `putFile` method. Note that we only specified a directory name and not a filename. By default, the `putFile` method will generate a unique ID to serve as the filename. The file's extension will be determined by examining the file's MIME type. The path to the file will be returned by the `putFile` method so you can store the path, including the generated filename, in your database. The `putFile` and `putFileAs` methods also accept an argument to specify the "visibility" of the stored file. This is particularly useful if you are storing the file on a cloud disk such as Amazon S3 and would like the file to be publicly accessible via generated URLs: ``` 1Storage::putFile('photos', new File('/path/to/photo'), 'public'); ``` ### [File Uploads](https://laravel.com/docs/12.x/filesystem#file-uploads) In web applications, one of the most common use-cases for storing files is storing user uploaded files such as photos and documents. Laravel makes it very easy to store uploaded files using the `store` method on an uploaded file instance. Call the `store` method with the path at which you wish to store the uploaded file: ``` 1<?php23namespace App\Http\Controllers;45use Illuminate\Http\Request;67class UserAvatarController extends Controller8{9 /10 Update the avatar for the user.11 /12 public function update(Request $request): string13 {14 $path = $request->file('avatar')->store('avatars');1516 return $path;17 }18} ``` There are a few important things to note about this example. Note that we only specified a directory name, not a filename. By default, the `store` method will generate a unique ID to serve as the filename. The file's extension will be determined by examining the file's MIME type. The path to the file will be returned by the `store` method so you can store the path, including the generated filename, in your database. You may also call the `putFile` method on the `Storage` facade to perform the same file storage operation as the example above: ``` 1$path = Storage::putFile('avatars', $request->file('avatar')); ``` #### [Specifying a File Name](https://laravel.com/docs/12.x/filesystem#specifying-a-file-name) If you do not want a filename to be automatically assigned to your stored file, you may use the `storeAs` method, which receives the path, the filename, and the (optional) disk as its arguments: ``` 1$path = $request->file('avatar')->storeAs(2 'avatars', $request->user()->id3); ``` You may also use the `putFileAs` method on the `Storage` facade, which will perform the same file storage operation as the example above: ``` 1$path = Storage::putFileAs(2 'avatars', $request->file('avatar'), $request->user()->id3); ``` Unprintable and invalid unicode characters will automatically be removed from file paths. Therefore, you may wish to sanitize your file paths before passing them to Laravel's file storage methods. File paths are normalized using the `League\Flysystem\WhitespacePathNormalizer::normalizePath` method. #### [Specifying a Disk](https://laravel.com/docs/12.x/filesystem#specifying-a-disk) By default, this uploaded file's `store` method will use your default disk. If you would like to specify another disk, pass the disk name as the second argument to the `store` method: ``` 1$path = $request->file('avatar')->store(2 'avatars/'.$request->user()->id, 's3'3); ``` If you are using the `storeAs` method, you may pass the disk name as the third argument to the method: ``` 1$path = $request->file('avatar')->storeAs(2 'avatars',3 $request->user()->id,4 's3'5); ``` #### [Other Uploaded File Information](https://laravel.com/docs/12.x/filesystem#other-uploaded-file-information) If you would like to get the original name and extension of the uploaded file, you may do so using the `getClientOriginalName` and `getClientOriginalExtension` methods: ``` 1$file = $request->file('avatar');23$name = $file->getClientOriginalName();4$extension = $file->getClientOriginalExtension(); ``` However, keep in mind that the `getClientOriginalName` and `getClientOriginalExtension` methods are considered unsafe, as the file name and extension may be tampered with by a malicious user. For this reason, you should typically prefer the `hashName` and `extension` methods to get a name and an extension for the given file upload: ``` 1$file = $request->file('avatar');23$name = $file->hashName(); // Generate a unique, random name...4$extension = $file->extension(); // Determine the file's extension based on the file's MIME type... ``` ### [File Visibility](https://laravel.com/docs/12.x/filesystem#file-visibility) In Laravel's Flysystem integration, "visibility" is an abstraction of file permissions across multiple platforms. Files may either be declared `public` or `private`. When a file is declared `public`, you are indicating that the file should generally be accessible to others. For example, when using the S3 driver, you may retrieve URLs for `public` files. You can set the visibility when writing the file via the `put` method: ``` 1use Illuminate\Support\Facades\Storage;23Storage::put('file.jpg', $contents, 'public'); ``` If the file has already been stored, its visibility can be retrieved and set via the `getVisibility` and `setVisibility` methods: ``` 1$visibility = Storage::getVisibility('file.jpg');23Storage::setVisibility('file.jpg', 'public'); ``` When interacting with uploaded files, you may use the `storePublicly` and `storePubliclyAs` methods to store the uploaded file with `public` visibility: ``` 1$path = $request->file('avatar')->storePublicly('avatars', 's3');23$path = $request->file('avatar')->storePubliclyAs(4 'avatars',5 $request->user()->id,6 's3'7); ``` #### [Local Files and Visibility](https://laravel.com/docs/12.x/filesystem#local-files-and-visibility) When using the `local` driver, `public` [visibility](https://laravel.com/docs/12.x/filesystem#file-visibility) translates to `0755` permissions for directories and `0644` permissions for files. You can modify the permissions mappings in your application's `filesystems` configuration file: ``` 1'local' => [2 'driver' => 'local',3 'root' => storage_path('app'),4 'permissions' => [5 'file' => [6 'public' => 0644,7 'private' => 0600,8 ],9 'dir' => [10 'public' => 0755,11 'private' => 0700,12 ],13 ],14 'throw' => false,15], ``` ## [Deleting Files](https://laravel.com/docs/12.x/filesystem#deleting-files) The `delete` method accepts a single filename or an array of files to delete: ``` 1use Illuminate\Support\Facades\Storage;23Storage::delete('file.jpg');45Storage::delete(['file.jpg', 'file2.jpg']); ``` If necessary, you may specify the disk that the file should be deleted from: ``` 1use Illuminate\Support\Facades\Storage;23Storage::disk('s3')->delete('path/file.jpg'); ``` ## [Directories](https://laravel.com/docs/12.x/filesystem#directories) #### [Get All Files Within a Directory](https://laravel.com/docs/12.x/filesystem#get-all-files-within-a-directory) The `files` method returns an array of all files within a given directory. If you would like to retrieve a list of all files within a given directory including subdirectories, you may use the `allFiles` method: ``` 1use Illuminate\Support\Facades\Storage;23$files = Storage::files($directory);45$files = Storage::allFiles($directory); ``` #### [Get All Directories Within a Directory](https://laravel.com/docs/12.x/filesystem#get-all-directories-within-a-directory) The `directories` method returns an array of all directories within a given directory. If you would like to retrieve a list of all directories within a given directory including subdirectories, you may use the `allDirectories` method: ``` 1$directories = Storage::directories($directory);23$directories = Storage::allDirectories($directory); ``` #### [Create a Directory](https://laravel.com/docs/12.x/filesystem#create-a-directory) The `makeDirectory` method will create the given directory, including any needed subdirectories: ``` 1Storage::makeDirectory($directory); ``` #### [Delete a Directory](https://laravel.com/docs/12.x/filesystem#delete-a-directory) Finally, the `deleteDirectory` method may be used to remove a directory and all of its files: ``` 1Storage::deleteDirectory($directory); ``` ## [Testing](https://laravel.com/docs/12.x/filesystem#testing) The `Storage` facade's `fake` method allows you to easily generate a fake disk that, combined with the file generation utilities of the `Illuminate\Http\UploadedFile` class, greatly simplifies the testing of file uploads. For example: ``` 1<?php23use Illuminate\Http\UploadedFile;4use Illuminate\Support\Facades\Storage;56test('albums can be uploaded', function () {7 Storage::fake('photos');89 $response = $this->json('POST', '/photos', [10 UploadedFile::fake()->image('photo1.jpg'),11 UploadedFile::fake()->image('photo2.jpg')12 ]);1314 // Assert one or more files were stored...15 Storage::disk('photos')->assertExists('photo1.jpg');16 Storage::disk('photos')->assertExists(['photo1.jpg', 'photo2.jpg']);1718 // Assert one or more files were not stored...19 Storage::disk('photos')->assertMissing('missing.jpg');20 Storage::disk('photos')->assertMissing(['missing.jpg', 'non-existing.jpg']);2122 // Assert that the number of files in a given directory matches the expected count...23 Storage::disk('photos')->assertCount('/wallpapers', 2);2425 // Assert that a given directory is empty...26 Storage::disk('photos')->assertDirectoryEmpty('/wallpapers');27}); ``` ``` 1<?php23namespace Tests\Feature;45use Illuminate\Http\UploadedFile;6use Illuminate\Support\Facades\Storage;7use Tests\TestCase;89class ExampleTest extends TestCase10{11 public function test_albums_can_be_uploaded(): void12 {13 Storage::fake('photos');1415 $response = $this->json('POST', '/photos', [16 UploadedFile::fake()->image('photo1.jpg'),17 UploadedFile::fake()->image('photo2.jpg')18 ]);1920 // Assert one or more files were stored...21 Storage::disk('photos')->assertExists('photo1.jpg');22 Storage::disk('photos')->assertExists(['photo1.jpg', 'photo2.jpg']);2324 // Assert one or more files were not stored...25 Storage::disk('photos')->assertMissing('missing.jpg');26 Storage::disk('photos')->assertMissing(['missing.jpg', 'non-existing.jpg']);2728 // Assert that the number of files in a given directory matches the expected count...29 Storage::disk('photos')->assertCount('/wallpapers', 2);3031 // Assert that a given directory is empty...32 Storage::disk('photos')->assertDirectoryEmpty('/wallpapers');33 }34} ``` By default, the `fake` method will delete all files in its temporary directory. If you would like to keep these files, you may use the "persistentFake" method instead. For more information on testing file uploads, you may consult the [HTTP testing documentation's information on file uploads](https://laravel.com/docs/12.x/http-tests#testing-file-uploads). The `image` method requires the [GD extension](https://www.php.net/manual/en/book.image.php). ## [Custom Filesystems](https://laravel.com/docs/12.x/filesystem#custom-filesystems) Laravel's Flysystem integration provides support for several "drivers" out of the box; however, Flysystem is not limited to these and has adapters for many other storage systems. You can create a custom driver if you want to use one of these additional adapters in your Laravel application. In order to define a custom filesystem you will need a Flysystem adapter. Let's add a community maintained Dropbox adapter to our project: ``` 1composer require spatie/flysystem-dropbox ``` Next, you can register the driver within the `boot` method of one of your application's [service providers](https://laravel.com/docs/12.x/providers). To accomplish this, you should use the `extend` method of the `Storage` facade: ``` 1<?php23namespace App\Providers;45use Illuminate\Contracts\Foundation\Application;6use Illuminate\Filesystem\FilesystemAdapter;7use Illuminate\Support\Facades\Storage;8use Illuminate\Support\ServiceProvider;9use League\Flysystem\Filesystem;10use Spatie\Dropbox\Client as DropboxClient;11use Spatie\FlysystemDropbox\DropboxAdapter;1213class AppServiceProvider extends ServiceProvider14{15 /16 Register any application services.17 /18 public function register(): void19 {20 // ...21 }2223 /24 Bootstrap any application services.25 */26 public function boot(): void27 {28 Storage::extend('dropbox', function (Application $app, array $config) {29 $adapter = new DropboxAdapter(new DropboxClient(30 $config['authorization_token']31 ));3233 return new FilesystemAdapter(34 new Filesystem($adapter, $config),35 $adapter,36 $config37 );38 });39 }40} ``` The first argument of the `extend` method is the name of the driver and the second is a closure that receives the `$app` and `$config` variables. The closure must return an instance of `Illuminate\Filesystem\FilesystemAdapter`. The `$config` variable contains the values defined in `config/filesystems.php` for the specified disk. Once you have created and registered the extension's service provider, you may use the `dropbox` driver in your `config/filesystems.php` configuration file.
Shard	63 (laksa)
Root Hash	5292393658133462863
Unparsed URL	com,laravel!/docs/12.x/filesystem s443