Skip to content

OCTRA app configuration

Jump to bottom
Julian Pömp edited this page Sep 25, 2017 · 5 revisions

You can change OCTRA's application preferences easily by changing its appconfig.json file. You can find this file in the ./config folder. If you are using an older version of OCTRA please make sure to update your appconfig.json to the new structure (of the new appconfig_sample.json) after upgrading the other files. If you made a fresh install, you have to duplicate and rename the appconfig_sample.json to appconfig.json.

For Developers: You can find a JSONSchema File here.

Here is the default appxonfig_sample.json

{
    "version": "1.2.0",
    "audio_server": {
    "url": ""
    },
    "octra": {
        "database": {
        "name": "octralocal"
        },
        "login": {
            "enabled": false
        },
        "showdetails": false,
        "responsive": {
            "enabled": true,
            "fixedwidth": 1200
        },
        "bugreport": {
            "enabled": true,
            "name": "",
            "auth_token": "",
            "url": ""
        },
        "allowed_browsers": [],
        "languages": [
            "de",
            "en"
        ]
    }
}

Options:

  • version: The version shows which version of OCTRA is compatible with this configuration.

  • audio_server.url: Set the server url that offers the audiofiles and a database compatible with OCTRA. Notice: Currently only one online system can be used. We are working on supporting other systems.

  • octra.database.name: Set the name of the local database that is found in the user's browser. This attribute must be set.

  • octra.login.enabled: Set enabled to true if you want to enable the online mode otherwise false.

  • octra.showdetails: This option is set if you want to show the "Statistics" item in the navigation bar. When you click on this link a view of details pops out. This view shows you if events are logged correctly etc.

  • octra.responsive.enabled: If this is set OCTRA adjust its view relative to the windows width. OCTRA can than be used by mobile Browsers.

  • octra.responsive.fixedwidth: If responsive.enabled is false the view's width will be fixed to this value.

  • octra.allowed_browsers: You can define the browsers which can be used. Because OCTRA was tested in Chrome it's recommended to use Chrome. If there is no entry all browsers are allowed. If you want to limit the valid browsers you need to add Objects like this:

    {
   "name": "Chrome",
   "version": ""
}
    • name: The allowed user agent. Please have a look on all user agents available here
    • version: Regular Expression to validate if the version string is valid. In OCTRA v.1.2 this attribute is not used.

  • octra.languages: If you translated OCTRA to other languages, you can define these in this array. For each language there has to be one octra_.json in /assets/iln8/octra and one guidelines_.json

Clone this wiki locally