Configure File Metadata

On this page

Overview

Procedure

Atlas Device Sync, Atlas Edge Server, Data API, and HTTPS Endpoints are deprecated. Refer to the deprecation page for details.

Overview

You can configure a file's metadata attributes to describe aspects of the file, such as its content type, language, or encoding. You can also use metadata attributes to configure the CDN's caching behavior and specify how clients should handle files when they access them.

Note

If you do not specify a Content-Type metadata attribute for a hosted file, Atlas App Services will attempt to automatically add a Content-Type attribute to it based on the file extension.

For example, App Services would automatically add the attribute Content-Type: application/html to the file myPage.html.

Procedure

Navigate to the File in the File Tree

To add a metadata attribute to a specific file you need to find the file in the hosted file tree. To find the file:

Click Hosting in the left navigation menu.
Select the Files tab.
Find the entry for the file in the file tree.

Add a New Attribute

Once you have found the file, you need to add a new metadata attribute to it. To add a new metadata attribute:

Click the file's Actions (...) button.
Click Edit Attributes...
In the Set Attributes modal, click Add Attribute.

Select the Attribute Type and Value

The new metadata attribute will not have a type or value when you first add it.

Select the attribute type from new attribute's left-hand dropdown
Enter a value for the attribute in the right-hand input box.
Click Save.

Pull Your App's Latest Configuration Files

appservices pull --remote=<App ID>

Add Attributes to the Metadata Configuration File

The metadata for all hosted files associated with your application is configured by an array of metadata attribute definition objects that you define in a file named metadata.json in your application's hosting subdirectory.

Atlas App Services will automatically infer and assign a Content-Type to every file you upload. If you you want to override the default Content-Type or specify additional metadata attributes for a file, add an entry to metadata.json for the file and attributes that you want to configure. Each file's entry should be a document with the following form:

metadata.json

[
  {
    "path": "<File Resource Path>",
    "attrs": [
       ...,
       <Attribute Definition>
    ],
  },
  ...
]

Field

Description

path

Required. The resource path of the file.

attrs

Required. An array of documents where each document represents a single metadata attribute. Attribute documents have the following form:

Metadata Attribute Document

{
  "name": "<Attribute Type>",
  "value": "<Attribute Value>"
}

Field	Description
`name`	The name of the metadata attribute. This should be one of the file metadata attributes that App Services supports.
`value`	The value of the metadata attribute.

Note

If you include an entry in metadata.json for a file that does not exist, you will not be able to import your changes. Ensure that only hosted files are represented in metadata.json.

Import the File Metadata Configuration

Once you have added all the metadata attributes you want to configure to metadata.json, you can import the application directory to actually update the associated file metadata.

Navigate to the root of the application directory and run the following command:

appservices push --include-hosting

Back

Enable Hosting

File Metadata Attributes