Websites configuration

Websites configuration

This tutorial will help you create the web-config.json file.

The web-config.json file defines the websites that can be displayed by the video player and associate a numeric identifier to an URL.
This file is necessary to use the [WEBS x] and [WEBE x] tags on media files and folders names.
It must be placed into the www folder.

File syntax

The file must be a valid JSON file.
To edit its content you can:

  • use the editor available at the bottom of this page
  • use the video player web configuration interface available at http://<video player ip address>/ under menu Scenario settings / Websites
  • use an an online JSON parser or editor and a JSON schema validator

The file must contain a JSON object containing an array named "websites".
Each element of this array is an object containing a unique numeric identifier "id" and an URL "url".

Example web-config.json:

{
    "websites": [
        {
            "id": 1,
            "url": "http://localhost/www/page1.html"
        },
        {
            "id": 2,
            "url": "http://localhost/www/example/"
        },
        {
            "id": 3,
            "url": "https://codepen.io/dimaZubkov/full/rLxrXZ"
        }
    ]
}

JSON Schema:

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "web-config.json",
    "description": "web-config.json file content",
    "type": "object",
    "required": [
        "websites"
    ],
    "properties": {
        "websites": {
            "type": "array",
            "description": "The websites definitions",
            "items": {
                "type": "object",
                "description": "A website definition",
                "required": [ "id", "url" ],
                "properties": {
                    "id": {
                        "type": "integer",
                        "description": "The unique website identifier",
                    },
                    "url": {
                        "type": "string",
                        "title": "The website URL"
                    }
                }
            }
        }
    }
}

Editor

You can use the following editor to create your own web-config.json: