URL encoding

Docroots that point to object storage are written as URIs, in which the variable components such as access IDs, passwords and secret keys, bucket names, and paths to folders must be URL encoded.

For example, when setting a docroot for Amazon S3 with the following format:

s3://access_id:secret_key@s3.amazonaws.com/my_bucket

The values for access_id, secret_key, my_bucket, and my_path must be URL encoded while preserving the separators (: and /).

Examples

Amazon S3 docroot with the following inputs:

  • access_id = abc+d
  • secret_key = ef/gh
  • my_bucket/my_path = unicode文件夹/movies

The encoded URI is:

s3://abc%2Bd:ef%2Fgh@s3.amazonaws.com/unicode%E6%96%87%E4%BB%B6%E5%A4%B9%2Fmovies
Note: The forward slash between the bucket name and path is also encoded.

If the docroot also contains queries, for example if the following aspera.conf settings are specified as part of the docroot:

  • Storage-class=REDUCED_REDUNDANCY
  • Server-side-encryption=AES256

The & between the two settings must be encoded as &amp because the URI is in an XML file, as follows:

s3://abc%2Bd:ef%2Fgh@s3.amazonaws.com/unicode%E6%96%87%E4%BB%B6%E5%A4%B9%2Fmovies?storage-class=REDUCED_REDUNDANCY&server-side-encryption=AES256