--- canonical: https://safekit.evidian.com/wp-content/uploads/downloads_safekit/version-82/safekituserguidehtml/documentation/safekituserguideen.htm --- # 3. The SafeKit web console ![*](safekituserguideen_fichiers/image001.png)       Section 3.1 “Start the web console” ![*](safekituserguideen_fichiers/image001.png)       Section 3.2 “Configure the cluster”   ![*](safekituserguideen_fichiers/image001.png)       Section 3.3 “Configure an application module” ![*](safekituserguideen_fichiers/image001.png)       Section 3.4 “Monitor an application module” ![*](safekituserguideen_fichiers/image001.png)       Section 3.5 “Snapshots or logs of application module for debug and support” ![*](safekituserguideen_fichiers/image001.png)       Section 3.6 “Secure access to the web console”   The SafeKit 8 web console and API have evolved from earlier versions. As a result, the console delivered with SafeKit 8 can only administer SafeKit 8 servers, which cannot be administered with an older console. ## 3.1             Start the web console The web console permits to administer one SafeKit cluster. A SafeKit cluster is a set of servers where SafeKit is installed and running. All servers belonging to a given SafeKit cluster share the same cluster configuration (list of servers and networks used) and communicate with each other’s to have a global view of SafeKit modules configurations. The same server can not belong to many SafeKit clusters. ### 3.1.1         Start a web browser The prerequisites for launching the console are as follows: ·         The device (workstation, server, or mobile) must have network access to the SafeKit server(s) and the necessary access permissions. ·         Networks, firewalls, and proxies must be configured to allow access to all SafeKit servers. ·         Supported browsers include Microsoft Edge, Firefox, and Chrome. Starting with version 5, the console is also available as a Progressive Web App (PWA) on both desktop and mobile devices (see section 3.1.4). | | | | --- | --- | | Commentaire, ajouter contour | The console uses a separate versioning system from the SafeKit package. | ### 3.1.2         Connect to a SafeKit node By default, access to the web console requires the user to authenticate himself with a name and password. On SafeKit install, you had to initialize it with the user admin and assign a password. This admin name and password are sufficient to access all the console's features. For more details on this configuration, see section 11.2.1. 1.    Start a web browser (Microsoft Edge, Firefox, or Chrome) 2.    Connect it to the URL http://host:9010 (where host is the name or IP address of one of the SafeKit servers). If HTTPS is configured, there is an automatic redirection to https://host:9453. 3.    The SafeKit server to which the console is connected (host in the URL) is called the **connection node**. This node acts as a proxy to communicate on behalf of the console with all other SafeKit servers. | | | | --- | --- | | Commentaire, ajouter contour | You can connect to any node of the cluster since the console offer global view and actions. On connection error with one node, connect to another node. | 4.    In the login page, enter admin as user’s name and the password you gave on initialization (e.g., pwd). 5.    The SafeKit web console is loaded ![](safekituserguideen_fichiers/image050.png) ·         When the console is connected to a SafeKit server on which the cluster is configured, the name of the node corresponding to the server (as defined in the cluster configuration) is displayed in the header. This is the **connection node** (node1 in the example). If the cluster is not yet configured, no name is displayed. ·         Click on ![](safekituserguideen_fichiers/image046.png) to open the menu to read the SafeKit User’s Guide, select the language, enable/disable the dark mode and logout. ·         Click on ![](safekituserguideen_fichiers/image051.png) to collapse or expand the navigation sidebar. ·         Click on ![](safekituserguideen_fichiers/image052.png) “Configuration” to configure the cluster and the modules. Configuration is only authorized to users that have Admin role. By default, the admin user has the Admin role. ·         (4) Click on ![](safekituserguideen_fichiers/image053.png) “Monitoring” to monitor and control the configured modules. Monitoring is authorized to users that have Admin, Control and Monitor roles. With Monitor role, actions on modules (start, stop…)  are prohibited. | | | | --- | --- | | Commentaire, ajouter contour | The web console offers contextual help by clicking on the icon. | ### 3.1.3         List of connection nodes The console offers the ability to easily switch connection node, even if the node belongs to a different cluster. ![](safekituserguideen_fichiers/image054.png) ·         (1) Click on![](safekituserguideen_fichiers/image055.jpg)to display the list of connection nodes. By default, if the cluster is configured, it lists all the nodes belonging to the cluster. Otherwise, this menu is unavailable. ·         (2) For example, click on node2 to connect the web console to node2. This is a shortcut for loading the web console from this node, which becomes the connection node. ·         (3) Click on ![](safekituserguideen_fichiers/image056.png) to open the submenu that allows to: o    Export the list of connection nodes to a JSON file on your workstation. It contains the names and addresses of the nodes in the list. o    Import the list of connection nodes from a JSON file on your workstation. Use the exported JSON file as a template and define your own list of connection nodes. This can be used if you wish to manage nodes belonging to different SafeKit clusters. You can also define a cluster name to which the nodes belong. o    Import the cluster nodes Use this option to reset an imported list and restore the default list, which contains only the nodes defined in the cluster of the node to which the console is connected. ### 3.1.4         Use the SafeKit web application Starting with version 5 of the SafeKit console, it is also available as a Progressive Web App (PWA) on both desktop and mobile devices. Using the SafeKit web application offers several advantages: ·         User Experience The console can be launched directly from the home screen, start menu, etc. This provides a user experience similar to that of a native application, especially on mobile devices. ·         Real-time notifications When enabled, notifications allow users to receive immediate updates about module state changes. o    On mobile devices, notifications are available only through the SafeKit web application. Additionally, HTTPS is required. o    On desktop platforms, notifications work in both the web application and the browser. However, when accessed remotely, HTTPS is required; HTTP is only allowed on localhost. ·         Enhanced security The web application benefits from isolation from browser tabs and uses the HTTPS protocol along with service workers for improved protection. To install the SafeKit web application, the platform and browser used must support PWAs. This includes browsers such as Chrome, Microsoft Edge, and Firefox. Once installed, the application becomes standalone and has its own uninstallation process. #### 3.1.4.1      Install the web application On desktop 1.    Load the SafeKit web console in the web browser using the URL https://:9453 | | | | --- | --- | | Commentaire, ajouter contour | On a SafeKit node, you can use http://localhost:9010. | 2.    Locate the installation icon in the browser’s address bar: | | | | --- | --- | | Microsoft Edge | It appears as a small icon next to the URL Or go to the menu Apps | | Chrome | It appears as a small icon next to the URL |   3.    Click to install then confirm The SafeKit console will then appear as a standalone application, with its own icon in the Start menu, on the desktop, etc. On mobile 1.    Load the SafeKit web console in the web browser using the URL https://:9453 2.    If your mobile device and browser support PWAs, look for the “Add” action | | | | --- | --- | | Chrome (Android) | In the menu icon (⋮) in the top-right corner |   3.    Select “Add to Home screen” then confirm The SafeKit console will be accessible from the home screen, just like a native application. #### 3.1.4.2      Uninstall the web application On most platforms, the web application is uninstalled in the same way as other applications. On some desktop operating systems, the application can be uninstalled directly from the opened application by accessing the menu located in the upper-right corner. ### 3.1.5         Update the web console Each upgrade of the SafeKit package may include a new version of the web console. To load this new version, it may be necessary to clear the browser cache. You can do this using a keyboard shortcut: 1.    Open the browser to any web page and hold CTRL and SHIFT while tapping the DELETE key 2.    A dialog box will open to clear the browser. Set it to clear everything and click Clear Now or Delete at the bottom 3.    Close the browser, stop all background processes that may be still running and re-open it fresh to reload the web console   Starting from version 5 of the SafeKit console, it includes support for Progressive Web Application (PWA) functionality. This enhancement introduces automatic update capabilities. However, if the automatic update does not trigger, you can force it manually: ·         Either by clearing the browser cache, as described above ·         Or by clicking the “Update” button available in the menu located in the top-right corner. If a new version is available, the console and its version will be updated accordingly. ![](safekituserguideen_fichiers/image059.jpg) ## 3.2             Configure the cluster The SafeKit cluster must be defined before installing, configuring, or starting a SafeKit module. A Safekit cluster is defined by a set of networks and the addresses, on these networks, of a group of SafeKit servers, named nodes. These nodes implement one or more modules. Each server is not necessarily connected to all the networks, but at least one. The cluster configuration is saved on the servers’ side into the cluster.xml file (see section 12). For a correct behavior, it is required to apply the same cluster configuration on all the nodes. | | | | --- | --- | | Commentaire important contour | You must fully define the cluster configuration before installing and configuring modules since the modification of the cluster can affect the configuration or the execution of installed modules. |   The cluster configuration home page is available: ·         Directly via the URL http://host:9010/console/en/configuration/cluster Or ·         By navigating the console via ![](safekituserguideen_fichiers/image061.png) “Configuration/Cluster configuration”   If the cluster is not yet configured, the cluster configuration wizard is automatically opened. ### 3.2.1         Cluster configuration wizard Open the configuration wizard: ·         Directly via the URL http://host:9010/console/en/configuration/cluster/config Or ·         Navigate in the console via ![](safekituserguideen_fichiers/image040.png)“Configuration/Cluster configuration/ ![](safekituserguideen_fichiers/image061.png)Configure the cluster/”   The cluster configuration wizard is a step-by-step guided form: ![SafeKit web console image The cluster configuration wizard](safekituserguideen_fichiers/image062.jpg) 1.    “Edit cluster configuration” described in section 3.2.1.1 2.    “Check result” described in section 3.2.1.2 3.    ![](safekituserguideen_fichiers/image063.png) to “Exit cluster configuration wizard” #### 3.2.1.1      Edit cluster configuration ![SafeKit web console image Edit the cluster configuration using the cluster configuration wizard. Define 2 LANs and IP addresses of 2 nodes on these networks ](safekituserguideen_fichiers/image064.png) ·         (1) Fill in the form to first assign a user-friendly name for the network. This name is used for configuring heartbeat networks used by a module. Click on ![](safekituserguideen_fichiers/image065.png) to add another node/lan or on ![](safekituserguideen_fichiers/image066.png) to remove the node/lan from the cluster. | | | | --- | --- | | Commentaire important contour | When a node/lan is removed from the cluster, all modules using it in its configuration may become unusable. | ·         (2) Fill in the IP address of the node and then press the Tab key to check the server connectivity and automatically insert the server hostname. The icon next to the address reflects the reachability of the node. | | | --- | | SafeKit web console image Tooltip with cluster node information in the cluster configuration wizard means that the SafeKit server is available. The tooltip gives information on the server. | | SafeKit web console image Tooltip for connection issues in the cluster configuration wizard means that there was no reply from the server within the timeout delay. Fix the problem to be able to administer this node. It may be a bad address, a network or host failure, a bad configuration of the web browser or the firewall, the stop of the SafeKit web service on the node. For solving the problem, refer to the section 7.1. |   ·         Change the node name if necessary. This name is the one that will be used by the SafeKit administration service for uniquely identifying a SafeKit node. It is also the one displayed into the SafeKit web console. ·         (3) If you prefer, click on “Advanced configuration” to switch to XML cluster editing. Click on ![](safekituserguideen_fichiers/image071.png) to open the SafeKit User’s Guide on the configuration description in the cluster.xml file. ·         Click on “Reload” to discard your current modifications and reload the original configuration. ·         (4) Once the edition is completed, click on “Save and Apply” to save and apply the edited configuration to all nodes in the cluster.   | | | | --- | --- | | Commentaire important contour | If required, you can reapply the configuration to all nodes without modifying it. |   | | | | --- | --- | | Sous-titres contour | For examples of cluster configurations with two networks  refer to section 15.1.1; with three nodes refer to section 15.2.1. |   #### 3.2.1.2      Check result ![SafeKit web console image Check the cluster configuration results on all nodes using the cluster configuration wizard](safekituserguideen_fichiers/image074.png) ·         (1) Read the result of the operation on each node: o    “Success”![](safekituserguideen_fichiers/image075.png) means the configuration was successful. o    “Failure”![](safekituserguideen_fichiers/image076.png) means the configuration has failed. Click to read the output of commands executed on the node and search for the error.  You may need to modify the parameters entered or connect to the node to correct the problem. Once the error has been corrected, “Save and apply” again. ·         (2) Click on “Configure modules” to exit the cluster configuration wizard and navigate to modules configuration. Or ·         (3) Click on ![](safekituserguideen_fichiers/image077.png) to “Exit the cluster configuration wizard” and navigate to the cluster configuration home page ### 3.2.2         Cluster configuration home page When the cluster is configured, the cluster configuration home page is available. Open it: ·         Directly via the URL http://host:9010/console/en/configuration/cluster Or ·         By navigating the console via ![](safekituserguideen_fichiers/image078.png)“Configuration/Cluster configuration”   In this example, the console is loaded from 10.0.0.107, which corresponds to node1 in the existing cluster. This is the connection node. ![SafeKit web console image Cluster configuration home page](safekituserguideen_fichiers/image079.png) ·         (1) Click on ![](safekituserguideen_fichiers/image080.png)“Configuration” in the navigation sidebar ·         (2) Click on “Cluster configuration” tab Nodes configured in the cluster are listed with their configuration date. ·         (3) Click on ![](safekituserguideen_fichiers/image081.png) to display details about the node: networks name and addresses defined in the cluster configuration, SafeKit version, license key, hostname, OS. ·         (4) Click on one of the buttons: o    ![](safekituserguideen_fichiers/image082.png) to modify the cluster configuration and/or re-apply it. This opens the cluster configuration wizard and loads the cluster configuration from the connection node. o    ![](safekituserguideen_fichiers/image083.png) to download the cluster configuration in XML format from the connection node. o    ![](safekituserguideen_fichiers/image084.png) to unconfigure the cluster on one or more nodes ## 3.3             Configure an application module Once the cluster has been set up, you can configure a new module on the cluster. The module configuration home page is accessible: ·         Directly via the URL http://host:9010/console/en/configuration/modules Or ·         By navigating the console via ![](safekituserguideen_fichiers/image085.png)“Configuration/Modules configuration” If no module has been configured, the console automatically presents the page for configuring a “New module”. | | | | --- | --- | | Sous-titres contour | For module configuration examples refer to section 15. | ### 3.3.1         Select the new module to configure In this example, the console is loaded from 10.0.0.107, which corresponds to node1 in the existing cluster. This is the connection node. ![SafeKit web console image Select a new module to configure from the configuration home page](safekituserguideen_fichiers/image087.png) ·         (1) Click on ![](safekituserguideen_fichiers/image088.png)“Configuration” in the navigation sidebar ·         (2) Click on “Modules configuration” tab ·         (3) Click on “New Module” The page proposes to select a new module among several proposals visible by clicking on ![](safekituserguideen_fichiers/image081.png): o    the “Main modules”, including the generic mirror.safe (refer to section 15.1.2) and farm.safe (refer to section 15.2.2) modules for integrating a new application into a mirror or farm architecture. Here are the modules stored on the connection node, node1, under SAFE/Application\_Modules/generic, SAFE/Application\_Modules/demo and SAFE/Application\_Modules/published. o    “Backup modules” archived on the connection node, which are saved when a module is uninstalled on this node. They are loaded from node1 under SAFE/Application\_Modules/backup. o    “Other modules” which are examples of SafeKit features used in modules supplied for testing purposes only. Refer to section 15 for the description some of them. They are loaded from node1 under SAFE/Application\_Modules/other. o    A locally stored module accessible from “Upload module”. This feature can be used to configure a module for a given application (e.g., Microsoft SQL Server, PostgreSQL…) downloaded from one of the SafeKit quick installation guides. ·         (4) Select a module to configure from those listed above. In the example, mirror.safe. ·         (5) Click on the button ![](safekituserguideen_fichiers/image088.png)Configure the new module. ·         A dialog opens to give the new module name ![SafeKit web console image Enter the name of the new module](safekituserguideen_fichiers/image089.png) ·         (6) Enter the name of the new module. ·         (7) Click on “Confirm” The module configuration wizard is opened. This is described below. ### 3.3.2         Module configuration wizard The module configuration wizard is a step-by-step guided form.: ![SafeKit web console image The module configuration wizard](safekituserguideen_fichiers/image090.png) 1.    “Edit module configuration” described in section 3.3.2.1 2.    “Edit module scripts (Optional)” described in section 3.3.2.2 3.    “Enable communication encryption (Optional)” described in section 3.3.2.3 4.    “Save and apply” described in section 3.3.2.4 5.    “Check result” described in section 3.3.2.5 6.    ![](safekituserguideen_fichiers/image091.png) to “Exit module configuration wizard” Note that module reconfiguration can only be applied to nodes on which the module in question is not started. Therefore, stop the module before starting the configuration wizard. | | | | --- | --- | | Commentaire important contour | If needed, you can reapply the module configuration on all nodes without modifying it. | #### 3.3.2.1      Edit module configuration Below is an example of editing the mirror.safe module configuration. ![SafeKit web console image Edit the module configuration using the module configuration wizard](safekituserguideen_fichiers/image093.png) ·         (1) Fill in the form to assign values to the various components, add or remove them. Click on ![](safekituserguideen_fichiers/image081.png) to open the detailed panel for each component. This form is used to enter only the main module configuration parameters. | | | | --- | --- | | Commentaire, ajouter contour | The names of the “Heartbeat networks” proposed are the names of the lans entered during cluster configuration. | ·         (2) For advanced module configuration, exhaustive compared to the form, click on “Advanced configuration”. This switches to editing the module configuration file in XML format, userconfig.xml. Click on ![](safekituserguideen_fichiers/image071.png) to open the SafeKit User’s Guide describing the configuration of the various components in the userconfig.xml file. ·         If necessary, click on “Reload” to discard your modifications and reload the complete original configuration (including scripts if these were modified in the next step). ·         (3) Once you have finished editing the module configuration, click on “Next step”.   | | | | --- | --- | | Sous-titres contour | For examples of mirror module configuration, refer to section 15.1.2 ; of farm module configuration, refer to section 15.2.2. | #### 3.3.2.2      Edit module scripts Below is an example of editing the mirror.safe module scripts. ![SafeKit web console image Edit the module scripts using the module configuration wizard](safekituserguideen_fichiers/image094.png) ·         (1) Click on “start\_prim” or “stop\_prim” to edit it and insert your application start/stop. Click on ![](safekituserguideen_fichiers/image095.png) to copy the content and edit it with your favorite syntax editor. Once done, paste the modified content into the input field with ![](safekituserguideen_fichiers/image096.png). ·         (2) If necessary, click on “Advanced configuration” to list the other module’s scripts and edit them (prestart, poststop, scripts for checkers…). ·         Click on ![](safekituserguideen_fichiers/image071.png) to open the SafeKit User’s Guide describing the module scripts. ·         If necessary, click on “Reload” to discard your modifications and reload the complete original configuration (including the module configuration if it was modified in the previous step). ·         (3) Once you have finished editing the module scripts, click on “Next step”.   | | | | --- | --- | | Sous-titres contour | For examples of mirror module scripts, refer to section 15.1.3 ; of farm module scripts, refer to section 15.2.3. | #### 3.3.2.3      Enable communication encryption Encryption of internal module communications between cluster nodes is enabled by default. For details, see section 10.7. ![SafeKit web console image Enable/disable encryption of module communications using the module configuration wizard](safekituserguideen_fichiers/image098.png) ·         (1) Click “Enable” to enable or disable encryption of module communications. | | | | --- | --- | | Commentaire important contour | When the module's encryption key is not identical on all nodes, internal communication is impossible. The configuration must be reapplied to all nodes to propagate the same key. |   To generate new encryption keys, you need to: 1.    disable encryption, then “Save and apply” configuration to all nodes 2.    enable encryption, then “Save and apply” configuration to all nodes ·         If necessary, click on “Reload” to discard your modifications and reload the complete original configuration (including the module configuration and scripts if these were modified in the previous steps). ·         (2) Once this step is complete, click on “Next step”. #### 3.3.2.4      Save and apply Step to select the nodes affected by the configuration. ![SafeKit web console image Select the nodes on which to save and apply the module configuration using the module configuration wizard](safekituserguideen_fichiers/image100.png) ·         (1) Check/uncheck to select/unselect nodes. Please note that the connection node (node1 in the example) is mandatory. There are 2 cases where “Save and Apply” is disabled: | | | --- | | SafeKit web console image Situation where the node cannot be selected, in the module configuration wizard, because the module is running The module on the selected node is started and, in a state, other than STOP (NotReady). | | SafeKit web console image Situation where the node cannot be selected, iin the module configuration wizard, because the node is not responding There was no reply from the node within the timeout delay. It may be a bad address, a network or host failure, a bad configuration of the web browser or the firewall, the stop of the SafeKit web service on the node. For solving the problem, refer to the section 7.1. | In both cases, uncheck the node or click on “Save and check” to apply it later, after stopping the module or solving the communication problem. ·         (2) Click on “Save and check” to save the edited configuration on the connection node and check its consistency. It then proceeds to the next step to display the result of this operation. Once this operation has been completed, any changes are saved on the connection node. The configuration wizard can be closed and relaunched later to apply the saved configuration. Until the saved configuration is applied, the last applied configuration of the module remains active. ·         (3) Click on “Save and apply” to save and apply the edited configuration on selected nodes. It then proceeds to the next step to display the result of this operation. If this operation is successful, the applied configuration becomes the active one for the module. | | | | --- | --- | | Commentaire important contour | On the server side, the module configuration is saved under SAFE/modules/*AM* (where *AM* is the module name). When reconfiguring a module, this directory is deleted and overwritten with the changes made in the console. Thus, on the servers’ side, you must close all editors, file explorers, shells or cmd under SAFE/modules/*AM* before applying the configuration (otherwise there is a risk that the apply fails). | #### 3.3.2.5      Check result The example below shows the result of the “Save and Apply” operation. The layout for “Save and Verify” is similar. ![SafeKit web console image Check the module configuration results on the nodes using the module configuration wizard](safekituserguideen_fichiers/image104.png) ·         (1) Read the result of the operation on each node: o    “Success”![](safekituserguideen_fichiers/image105.png) means the operation was successful. o    “Failure”![](safekituserguideen_fichiers/image106.png) means the operation has failed. Click to read the output of commands executed on the node and search for the error.  You may need to modify the parameters entered or connect to the node to correct the problem. Once the error has been corrected, repeat the operation from the previous step. ·         (2) Click on “Monitor modules” to exit the module configuration wizard and navigate to modules monitoring. Or ·         (3) Click on ![](safekituserguideen_fichiers/image077.png) to “Exit the module configuration wizard” and navigate to the modules configuration home page. ### 3.3.3         Modules configuration home page Once the first module has been configured, the module configuration home page is available. It allows you to view the modules installed on the cluster and to access the configuration of a new module. Open it: ·         Directly via the URL http://host:9010/console/en/configuration/modules Or ·         By navigating the console via ![](safekituserguideen_fichiers/image085.png)“Configuration/Modules configuration”   | | | | --- | --- | | Commentaire important contour | Before each reconfiguration, deconfiguration and uninstallation, on each node, close all editors, file explorer, shells or cmd under SAFE/modules/*AM* (or risk the operation failing). |   In the following example, the console is loaded from 10.0.0.107, which corresponds to node1 in the existing cluster. This is the connection node. ![SafeKit web console image Installed modules on the configuration home page](safekituserguideen_fichiers/image108.png) ·         (1) Click on ![](safekituserguideen_fichiers/image088.png)“Configuration” in the navigation sidebar. ·         (2) Click on “Modules configuration” tab. ·         Modules installed on the cluster are listed with the date the configuration was applied and, if applicable, the date the configuration was saved but not yet applied. ·         (3) Click on one of the buttons associated with the module: o    ![](safekituserguideen_fichiers/image109.png) to modify its configuration or reapply its current configuration. This opens the module configuration wizard and loads its current configuration from the connection node. o    ![](safekituserguideen_fichiers/image110.png) to download the .safe, consisting of all module files (userconfig.xml, scripts) from the connection node. o    ![](safekituserguideen_fichiers/image111.png) to reconfigure the module from the contents of a locally stored .safe. o    ![](safekituserguideen_fichiers/image112.png) to restore a previous module configuration. o    SafeKit keeps a copy of the last three successful configurations (stored under SAFE/modules/lastconfig on the server side). All module configuration files are packaged in a .safe file, whose name is of the type of *AM*\_\_