Assets on Craft Cloud
Each of the environments in your Craft Cloud projects come with a generous storage quota.
To take advantage of that storage (and other features, like the built-in CDN and image transform service), you must use the Cloud extension’s built-in filesystem type.
Local Development #
To simplify local and offline development, the Cloud filesystem supports a “local fallback” directory setting, which determines where assets are stored when running outside of the Cloud infrastructure.
New Filesystems #
New projects can start using it right away—new filesystems don’t require any special handling. You can create a new filesystem and volume the same way you would with any other filesystem type. Cloud filesystems do not require any credentials—they’re provided automatically by Cloud’s runtime.
Converting a Filesystem #
Existing projects may require some additional work to ensure their filesystems are migrated properly. This process will differ based on the filesystem’s current type—and if multiple filesystem types are represented in your configuration, you may need to follow different steps for each one.
Filesystems’ base paths cannot overlap! Even if you only need a single filesystem on Cloud, we recommend using the Cloud filesystem’s Subpath option to make room at the root of your volume for other filesystems, later.
Changes to your filesystems + volumes will be applied via Project Config, the next time you deploy your environment.
Local #
Local filesystems are the most straightforward to migrate. Take note of the current filesystem’s Base Path setting, as we’ll copy this into the new Cloud filesystem, to take advantage of the files already on your development environment’s disk.
From your Local filesystem’s settings screen, change the Filesystem Type to Cloud. Copy the old Base Path and Base URL settings into the corresponding Base Path and Base URL fields, within the Local Filesystem section.
The Subpath setting is appended to the Base Path and URL values, automatically.
You are welcome to relocate the on-disk files at this time, provided you update the Base URL and Base Path settings to match. It can be useful to keep all your Cloud fallback assets in an aptly-named directory like @web/cloud-fallbacks.
Remember to add whatever directory you choose to your .gitignore!
Repeat this process for each of your Local filesystems—they will not work on Cloud! Double-check that you have replaced them all by visiting Settings → Filesystems and scanning down the Type column.
See the Synchronizing Assets section to learn about how to seed your Cloud storage with local assets.
Remote #
Craft doesn’t have a technical distinction between “local” and “remote” filesystems, but we’re addressing them separately here because your experience may differ greatly based on your existing storage provider.
We recommend downloading all the files from your remote filesystem (using whatever tool is compatible with that storage infrastructure), then switching the filesystem type and setting its Subpath, Base Path, and Base URL values.
Once the filesystem is working locally, you can upload the assets to one of your project’s environments, ensuring they end up in the correct Subpath of the main assets/ directory.
Synchronizing Assets #
You may upload and download assets from your environments’ storage bucket at any time.
We generally discourage direct modification of your production bucket’s files (after an initial import), as it can cause issues for control panel users—Craft can lose track of files if it is not the source of a change.
Both of the following processes require credentials for the target environment’s storage bucket. These secrets are available in a suitable format by visiting the Access tab of an environment in your Cloud project.
You can use a GUI (like Transmit) or CLI (like the official AWS client) to perform transfers in either direction. Usage examples (like the commands in the following sections) are provided in-context, for common tools.
Uploading to a Bucket #
Your project’s storage bucket is identified via the credentials you generated via the Access screen, but it is your responsibility to upload assets to the correct path.
Let’s look at a command that uploads everything within a local web/craft-cloud-assets/ folder to a Cloud storage bucket.
cd path/to/project/root
aws s3 sync ./web/craft-cloud-assets/ s3://{project-uuid}/{environment-uuid}/assets/
This command shows a URI beginning with s3://, followed by two segments (both UUIDs) that identify the target project and environment.
The third segment in the path (assets/) is mandatory. This is the top-most directory that any Craft asset filesystem will write to, and files uploaded outside of it will be undiscoverable by Craft—and may collide with artifacts uploaded to the bucket during a build.
Read more about the sync command in the official AWS CLI documentation. If you are not confident about where files will end up, consider using --dry-run flag to list the operations that the CLI would attempt!
If you want to synchronize files from only one filesystem, ensure the local and remote paths are set properly. The example assumes you want an exact replica of the web/craft-cloud-assets/ directory in your storage bucket—whether that represents a single filesystem mounted at that base path, or multiple filesystems with unique base paths, within it.
Clients that support setting a Cache-Control header or metadata when uploading files should use the value selected in the corresponding filesystem’s settings.
Downloading from a Bucket #
The same process can be used in reverse to download assets to your local environment:
cd path/to/project/root
aws s3 sync --delete s3://{project-uuid}/{environment-uuid}/assets/ ./web/craft-cloud-assets/
For projects with large asset libraries (especially those over our soft 15GB per-environment limit), consider reaching out to us for recommendations about importing directly from other platforms. Credentials last for 1 hour—but as long as you use the sync command, it will be able to pick up where it left off.
Copying Assets Between Environments #
Automated environment duplication/synchronization is a planned feature of Cloud. In the meantime, you can follow the instructions above to download and re-upload assets—or reach out to us if the time required for such an operation would be prohibitive.
Transforms #
The Cloud extension transparently enhances Craft’s asset transform APIs by generating and caching images at the edge, using special pre-signed URLs. All your existing transforms will work seamlessly on Cloud, including predefined or named transforms and ad-hoc transforms.
These images don’t contribute to your storage quota, and there are no limits on the number of transforms or compute time.