Is this really the version you are looking for? Kentico Xperience 8.2 Documentation is no longer updated. Use the switcher in the header to choose your product version.
You can utilize the Amazon S3 storage service for storing your website files even though the website is hosted on-premise, on your own server.
File name case
Unlike standard Windows file systems, the Amazon S3 storage is case-sensitive. To ensure consistent behavior, Kentico automatically converts all file and folder names to lower case when processing files on Amazon S3.
Make sure that you have your Amazon S3 account set up and that you have created at least one bucket. Amazon Management Console (opens in a new tab).
Add the following key into the section of your project's .
<add key="CMSExternalStorageName" value="amazon" />Add the following key to specify the bucket that you want to use to store files. Replace the value with the name of the bucket.
<add key="CMSAmazonBucketName" value="YourBucketName" />Specify the ID of your Amazon access key by inserting the following key:
<add key="CMSAmazonAccessKeyID" value="YourKey" />Specify the Amazon access key by adding the following key:
<add key="CMSAmazonAccessKey" value="YourSecret" />After you save your web.config, Kentico starts storing files in the specified Amazon S3 bucket.
Additional website settings
When configuring this type of storage, keep in mind that the website itself must be configured to store files in the file system rather than in the database only. In Settings -> System -> Files enable the Store files in file system option.
It is also recommended to enable Redirect files to disk in Settings -> System -> Performance. This means that files will be requested from the Amazon S3 account rather than from the database (if possible).
Also, see the Media library notes at the end of this page for additional information about specifics of media libraries when using Amazon S3 storage.
You can configure the following optional settings:
Key | Description | Default value | Sample Value |
|---|---|---|---|
CMSAmazonTempPath | Path to a local directory that the system uses to store temporary files. | <installation root>\CMS\App_Data\AmazonTemp | HTML |
CMSAmazonCachePath | Path to a local directory where the provider stores cached files. | <installation root>\CMS\App_Data\AmazonCache | HTML |
CMSAmazonEndPoint | Allows you to change the default endpoint address, for example when you want to use CloudFront CDN. | http://<yourbucketname>.s3.amazonaws.com | HTML |
CMSAmazonPublicAccess | Specifies whether files uploaded to Amazon S3 through Kentico are accessible for public users. | true if you specify an endpoint false If no endpoint is specified | HTML |
By default, the system stores files in a single bucket. However, the built-in Amazon S3 storage provider allows you to map sections of the file system to different buckets.
using CMS.IO;
using CMS.Base;
[CustomStorage]
public partial class CMSModuleLoader
{
private class CustomStorageAttribute : CMSLoaderAttribute
{
/// <summary>
/// The system executes the Init method of the CMSModuleLoader attributes when the application starts.
/// </summary>
public override void Init()
{
// Creates a new StorageProvider instance
AbstractStorageProvider mediaProvider = new StorageProvider("Amazon", "CMS.AmazonStorage");
// Specifies the target bucket
mediaProvider.CustomRootPath = "mymediabucket";
// Makes the bucket publicly accessible
mediaProvider.PublicExternalFolderObject = true;
// Maps a directory to the provider
StorageHelper.MapStoragePath("~/MySite/Media/", mediaProvider);
}
}
}A Content Delivery Network (CDN) speeds up distribution of content to the end users through a network of data centers. See What Is Amazon CloudFront? (opens in a new tab) for details. To start using the Amazon CloudFront service with Kentico:
Create a CloudFront Distribution. You can use the Amazon Management Console (opens in a new tab). Select your Amazon S3 storage bucket as the Origin Domain Name.
Open the web.config file of your Kentico project.
Add the CMSAmazonPublicAccess and CMSAmazonEndPoint keys into the web.config file:
<appSettings>
<add key="CMSAmazonPublicAccess" value="true" />
<add key="CMSAmazonEndPoint" value="EndpointURL" />
</appSettings>Replace EndpointURL with the Domain Name URL from your created CDN.
If your site runs under HTTPS, we recommend you always specify the EndpointURL with the HTTPS protocol as well.
For example: https://domain.cloudfront.net (opens in a new tab)
Not doing so may result in Mixed Content (opens in a new tab) warnings being logged in your web browser's console when retrieving files from the CDN.
Your project now starts using the created CDN service.
Using Amazon S3 storage for your project has some effects on media libraries.
Storing a large number of media files in a single folder can significantly affect the performance of your project when editing the files in the Media library application. See Media library limitations when storing files in an external storage for details.
If all following conditions are true:
then the buckets on all storages must have the same name.
The reason is that when using the CMSAmazonPublicAccess key, direct file links use the name of the bucket in the URL. Therefore, if your staging server is connected to a different storage, the buckets where the media library files are stored must have the same name in all storages.