Docroot path formatting

IN THIS ARTICLE:

Description

Docroot paths require different formatting depending on where the transfer server's storage is located. A docroot can be located on the server’s physical system, or in cloud storage.

Docroots can be set through the server GUI application, through the command line with asconfigurator or by modifying aspera.conf.

Formats

Local system

Docroot paths on the server system must be absolute paths, in the format used for the system’s OS.

For example, a docroot may be set in aspera.conf on a Linux system like the following:

<absolute>/home/janedoe/my_docroot</absolute>

A docroot on a Windows system may be set like the following:

<absolute>C:\Users\janedoe\my_docroot</absolute>

Local storage URI format

For ES 3.6.0 and above, you may need to use the local storage URI format for your docroot paths in some cases. For example, enabling server side encryption at rest requires the transfer user’s docroot to use the URI format.

The local storage URI format is simply the prefix file:/// followed by the normal absolute path on the system.

For example, a URI docroot may be set in aspera.conf on a Linux system like the following:

<absolute>file:////home/janedoe/my_docroot</absolute>

A URI docroot on a Windows system may be set like the following:

<absolute>file:///C:\Users\janedoe\my_docroot</absolute>

Cloud

Docroot paths set to cloud storage must be preceded by the proper protocol.

Note that these protocols are case sensitive. For example, s3:// should be used, not S3://

The storage account and password/key, as well as your storage unit name must be URL encoded. You can use a tool like URL Encoder/Decoder to encode these values.

Amazon s3 bucket

A docroot may be set in aspera.conf to an s3 bucket like the following:

<absolute>s3://access_id:secret_key@s3.amazonaws.com/my_bucket/my_path</absolute>

Azure blob

A docroot may be set in aspera.conf to an Azure blob like the following:

<absolute>azu://storage_account:storage_access_key@blob.core.windows.net/path/to/blob</absolute>
Have more questions? Submit a request

1 Comments

  • Avatar
    Joel Diaz Quiroga
    Edited by Joel Diaz Quiroga
Please sign in to leave a comment.
Powered by Zendesk