====== Toolbox setup & user management ====== ===== Toolbox setup ===== ==== Views App ==== Views App (Web) basically routes internal APC TFT connections to the network via the core device's Ethernet port, as [[views_app_win:start|Views App (Windows)]] does. Anyway, configuration process is different to the windows version. This is an example configuration process for having a basic view in your browser. - Open Toolbox software and config file. - In''Mixer/Console'', create a new console and add a new 52-8511 Display. Assign a View. Make sure you have the correct ''Central Display Group'' assigned. - Go to '''' node in project tree and select the ''Web Apps'' tab (see screenshot below). - In ''Enable WebApp Modules and APIs'' section, make sure ''Views App'' is checked to enable Views App. - In ''Views App'' tab below, ''Configuration'' section, all modules suitable for web views are listed. Click the line of the newly created 52-8511 display. - In ''Module Setup'' section, make sure ''Enable Web Access'' is checked. This will make the display generally available in the web. You can also: - Enter a ''Browser Caption''. This will help you to manage your views, as they can be easily identified later on. - Enter custom ''Width'' and ''Height'' values (in grid units). The view will be cropped. - Set ''View only'' to avoid control of the display via the web (only affects Views App Web) - Set access control (see [[#user_authentication|User Authentication]]) - Send your configuration to the device [{{ :webapps:views:viewsapp-toolbox.png |//Views App Toolbox configuration.//}}] ==== Assist App ==== Assist App basically routes internal APC module connections to the network via the core device's Ethernet port using websocket connections. - Open Toolbox software and config file. - In''Mixer/Console'', create a new console and add a new RX2, SX2 or 52/TX Console. Assign a View. Make sure you have the correct ''Central Display Group'' assigned. - Go to '''' node in project tree and select the ''Web Apps'' tab (see screenshot below). - In ''Enable WebApp Modules and APIs'' section, make sure ''Assist App'' is checked to enable Assist App. - In ''Assist App'' tab below, ''Configuration'' section, all modules suitable for web views are listed. Click the line of the newly created console. - In ''Module Setup'' section, make sure ''Enable Web Access'' is checked. This will make the display generally available in the web. You can also: - Enter a ''Browser Caption''. This will help you to manage your consoles, as they can be easily identified later on. - Set ''View only'' to avoid control of the display via the web (only affects Views App Web) - Set access control (see [[#user_authentication|User Authentication]]) - Send your configuration to the device [{{ :webapps:config-assist-app.png |//Assist App Toolbox configuration.//}}] ==== Snapshots App ==== - Open Toolbox software and config file. - Go to '''' node in project tree and select the ''Web Apps'' tab (see screenshot below). - In ''Enable WebApp Modules and APIs'' section, make sure ''Snapshots App'' is checked to enable Snapshots App. - In ''Snapshots App'' tab below, setup the correct user level for the designated function (''Basic Access'' and ''Backup & Restore, Save Snapshot 0'' can be protected). Multi-select is possible. [{{ :webapps:snapshots-toolbox.png |//Snapshtos App Toolbox configuration//}}] ==== Labels App ==== - Open Toolbox software and config file. - Go to '''' node in project tree and select the ''Web Apps'' tab (see screenshot below). - In ''Enable WebApp Modules and APIs'' section, make sure ''Labels App'' is checked to enable Labels App. - In ''Labels App'' tab below, setup the correct user level for the designated function (''Rename Fader Channels'' and ''Rename Global Labels'' can be protected). Multi-select is possible. [{{ :webapps:labels-toolbox.png |//Labels App Toolbox configuration//}}] ==== System App ==== - Open Toolbox software and config file. - Go to '''' node in project tree and select the ''Web Apps'' tab (see screenshot below). - In ''System App'' tab below, setup the correct user level for the designated function (''Configuration and Maintenance'' and ''Connection Management'' can be protected). Multi-select is possible. **Note**\\ For security reasons, System App user rights group assignment behaves different than other web apps. If no user rights group is assigned, the functions will **not be accessible**. Using ''Configuration and Maintenance'' and ''Connection Management'' functions without login protection is not possible. [{{ :webapps:config-system.png |//Labels App Toolbox configuration//}}] ===== User authentication ===== Web Apps offers a username / password protection based on Toolbox' existing [[tb9:administration|administration]] mechanisms. To protect a web app: - In Toolbox go to '''' page and open the ''Web Apps'' tab. - **Views App:** Select the display you wish to protect from the list in ''configuration'' section. In ''Module Setup'' section, set the access levels to assign user permission. - **Snapshots App, Labels App:** Select the correct user level for the designated function. - Open Web Apps in your browser and click the {{:webapps:views:login.png?32|}} (login) button in the lower right. Enter your username & password. - If the login button is not visible, click the app icon in the upper right. The navigation overlay will open. Here you can log in / log off. **Note**\\ ''View Only'' in Views App is a separate function and is not affected by user rights. If you wish that different user groups have view only or full access, consider using different virtual displays. **Note**\\ A user without the right to see and/or use the view will not see any hint that the function exists. ==== Automatic login with user token ==== Login a user directly, e.g. for stand-alone solutions using HTTP GET. Token is the user defined token as from Toolbox. Usage: http://[Core-IP]?token=[User-Token] You can use this GET argument on any point and state of web apps, for example also in [[webapps:views:start|Views App]]: http://10.5.12.123/#/views/5?token=1234-1234-1234