You are here

Configuring the Alfresco S3 Connector

The Alfresco S3 Connector is configured using properties set in the global properties file.
  1. Open the <classpathRoot>/alfresco-global.properties file.
  2. Add the s3.accessKey, for example:

    s3.accessKey=AKIAIOSFODNN7EXAMPLE

    The access key is required to identify the Amazon Web Services account and can be obtained from the Amazon Web Services site AWS Credentials.

  3. Add the s3.secretKey property, for example:

    s3.secretKey=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

    The secret key is required to identify the Amazon Web Services account and can be obtained from the Amazon Web Services site AWS Credentials.

  4. Add the s3.bucketName property, for example:

    s3.bucketName=myawsbucket

    The bucket name must be unique among all Amazon Web Services users globally. If the bucket does not already exist, it will be created, but the name must not have already been taken by another user. If the bucket has an error, it will be reported in the alfresco.log file. See S3 bucket restrictions for more information on bucket naming.

  5. Add the s3.bucketLocation, s3.bucketRegion, s3service.s3-endpoint as specified in the Amazon Simple Storage Service (S3) table.

    The values map as follows:

    • s3.bucketLocation: value from Location constraint column
    • s3.bucketRegion: value from Region column
    • s3service.s3-endpoint: value from Endpoint column
    For example, for EU (Frankfurt):
    s3.bucketLocation=eu-central-1 
    s3.bucketRegion=eu-central-1
    s3service.s3-endpoint=s3.eu-central-1.amazonaws.com
    Note: If you use a region other than the US Standard endpoint to create a bucket, s3.bucketLocation and s3.bucketRegion are mandatory fields. Use the Amazon Simple Storage Service (S3) table for guidance on the correct values.
  6. If you need to use a single bucket for multiple purposes, set the content store as a subdirectory of the bucket, using these properties:

    dir.contentstore=/SubPath/contentstore 
    dir.contentstore.deleted=/SubPath/contentstore.deleted
  7. Set optional configuration properties; for example, where the cached content is stored, and how much cache size you need:

    The cached content location (and default value) is dir.cachedcontent=${dir.root}/cachedcontent. See CachingContentStore properties for more information on the caching content store.

    Note: The size of the local caching content store can be configured as necessary to limit its use to a maximum overall size or by files with a maximum file size. For example:
     #Maximum disk usage for the cache in MB 
      system.content.caching.maxUsageMB=51200
     #Maximum size of files which can be stored in the cache in MB (zero implies no limit) 
      system.content.caching.maxFileSizeMB=0
  8. To configure an advanced S3 setup; for example, using a proxy server, see the JetS3t information for a full list of configuration parameters.
  9. Save the alfresco-global.properties file.

    You are now ready to start Alfresco.