AvNav Configuration User Apps

Configuration of User Apps

You will get here by clicking the button on the settings page

A user app is an external or internal HTML page to be shown at the user app page in an iframe.

All configured user apps will be shown.

Buttons

Icon Name Function

MOB man over board (see main page)
+ AddonConfigPlus add a new configuration

AddonConfigAddOns show the user app page

Cancel back to the previous page

For each configuration the url and an optional title are displayed. Additionally the origin of this configuration is indicated (plugin in the screenshot). For defunct configurations (e.g. missing icon) "invalid" will be shown. By clicking the configuration you can modify it. Clicking on will take you to the user app page and the selected configuration will be displayed there.
When adding or editing a configuration a dialog will open.

You can select to use either an internal or external HTML page (check box). In the screenshot an internal page is selected. If you select an external page you need to provide the complete url as http(s)://.... If the page lives on the same server as AvNav (like the signalk Web UI) you should replace the hostname with $HOST in your url. AvNav will automatically use the correct ip address in this case.


Internal HTML pages must be uploaded to the user file directory prior to defining them as user app.

For each user app an icon file (svg, png, jpeg) is required. This also has to be uploaded via the Files/Download page, either to the user files or to the images category.
After selecting the url and the icon you can provide a title. An empty title empty will result in no caption at the page.
After saving you can directly test it using the button.

If "newWindow (ab Version 20220225) is unchecked the web page will be displayed in an iframe - otherwise in a new browser window / browser tab.


Deleting a HTML file on the files/download page will also remove any user app configuration holding an internal URL referring to it.
If a icon file is deleted, the user app configuration referencing it will remain, however it will turn invalid. Invalid configurations will not be displayed at the user app page.
But you still can modify the configuration on this page to make it valid again.

Whenever a user app configuration is stored, the server updates its avnav_server.xml file. To avoid situations of AvNav not starting next time (because something went wrong during this writing back), an avnav_server.xml.ok file is written on every successful start of AvNav.
If AvNav is unable to start at a later point (due to a corrupted avnav_server.xml) this fallback file will be read instead.