ALIAS Section

The ALIAS section maps a URI to a physical directory path on the server regardless of the document root. Aliasing can map a directory regardless of the Document Root, which is convenient from a management perspective.

Configuration Items

The following is the environment configuration format of the ALIAS section.

#"alias": {
    #"alias_list": [
        {
            "name": string,
            "url": string,
            "real_path": string         # $ENV
        }
    ]
}

Refer to Setting Value Formats and Configuration for more information on symbols and details of the ALIAS section configuration items.

alias_list

A list of ALIAS configuration.

Item Description

Data Type

Array (object)

alias_list/name (Required)

The name of the ALIAS configuration. This 'name' must be set when using the functionality of the ALIAS section in other sections.

Item Description

Data Type

String

Range

Up to 31 characters

alias_list/url (Required)

Sets the URI to be specified as an alias. Matching is checked by comparing the request URL with the configured URI, starting from the first byte, up to the length of the URI.

Item Description

Data Type

String

Range

Up to 255 characters

Format

Must start with a slash (/).

alias_list/real_path (Required)

Sets the physical directory path on the server. Environment variables can be used during configuration.Relative paths that do not start with '/' are automatically replaced with "$WEBTOB_HOME/relative path".

Item Description

Data Type

String

Range

Up to 255 characters

Format

Must end with a slash (/).

Example

The following is an example configuration of the ALIAS section.

{
    "alias": {
        "alias_list": [
            {
                "name" : "alias1",
                "url": "/external/path/",
                "real_path": "/internal/real/path/"
            }
        ]
    }
}