Serving UI directories

uiDirectories property

For all services with a user interface (UI) that serve static files, the uiDirectories property is required at the root level of the pronghorn.json file. This property is a list of top-level directory names; only files within those directories are served by Itential Platform.

The default method for serving static files is through uiDirectories. If the property does not exist, all static files are served. Once the property is present, only files within the specified directories are served — no other files are accessible.

Example

In the following example, all files within the build, img, and icon directories are served by Itential Platform. No other files will be served.

1
{
2
    "id": "@itential/app-test",
3
    "uiDirectories": ["build", "img", "icon"],
4
    "encrypted": true,
5
    "src": "cog.bing",
6
    "type": "Application",
7
    "export": "test",
8
    "title": "test",
9
    "summary": "Test",
10
    "pdb": true,
11
    "roles": ["admin", "engineering", "support", "apiread", "apiwrite"],
12
    "methods": [],
13
    "views": []
14
}