Download the PHP package dulce/upcloud without Composer

UpCloud Object Storage for Craft CMS

This plugin provides UpCloud Managed Object Storage integration for Craft CMS.

Note: This is a fork of the craftcms/aws-s3 plugin, specifically adapted for UpCloud Object Storage.

Requirements

This plugin requires Craft CMS 4.0.0+ or 5.0.0+.

Installation

You can install this plugin with Composer.

With Composer

Open your terminal and run the following commands:

Setup

To create a new UpCloud Object Storage filesystem to use with your volumes, visit Settings → Filesystems, and press New filesystem. Select "UpCloud Object Storage" for the Filesystem Type setting and configure as needed.

Getting Your UpCloud Credentials

1. Log in to your UpCloud Control Panel
2. Navigate to Object Storage in the sidebar
3. Create a new Object Storage instance or select an existing one
4. Note your Endpoint URL (e.g., https://abc123.upcloudobjects.com)
5. Create a user for your storage instance
6. Generate Access Keys for that user
7. Save the Access Key ID and Secret Access Key (the secret is only shown once!)

Configuration Fields

• UpCloud Endpoint (required): Your UpCloud Object Storage endpoint URL

  • Example: https://abc123.upcloudobjects.com
  • You can find this in your UpCloud Control Panel under your Object Storage instance

• Access Key ID (required): Your UpCloud Object Storage access key

• Secret Access Key (required): Your UpCloud Object Storage secret key

• Bucket: Select from available buckets or enter manually

  • Use the "Refresh" button to load buckets from your UpCloud account
  • Or choose "Manual" to enter bucket name directly

• Subfolder (optional): Specify a subfolder within the bucket to use as the filesystem root

• Region: Usually us-east-1 (UpCloud uses this for S3 API compatibility)

• Make Uploads Public (optional): When enabled, uploaded files will have public-read ACL
  • Turn OFF for private files (recommended for sensitive data like medical records)
  • Required permission: s3:PutObjectAcl in your bucket policy

💡 Tip: All configuration values support environment variables. See Environmental Configuration in the Craft docs to learn more.

Private Files & Signed URLs

For sensitive files (medical records, documents, etc.), you should:

1. Disable "Make Uploads Public" in your filesystem settings

2. Add required permissions to your UpCloud bucket policy:

3. Use signed URLs in your templates for temporary access:

Signed URLs automatically expire for security. Users can access the file during the expiration window without making it permanently public.

Environment Variables (.env)

Then in your filesystem settings (Settings > Filesystems):

• Endpoint: $UPCLOUD_ENDPOINT
• Access Key ID: $UPCLOUD_ACCESS_KEY
• Secret Access Key: $UPCLOUD_SECRET_KEY
• Bucket: $UPCLOUD_BUCKET
• Region: Leave as us-east-1 (used for S3 API compatibility, actual region doesn't matter for UpCloud)

UpCloud Object Storage Features

UpCloud Managed Object Storage is fully S3-compatible and supports:

• ✅ Standard bucket operations (create, delete, list)
• ✅ Object operations (upload, download, delete, copy)
• ✅ Multipart uploads for large files
• ✅ Access Control Lists (ACLs)
• ✅ Bucket policies
• ✅ Object versioning
• ✅ Lifecycle management
• ✅ CORS configuration
• ✅ Presigned URLs (signed URLs with expiration)
• ✅ Path-style and virtual-hosted-style bucket URLs

Available Regions

UpCloud Object Storage is available in the following regions:

Note: For the plugin configuration, use us-east-1 as the region value for S3 API compatibility. The actual UpCloud region is determined by your Object Storage instance endpoint.

Differences from AWS S3

This plugin is specifically designed for UpCloud and has the following differences from the AWS S3 plugin:

• ✅ Endpoint Required: You must specify your UpCloud endpoint
• ✅ Simplified Configuration: No CloudFront or AWS-specific features
• ❌ No CloudFront: UpCloud doesn't use CloudFront for CDN
• ❌ No Rekognition: Automatic focal point detection is not available
• ❌ No IAM Roles: UpCloud uses access keys for authentication

Troubleshooting

Buckets not loading

Make sure you:

1. Have entered the correct endpoint URL (including https://)
2. Have entered valid access key credentials
3. Have created at least one bucket in your UpCloud Object Storage instance
4. The user has permission to list buckets

Upload errors

Check that:

1. The bucket name is correct
2. The access key has write permissions
3. The bucket exists in your UpCloud Object Storage instance
4. Your endpoint URL is correct

URL generation issues

UpCloud supports both URL formats:

• Path-style (used by this plugin): https://endpoint.com/bucket/object
• Virtual-hosted-style: https://bucket.endpoint.com/object

Make sure your Base URL is configured correctly in the filesystem settings.

Resources

• UpCloud Object Storage Documentation
• UpCloud S3 Compatibility
• Getting Started with UpCloud Object Storage
• Craft CMS Filesystem Documentation

Get Started with UpCloud

Don't have an UpCloud account yet? Sign up here and get $25 in free credits to try UpCloud Object Storage and other cloud services.

License

This plugin is licensed under the MIT License. See LICENSE.md for details.

Credits

• Author: Mauricio Dulce
• Based on: craftcms/aws-s3 by Pixel & Tonic
• UpCloud: upcloud.com

Support

For issues and questions about this plugin, please open an issue on GitHub.

New to UpCloud? Sign up here and get $25 in free credits to get started with UpCloud Object Storage!

For UpCloud Object Storage support, contact UpCloud Support.