diff options
Diffstat (limited to 'doc/book-enea-edge-getting-started')
-rw-r--r-- | doc/book-enea-edge-getting-started/doc/advanced_configurations.xml | 22 | ||||
-rw-r--r-- | doc/book-enea-edge-getting-started/doc/book.xml | 4 | ||||
-rw-r--r-- | doc/book-enea-edge-getting-started/doc/images/create_tileserver.png | bin | 0 -> 18018 bytes | |||
-rw-r--r-- | doc/book-enea-edge-getting-started/doc/images/mfa_first_time_setup.png | bin | 0 -> 42259 bytes | |||
-rw-r--r-- | doc/book-enea-edge-getting-started/doc/images/mfa_login.png | bin | 0 -> 9012 bytes | |||
-rw-r--r-- | doc/book-enea-edge-getting-started/doc/net_config_options.xml | 2 | ||||
-rw-r--r-- | doc/book-enea-edge-getting-started/doc/security.xml | 124 | ||||
-rw-r--r-- | doc/book-enea-edge-getting-started/doc/submaps.xml | 608 | ||||
-rw-r--r-- | doc/book-enea-edge-getting-started/doc/troubleshooting.xml | 9 | ||||
-rw-r--r-- | doc/book-enea-edge-getting-started/doc/whitelabel.xml | 136 |
10 files changed, 722 insertions, 183 deletions
diff --git a/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml b/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml index 5f20c7f..e1917f4 100644 --- a/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml +++ b/doc/book-enea-edge-getting-started/doc/advanced_configurations.xml | |||
@@ -440,7 +440,7 @@ node0.1048576kB = 3 </programlisting> | |||
440 | to the location where the Enea Edge Management application is | 440 | to the location where the Enea Edge Management application is |
441 | installed:</para> | 441 | installed:</para> |
442 | 442 | ||
443 | <programlisting>./createCertificate.sh EneaEdgeManagement <IP_or_domain> \ | 443 | <programlisting>./createCertificate.sh EneaEdgeManagement <IP_or_domain> \ |
444 | /opt/ems [<service_username>]</programlisting> | 444 | /opt/ems [<service_username>]</programlisting> |
445 | 445 | ||
446 | <para>Where the following need to be included:</para> | 446 | <para>Where the following need to be included:</para> |
@@ -521,6 +521,12 @@ node0.1048576kB = 3 </programlisting> | |||
521 | <section id="restore_nfvi_backup"> | 521 | <section id="restore_nfvi_backup"> |
522 | <title>Restoring an NFVi backup</title> | 522 | <title>Restoring an NFVi backup</title> |
523 | 523 | ||
524 | <note> | ||
525 | <para>In order to restore an NFVi backup, the Enea Edge Runtime | ||
526 | version installed on the uCPE device needs to be the same at | ||
527 | restoration as it was when the snapshot was created.</para> | ||
528 | </note> | ||
529 | |||
524 | <para>When needed, an NFVi backup can be restored in the following | 530 | <para>When needed, an NFVi backup can be restored in the following |
525 | way:</para> | 531 | way:</para> |
526 | 532 | ||
@@ -1201,20 +1207,20 @@ Switch to unix_socket authentication [Y/n] <emphasis role="bold">Y</emphasis> | |||
1201 | Enabled successfully! | 1207 | Enabled successfully! |
1202 | Reloading privilege tables.. | 1208 | Reloading privilege tables.. |
1203 | ... Success! | 1209 | ... Success! |
1204 | … | 1210 | ... |
1205 | Change the root password? [Y/n] <emphasis role="bold">Y</emphasis> | 1211 | Change the root password? [Y/n] <emphasis role="bold">Y</emphasis> |
1206 | New password: | 1212 | New password: |
1207 | Re-enter new password: | 1213 | Re-enter new password: |
1208 | Password updated successfully! | 1214 | Password updated successfully! |
1209 | Reloading privilege tables.. | 1215 | Reloading privilege tables.. |
1210 | ... Success! | 1216 | ... Success! |
1211 | … | 1217 | ... |
1212 | Remove anonymous users? [Y/n] <emphasis role="bold">Y</emphasis> | 1218 | Remove anonymous users? [Y/n] <emphasis role="bold">Y</emphasis> |
1213 | ... Success! | 1219 | ... Success! |
1214 | … | 1220 | ... |
1215 | Disallow root login remotely? [Y/n] <emphasis role="bold">Y</emphasis> | 1221 | Disallow root login remotely? [Y/n] <emphasis role="bold">Y</emphasis> |
1216 | ... Success! | 1222 | ... Success! |
1217 | … | 1223 | ... |
1218 | Remove test database and access to it? [Y/n] <emphasis role="bold">Y (optional)</emphasis> | 1224 | Remove test database and access to it? [Y/n] <emphasis role="bold">Y (optional)</emphasis> |
1219 | - Dropping test database... | 1225 | - Dropping test database... |
1220 | ... Success! | 1226 | ... Success! |
@@ -1287,7 +1293,7 @@ External database selected, getting user information ... | |||
1287 | Press 1 for PostgreSQL, 2 for MariaDB, 3 for SQL Server, 4 for Oracle and 5 \ | 1293 | Press 1 for PostgreSQL, 2 for MariaDB, 3 for SQL Server, 4 for Oracle and 5 \ |
1288 | for MySQL: <emphasis role="bold">2</emphasis> | 1294 | for MySQL: <emphasis role="bold">2</emphasis> |
1289 | Specify database server name(s) or IP Address(es): \ | 1295 | Specify database server name(s) or IP Address(es): \ |
1290 | <emphasis role="bold">192.168.10.11,192.168.10.12,…,192.168.10.16 *(see note)</emphasis> | 1296 | <emphasis role="bold">192.168.10.11,192.168.10.12,...,192.168.10.16 *(see note)</emphasis> |
1291 | Specify database ID (or name) [ucpemanager]: | 1297 | Specify database ID (or name) [ucpemanager]: |
1292 | Specify database server port [3306]: | 1298 | Specify database server port [3306]: |
1293 | Specify database user name [root]: enea | 1299 | Specify database user name [root]: enea |
@@ -1296,11 +1302,11 @@ Specify database startup thread pool size [1]: | |||
1296 | Creating database configuration file \ | 1302 | Creating database configuration file \ |
1297 | /opt/ucpemanager/application/config/databaseConfig.xml ... | 1303 | /opt/ucpemanager/application/config/databaseConfig.xml ... |
1298 | Done . | 1304 | Done . |
1299 | … | 1305 | ... |
1300 | Installing ucpemanager service .. | 1306 | Installing ucpemanager service .. |
1301 | Specify service username [EneaEdgeManagement]: | 1307 | Specify service username [EneaEdgeManagement]: |
1302 | Specify service password [EneaEdgeManagement]: somepassword | 1308 | Specify service password [EneaEdgeManagement]: somepassword |
1303 | … | 1309 | ... |
1304 | Specify the IP address of the local interface: <emphasis role="bold">192.168.10.11</emphasis> | 1310 | Specify the IP address of the local interface: <emphasis role="bold">192.168.10.11</emphasis> |
1305 | Is this server part of a cluster? [Y/N]: <emphasis role="bold">Y</emphasis> | 1311 | Is this server part of a cluster? [Y/N]: <emphasis role="bold">Y</emphasis> |
1306 | Specify the name of the cluster [EneaEdgeManagement]: | 1312 | Specify the name of the cluster [EneaEdgeManagement]: |
diff --git a/doc/book-enea-edge-getting-started/doc/book.xml b/doc/book-enea-edge-getting-started/doc/book.xml index e74ac85..e0126ba 100644 --- a/doc/book-enea-edge-getting-started/doc/book.xml +++ b/doc/book-enea-edge-getting-started/doc/book.xml | |||
@@ -38,6 +38,10 @@ | |||
38 | 38 | ||
39 | <xi:include href="submaps.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> | 39 | <xi:include href="submaps.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> |
40 | 40 | ||
41 | <xi:include href="security.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
42 | |||
43 | <xi:include href="whitelabel.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
44 | |||
41 | <xi:include href="grafana.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> | 45 | <xi:include href="grafana.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> |
42 | 46 | ||
43 | <xi:include href="troubleshooting.xml" | 47 | <xi:include href="troubleshooting.xml" |
diff --git a/doc/book-enea-edge-getting-started/doc/images/create_tileserver.png b/doc/book-enea-edge-getting-started/doc/images/create_tileserver.png new file mode 100644 index 0000000..169ad81 --- /dev/null +++ b/doc/book-enea-edge-getting-started/doc/images/create_tileserver.png | |||
Binary files differ | |||
diff --git a/doc/book-enea-edge-getting-started/doc/images/mfa_first_time_setup.png b/doc/book-enea-edge-getting-started/doc/images/mfa_first_time_setup.png new file mode 100644 index 0000000..c0230f5 --- /dev/null +++ b/doc/book-enea-edge-getting-started/doc/images/mfa_first_time_setup.png | |||
Binary files differ | |||
diff --git a/doc/book-enea-edge-getting-started/doc/images/mfa_login.png b/doc/book-enea-edge-getting-started/doc/images/mfa_login.png new file mode 100644 index 0000000..79d9696 --- /dev/null +++ b/doc/book-enea-edge-getting-started/doc/images/mfa_login.png | |||
Binary files differ | |||
diff --git a/doc/book-enea-edge-getting-started/doc/net_config_options.xml b/doc/book-enea-edge-getting-started/doc/net_config_options.xml index a9faf0a..e964ecd 100644 --- a/doc/book-enea-edge-getting-started/doc/net_config_options.xml +++ b/doc/book-enea-edge-getting-started/doc/net_config_options.xml | |||
@@ -930,7 +930,7 @@ | |||
930 | requirements compliance, channels are scanned in order to avoid | 930 | requirements compliance, channels are scanned in order to avoid |
931 | overlapping with existing networks. If overlaps are detected, primary | 931 | overlapping with existing networks. If overlaps are detected, primary |
932 | and secondary Wireless AP channels will be swapped, resulting in an | 932 | and secondary Wireless AP channels will be swapped, resulting in an |
933 | effective channel width of 20MHz instead of 40Mhz being used. | 933 | effective channel width of 20MHz instead of 40MHz being used. |
934 | To avoid this, select another wireless channel.</para> | 934 | To avoid this, select another wireless channel.</para> |
935 | 935 | ||
936 | <para>For the 5GHz band, the <literal>802.11 n</literal> and the | 936 | <para>For the 5GHz band, the <literal>802.11 n</literal> and the |
diff --git a/doc/book-enea-edge-getting-started/doc/security.xml b/doc/book-enea-edge-getting-started/doc/security.xml new file mode 100644 index 0000000..9929786 --- /dev/null +++ b/doc/book-enea-edge-getting-started/doc/security.xml | |||
@@ -0,0 +1,124 @@ | |||
1 | <?xml version="1.0" encoding="UTF-8"?> | ||
2 | <chapter id="security"> | ||
3 | <title>Security</title> | ||
4 | |||
5 | <section id="mfa_security"> | ||
6 | <title>Authenticating using Multi-Factor Authentication</title> | ||
7 | |||
8 | <para>Enea Edge Management provides the ability to authenticate using the | ||
9 | MFA authentication method. This is offered as a two-step procedure: first, | ||
10 | the user enters the local user/password credentials. Then the security | ||
11 | token generated by Google Authenticator must be introduced. This is based | ||
12 | on a shared secret between the Enea Edge Management and the Google | ||
13 | Authenticator applications. The shared secret is a 32 character long | ||
14 | string that is presented to the user upon first login as a character | ||
15 | sequence and a QR code.</para> | ||
16 | |||
17 | <note> | ||
18 | <para>Configuring MFA will only be possible using the Web interface, and | ||
19 | not the REST API. Users with MFA enabled will not be able to log in | ||
20 | through the REST API. If attempted, a <literal>401</literal> HTTP code | ||
21 | will be returned, with the <literal>EMS-Error</literal> header | ||
22 | containing the <literal>EMS_UserMFAEnabled</literal> error.</para> | ||
23 | </note> | ||
24 | |||
25 | <section id="config_mfa"> | ||
26 | <title>Configuring User MFA</title> | ||
27 | |||
28 | <para>The administrator must enable MFA authentication for the desired | ||
29 | new user:</para> | ||
30 | |||
31 | <orderedlist> | ||
32 | <listitem> | ||
33 | <para>Access the <emphasis role="bold">Security</emphasis> tab and | ||
34 | choose the <emphasis role="bold">Configuration</emphasis> | ||
35 | menu.</para> | ||
36 | </listitem> | ||
37 | |||
38 | <listitem> | ||
39 | <para>Select the <emphasis role="bold">Add</emphasis> option, enter | ||
40 | the details for the new user and enable the <emphasis | ||
41 | role="bold">Enable MFA Login</emphasis> checkbox.</para> | ||
42 | </listitem> | ||
43 | </orderedlist> | ||
44 | |||
45 | <para>It is also possible to enable/disable MFA for existing users by | ||
46 | selecting the user and checking/unchecking the Enable MFA Login checkbox | ||
47 | in the right-hand side panel. Disabling MFA for a user will also clear | ||
48 | the secret from the database, therefore upon re-enabling it the user will | ||
49 | be asked to configure a new shared secret. For more details on how to | ||
50 | configure a new shared secret, please see the following section.</para> | ||
51 | |||
52 | <para>All MFA information for enabled users will be preserved upon | ||
53 | upgrading or restoring the Enea Edge Management application.</para> | ||
54 | </section> | ||
55 | |||
56 | <section id="security_authentication"> | ||
57 | <title>Security Authentication</title> | ||
58 | |||
59 | <para>The user will enter his credentials (username and password) as in | ||
60 | a typical local authentication. He will then be redirected to a second | ||
61 | page that presents the secret as a QR code, that he must scan using the | ||
62 | Google Authenticator application. The secret is also presented in clear | ||
63 | text ready for copying and manual entry, in case scanning the QR code | ||
64 | does not work.</para> | ||
65 | |||
66 | <figure> | ||
67 | <title>Initial setup for Multi-Factor login</title> | ||
68 | |||
69 | <mediaobject> | ||
70 | <imageobject> | ||
71 | <imagedata align="center" | ||
72 | fileref="images/mfa_first_time_setup.png" scale="60" /> | ||
73 | </imageobject> | ||
74 | </mediaobject> | ||
75 | </figure> | ||
76 | |||
77 | <para>Once the scanning or manual entry is completed successfully, the | ||
78 | Edge Management and Google Authenticator applications have the same | ||
79 | secret configured. The Authenticator application will then offer a | ||
80 | security token as a six digit number that the user must enter on the | ||
81 | same page, in the Enea Edge Management application. If the token is | ||
82 | correct, authentication is successful. The six digit token is available | ||
83 | for a maximum of 30 seconds.</para> | ||
84 | |||
85 | <para>Subsequent logins will still be done using a two-step method. The | ||
86 | user will provide first his credentials, and on the second page the | ||
87 | token as generated by Google Authenticator.</para> | ||
88 | |||
89 | <figure> | ||
90 | <title>Second login</title> | ||
91 | |||
92 | <mediaobject> | ||
93 | <imageobject> | ||
94 | <imagedata align="center" fileref="images/mfa_login.png" | ||
95 | scale="80" /> | ||
96 | </imageobject> | ||
97 | </mediaobject> | ||
98 | </figure> | ||
99 | |||
100 | <note> | ||
101 | <para>If the shared secret is lost, it can be regenerated by the | ||
102 | administrator by disabling and re-enabling the MFA Login for the selected | ||
103 | user. For more information, please see <olink targetdoc="book_enea_edge_getting_started" | ||
104 | targetptr="config_mfa">Configuring User MFA in the <ns:include | ||
105 | href="../../s_docbuild/olinkdb/pardoc-names.xml" | ||
106 | xmlns:ns="http://www.w3.org/2001/XInclude" | ||
107 | xpointer="element(book_enea_edge_getting_started/1)" /></olink> Manual. When the | ||
108 | MFA Login is disabled, the secret is also erased from the | ||
109 | database.</para> | ||
110 | </note> | ||
111 | </section> | ||
112 | |||
113 | <section id="token_generators"> | ||
114 | <title>Supported Token Generators</title> | ||
115 | |||
116 | <para>Multi Factor Authentication in the Enea Edge Management | ||
117 | application is supported only for Google Authenticator.</para> | ||
118 | |||
119 | <para>The time on the server hosting the Enea Edge Management | ||
120 | application and the device holding the Authenticator application must | ||
121 | be synchronized, within an error margin of 30 seconds.</para> | ||
122 | </section> | ||
123 | </section> | ||
124 | </chapter> \ No newline at end of file | ||
diff --git a/doc/book-enea-edge-getting-started/doc/submaps.xml b/doc/book-enea-edge-getting-started/doc/submaps.xml index bdb769e..192e420 100644 --- a/doc/book-enea-edge-getting-started/doc/submaps.xml +++ b/doc/book-enea-edge-getting-started/doc/submaps.xml | |||
@@ -1,38 +1,43 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | 1 | <?xml version="1.0" encoding="UTF-8"?> |
2 | <chapter id="submaps"> | 2 | <chapter condition="hidden" id="maps"> |
3 | <title>Submaps</title> | 3 | <title>Maps</title> |
4 | 4 | ||
5 | <para>The System domain of the Enea Edge Managemement application can be | 5 | <section id="submaps"> |
6 | split into different submaps, used to organize the uCPE devices more | 6 | <title>Submaps</title> |
7 | effectively. Each domain is organized like a tree, with each submap being | 7 | |
8 | able to have several other submaps within it. Each device can be placed in | 8 | <para>The System domain of the Enea Edge Management application can be |
9 | only one submap and the user can create virtual links between devices.</para> | 9 | split into different submaps, used to organize the uCPE devices more |
10 | 10 | effectively. Each domain is organized like a tree, with each submap being | |
11 | <para>Submaps support managed and unmanaged uCPE devices. An unmanaged | 11 | able to have several other submaps within it. Each device can be placed in |
12 | device is an icon that looks like a device within the | 12 | only one submap and the user can create virtual links between |
13 | <emphasis role="bold">Map</emphasis> (it supports links and has a similar | 13 | devices.</para> |
14 | icon) but is not a real managed device.</para> | 14 | |
15 | 15 | <para>Submaps support managed and unmanaged uCPE devices. An unmanaged | |
16 | <section id="submap_op"> | 16 | device is an icon that looks like a device within the <emphasis |
17 | <title>Submap Operations</title> | 17 | role="bold">Map</emphasis> (it supports links and has a similar icon) but |
18 | 18 | is not a real managed device.</para> | |
19 | <para>In the <emphasis role="bold">System</emphasis> view, right-clicking | 19 | |
20 | on a submap opens up a menu with the following operations:</para> | 20 | <section id="submap_op"> |
21 | 21 | <title>Submap Operations</title> | |
22 | <itemizedlist> | 22 | |
23 | <listitem> | 23 | <para>In the <emphasis role="bold">System</emphasis> view, |
24 | <para>Add Submap</para> | 24 | right-clicking on a submap opens up a menu with the following |
25 | 25 | operations:</para> | |
26 | <para>This option is used for adding a new submap, placed in the | 26 | |
27 | <emphasis role="bold">System</emphasis> view under the current one in | 27 | <itemizedlist> |
28 | the tree. The new submap will also be added in the <emphasis | 28 | <listitem> |
29 | role="bold">Map</emphasis> view of the parent submap.</para> | 29 | <para>Add Submap</para> |
30 | 30 | ||
31 | <para>When selecting this option, the following fields need to be set | 31 | <para>This option is used for adding a new submap, placed in the |
32 | in the <emphasis role="bold">Add Submap</emphasis> window that | 32 | <emphasis role="bold">System</emphasis> view under the current one |
33 | pops-up:</para> | 33 | in the tree. The new submap will also be added in the <emphasis |
34 | 34 | role="bold">Map</emphasis> view of the parent submap.</para> | |
35 | <table id="submap_props"> | 35 | |
36 | <para>When selecting this option, the following fields need to be | ||
37 | set in the <emphasis role="bold">Add Submap</emphasis> window that | ||
38 | pops up:</para> | ||
39 | |||
40 | <table id="submap_props"> | ||
36 | <title>Submap properties</title> | 41 | <title>Submap properties</title> |
37 | 42 | ||
38 | <tgroup cols="2"> | 43 | <tgroup cols="2"> |
@@ -54,7 +59,7 @@ | |||
54 | <entry>Background Color</entry> | 59 | <entry>Background Color</entry> |
55 | 60 | ||
56 | <entry>The background color of the domain map. Possible | 61 | <entry>The background color of the domain map. Possible |
57 | values: white, black, blue, cyan, grey, green, magenta, | 62 | values: white, black, blue, cyan, gray, green, magenta, |
58 | orange, pink, red, yellow.</entry> | 63 | orange, pink, red, yellow.</entry> |
59 | </row> | 64 | </row> |
60 | 65 | ||
@@ -118,84 +123,86 @@ | |||
118 | </tgroup> | 123 | </tgroup> |
119 | </table> | 124 | </table> |
120 | 125 | ||
121 | <note> | 126 | <note> |
122 | <para><literal>Snap to Grid</literal>, <literal>Direction</literal> | 127 | <para><literal>Snap to Grid</literal>, |
123 | and <literal>Sort Method</literal> have the <literal>System | 128 | <literal>Direction</literal> and <literal>Sort Method</literal> |
124 | Default</literal> option. This option can be set by accessing | 129 | have the <literal>System Default</literal> option. This option can |
125 | <emphasis role="bold">System</emphasis>, selecting <emphasis | 130 | be set by accessing <emphasis role="bold">System</emphasis>, |
126 | role="bold">Configuration</emphasis> under the <emphasis | 131 | selecting <emphasis role="bold">Configuration</emphasis> under the |
127 | role="bold">Properties</emphasis> tab, and navigating to the <emphasis | 132 | <emphasis role="bold">Properties</emphasis> tab, and navigating to |
128 | role="bold">GUI</emphasis> tab.</para> | 133 | the <emphasis role="bold">GUI</emphasis> tab.</para> |
129 | 134 | ||
130 | <para>More images for backgrounds and icons can be uploaded by | 135 | <para>More images for backgrounds and icons can be uploaded by |
131 | accessing <emphasis role="bold">System</emphasis>, selecting | 136 | accessing <emphasis role="bold">System</emphasis>, selecting |
132 | <emphasis role="bold">Media Files</emphasis> under the <emphasis | 137 | <emphasis role="bold">Media Files</emphasis> under the <emphasis |
133 | role="bold">Icons</emphasis> tab or the <emphasis | 138 | role="bold">Icons</emphasis> tab or the <emphasis |
134 | role="bold">Backgrounds</emphasis> tab, respectively.</para> | 139 | role="bold">Backgrounds</emphasis> tab, respectively.</para> |
135 | </note> | 140 | </note> |
136 | </listitem> | 141 | </listitem> |
137 | 142 | ||
138 | <listitem> | 143 | <listitem> |
139 | <para>Remove Submap</para> | 144 | <para>Remove Submap</para> |
140 | 145 | ||
141 | <para>This option is used for removing the current submap. The submap | 146 | <para>This option is used for removing the current submap. The |
142 | must be empty, all children submaps or uCPE Devices must be deleted first.</para> | 147 | submap must be empty, all children submaps or uCPE Devices must be |
143 | </listitem> | 148 | deleted first.</para> |
144 | 149 | </listitem> | |
145 | <listitem> | 150 | |
146 | <para>Properties</para> | 151 | <listitem> |
147 | 152 | <para>Properties</para> | |
148 | <para>This option is used for viewing and/or editing the properties of | 153 | |
149 | the current submap. For more details please see the <link | 154 | <para>This option is used for viewing and/or editing the properties |
150 | linkend="submap_props">Submap properties</link> table.</para> | 155 | of the current submap. For more details please see the <link |
151 | </listitem> | 156 | linkend="submap_props">Submap properties</link> table.</para> |
152 | 157 | </listitem> | |
153 | <listitem> | 158 | |
154 | <para>Move Device</para> | 159 | <listitem> |
155 | 160 | <para>Move Device</para> | |
156 | <para>This option is used for adding devices to the current submap. | 161 | |
157 | All devices appear in this list (placed and unplaced). If the device | 162 | <para>This option is used for adding devices to the current submap. |
158 | is already added to a submap, it will be moved from that submap to the | 163 | All devices appear in this list (placed and unplaced). If the device |
159 | current one.</para> | 164 | is already added to a submap, it will be moved from that submap to |
160 | </listitem> | 165 | the current one.</para> |
161 | </itemizedlist> | 166 | </listitem> |
162 | </section> | 167 | </itemizedlist> |
163 | 168 | </section> | |
164 | <section id="map_op"> | 169 | |
165 | <title>Map Operations</title> | 170 | <section id="map_op"> |
166 | 171 | <title>Map Operations</title> | |
167 | <para>Right-clicking anywhere in the <emphasis role="bold">Map</emphasis> | 172 | |
168 | view opens up a menu with the following operations:</para> | 173 | <para>Right-clicking anywhere in the <emphasis |
169 | 174 | role="bold">Map</emphasis> view opens up a menu with the following | |
170 | <itemizedlist> | 175 | operations:</para> |
171 | <listitem> | 176 | |
172 | <para>Place Device</para> | 177 | <itemizedlist> |
173 | 178 | <listitem> | |
174 | <para>This option is used for adding one or more devices in the | 179 | <para>Place Device</para> |
175 | current submap. Only unplaced devices appear in this list.</para> | 180 | |
176 | </listitem> | 181 | <para>This option is used for adding one or more devices in the |
177 | 182 | current submap. Only unplaced devices appear in this list.</para> | |
178 | <listitem> | 183 | </listitem> |
179 | <para>Move Device</para> | 184 | |
180 | 185 | <listitem> | |
181 | <para>This option is used for moving one or more devices from other | 186 | <para>Move Device</para> |
182 | submaps to the current submap. All devices appear in this list (placed | 187 | |
183 | and unplaced). If the device is already added to a submap, it will be | 188 | <para>This option is used for moving one or more devices from other |
184 | removed from that submap.</para> | 189 | submaps to the current submap. All devices appear in this list |
185 | </listitem> | 190 | (placed and unplaced). If the device is already added to a submap, |
186 | 191 | it will be removed from that submap.</para> | |
187 | <listitem> | 192 | </listitem> |
188 | <para>Add Unmanaged</para> | 193 | |
189 | 194 | <listitem> | |
190 | <para>This option is used for creating an unmanaged device. An | 195 | <para>Add Unmanaged</para> |
191 | unmanaged device is represented by an icon in the current view that | 196 | |
192 | looks like a device (it supports links and has a similar icon) but | 197 | <para>This option is used for creating an unmanaged device. An |
193 | is not a real managed device. It will be automatically placed in the current | 198 | unmanaged device is represented by an icon in the current view that |
194 | submap. When selecting this option, the following fields need to be | 199 | looks like a device (it supports links and has a similar icon) but |
195 | set in the <emphasis role="bold">Add Unmanaged</emphasis> window that | 200 | is not a real managed device. It will be automatically placed in the |
196 | pops-up:</para> | 201 | current submap. When selecting this option, the following fields |
197 | 202 | need to be set in the <emphasis role="bold">Add Unmanaged</emphasis> | |
198 | <table id="unmanaged_props"> | 203 | window that pops up:</para> |
204 | |||
205 | <table id="unmanaged_props"> | ||
199 | <title>Unmanaged device properties</title> | 206 | <title>Unmanaged device properties</title> |
200 | 207 | ||
201 | <tgroup cols="2"> | 208 | <tgroup cols="2"> |
@@ -232,18 +239,18 @@ | |||
232 | </tbody> | 239 | </tbody> |
233 | </tgroup> | 240 | </tgroup> |
234 | </table> | 241 | </table> |
235 | </listitem> | 242 | </listitem> |
236 | 243 | ||
237 | <listitem> | 244 | <listitem> |
238 | <para>Add Link</para> | 245 | <para>Add Link</para> |
239 | 246 | ||
240 | <para>This option is used for creating a virtual link between two | 247 | <para>This option is used for creating a virtual link between two |
241 | devices. They can be any two devices, it does not matter if they are | 248 | devices. They can be any two devices, it does not matter if they are |
242 | unplaced, placed in the current submap or placed in any other submap. | 249 | unplaced, placed in the current submap or placed in any other |
243 | When selecting this option, the following fields need to be set in the | 250 | submap. When selecting this option, the following fields need to be |
244 | <emphasis role="bold">Add Link</emphasis> window:</para> | 251 | set in the <emphasis role="bold">Add Link</emphasis> window:</para> |
245 | 252 | ||
246 | <table id="link_props"> | 253 | <table id="link_props"> |
247 | <title>Link properties</title> | 254 | <title>Link properties</title> |
248 | 255 | ||
249 | <tgroup cols="2"> | 256 | <tgroup cols="2"> |
@@ -274,71 +281,324 @@ | |||
274 | </tbody> | 281 | </tbody> |
275 | </tgroup> | 282 | </tgroup> |
276 | </table> | 283 | </table> |
277 | </listitem> | 284 | </listitem> |
285 | |||
286 | <listitem> | ||
287 | <para>Properties</para> | ||
288 | |||
289 | <para>This option is used for viewing and/or editing the properties | ||
290 | of the current submap. For more details please see the <link | ||
291 | linkend="submap_props">Submap properties</link> table.</para> | ||
292 | </listitem> | ||
293 | |||
294 | <listitem> | ||
295 | <para>Arrange icons</para> | ||
296 | |||
297 | <para>This option can be used to auto-arrange devices placed in the | ||
298 | current submap. The rearrangement is done based on the submap's | ||
299 | properties.</para> | ||
300 | </listitem> | ||
301 | </itemizedlist> | ||
302 | </section> | ||
303 | |||
304 | <section id="device_op"> | ||
305 | <title>Device Operations</title> | ||
306 | |||
307 | <para>In the <emphasis role="bold">Map</emphasis> view, right-clicking | ||
308 | on a device opens up a menu with the following operations:</para> | ||
309 | |||
310 | <itemizedlist> | ||
311 | <listitem> | ||
312 | <para>Links..</para> | ||
313 | |||
314 | <para>This option is used for viewing all links to and from that | ||
315 | device.</para> | ||
316 | </listitem> | ||
317 | |||
318 | <listitem> | ||
319 | <para>Remove</para> | ||
320 | |||
321 | <para>For managed devices, this option is used for removing the | ||
322 | device from the map. The managed device will not be removed | ||
323 | completely from the Enea Edge Management application, but will be | ||
324 | moved to the <emphasis role="bold">Unplaced</emphasis> submap | ||
325 | instead.</para> | ||
326 | |||
327 | <para>For unmanaged devices, this option removes the device | ||
328 | altogether from the Enea Edge Management application.</para> | ||
329 | </listitem> | ||
330 | |||
331 | <listitem> | ||
332 | <para>Add Link</para> | ||
333 | |||
334 | <para>This option is used for creating a virtual link between two | ||
335 | devices. They can be any two devices, it does not matter if they are | ||
336 | unplaced, placed in the current submap or placed in any other | ||
337 | submap. The current device is already selected as the <emphasis | ||
338 | role="bold">From</emphasis> endpoint in the <emphasis | ||
339 | role="bold">Add Link</emphasis> pop-up. For more details please see | ||
340 | the <link linkend="link_props">Link properties</link> table.</para> | ||
341 | </listitem> | ||
342 | |||
343 | <listitem> | ||
344 | <para>Properties</para> | ||
345 | |||
346 | <para>This option is used for viewing and editing the properties of | ||
347 | an unmanaged device. For more details please see the <link | ||
348 | linkend="unmanaged_props">Unmanaged device properties</link> | ||
349 | table.</para> | ||
350 | </listitem> | ||
351 | </itemizedlist> | ||
352 | </section> | ||
353 | </section> | ||
278 | 354 | ||
279 | <listitem> | 355 | <section id="tileserver"> |
280 | <para>Properties</para> | 356 | <title>Tile Server Map</title> |
281 | 357 | ||
282 | <para>This option is used for viewing and/or editing the properties of | 358 | <para>The Enea Edge Management application has the capacity to render a |
283 | the current submap. For more details please see the <link | 359 | map from a tile server. Each uCPE device can have a set location and will |
284 | linkend="submap_props">Submap properties</link> table.</para> | 360 | be automatically placed on the tile server map at its exact |
285 | </listitem> | 361 | location.</para> |
286 | 362 | ||
287 | <listitem> | 363 | <section id="tileserver_config"> |
288 | <para>Arrange icons</para> | 364 | <title>Tile Server Configuration</title> |
289 | 365 | ||
290 | <para>This option can be used to auto-arrange devices placed in the | 366 | <para>To configure the tile server map, perform the following steps in |
291 | current submap. The rearrangement is done based on the submap's | 367 | the Enea Edge Management application:</para> |
292 | properties.</para> | ||
293 | </listitem> | ||
294 | </itemizedlist> | ||
295 | </section> | ||
296 | 368 | ||
297 | <section id="device_op"> | 369 | <orderedlist> |
298 | <title>Device Operations</title> | 370 | <listitem> |
371 | <para>Access the <emphasis role="bold">System</emphasis> menu and | ||
372 | select <emphasis role="bold">Configuration</emphasis>. A new window | ||
373 | will open.</para> | ||
374 | </listitem> | ||
299 | 375 | ||
300 | <para>In the <emphasis role="bold">Map</emphasis> view, right-clicking on | 376 | <listitem> |
301 | a device opens up a menu with the following operations:</para> | 377 | <para>In the <emphasis role="bold">System Configuration</emphasis> |
378 | window, under the <emphasis role="bold">Properties</emphasis> tab, | ||
379 | navigate to the <emphasis role="bold">GUI</emphasis> tab.</para> | ||
380 | </listitem> | ||
302 | 381 | ||
303 | <itemizedlist> | 382 | <listitem> |
304 | <listitem> | 383 | <para>Under the <emphasis role="bold">Tile Server</emphasis> |
305 | <para>Links...</para> | 384 | category, the user can set the following properties:</para> |
306 | 385 | ||
307 | <para>This option is used for viewing all links to and from that | 386 | <table id="tileserver_props"> |
308 | device.</para> | 387 | <title>Tile Server properties</title> |
309 | </listitem> | ||
310 | 388 | ||
311 | <listitem> | 389 | <tgroup cols="2"> |
312 | <para>Remove</para> | 390 | <tbody> |
391 | <row> | ||
392 | <entry>Name</entry> | ||
393 | |||
394 | <entry>The name of the domain map. This is | ||
395 | mandatory.</entry> | ||
396 | </row> | ||
313 | 397 | ||
314 | <para>For managed devices, this option is used for removing the device | 398 | <row> |
315 | from the map. The managed device will not be removed completely from | 399 | <entry>Tile server URL</entry> |
316 | the Enea Edge Management application, but will be moved to the <emphasis | ||
317 | role="bold">Unplaced</emphasis> submap instead.</para> | ||
318 | 400 | ||
319 | <para>For unmanaged devices, this option removes the device altogether | 401 | <entry>The URL of the tile server's XYZ.</entry> |
320 | from the Enea Edge Management application.</para> | 402 | </row> |
321 | </listitem> | ||
322 | 403 | ||
323 | <listitem> | 404 | <row> |
324 | <para>Add Link</para> | 405 | <entry>TileJSON URL</entry> |
325 | 406 | ||
326 | <para>This option is used for creating a virtual link between two | 407 | <entry>The URL of the TileJSON configuration file. Leave it |
327 | devices. They can be any two devices, it does not matter if they are | 408 | blank if the tile server used does not support json |
328 | unplaced, placed in the current submap or placed in any other submap. | 409 | configuration files.</entry> |
329 | The current device is already selected as the <emphasis | 410 | </row> |
330 | role="bold">From</emphasis> endpoint in the <emphasis role="bold">Add | ||
331 | Link</emphasis> pop-up. For more details please see the <link | ||
332 | linkend="link_props">Link properties</link> table.</para> | ||
333 | </listitem> | ||
334 | 411 | ||
335 | <listitem> | 412 | <row> |
336 | <para>Properties</para> | 413 | <entry>Tile server attribution</entry> |
337 | 414 | ||
338 | <para>This option is used for viewing and editing the properties of an | 415 | <entry>The attribution to be displayed on the map.</entry> |
339 | unmanaged device. For more details please see the <link | 416 | </row> |
340 | linkend="unmanaged_props">Unmanaged device properties</link> table.</para> | 417 | </tbody> |
341 | </listitem> | 418 | </tgroup> |
342 | </itemizedlist> | 419 | </table> |
420 | </listitem> | ||
421 | |||
422 | <listitem> | ||
423 | <para>Press the <emphasis role="bold">Apply</emphasis> button. The | ||
424 | <emphasis role="bold">Saved successfully</emphasis> message will be | ||
425 | shown.</para> | ||
426 | </listitem> | ||
427 | </orderedlist> | ||
428 | |||
429 | <note> | ||
430 | <para>The Browser Cross-Origin Resource Sharing (CORS) policy prevents | ||
431 | requests from HTTPS to an external HTTP. This means that if the | ||
432 | default HTTPS configuration is used for the Enea Edge Management | ||
433 | application, the application will not be able to reach a tile server | ||
434 | that is accessible only through HTTP. In this case a proxy can be | ||
435 | installed that provides a gateway for HTTPS calls to HTTP. Optionally, | ||
436 | HTTP web access can be used for accessing the Enea Edge Management | ||
437 | application.</para> | ||
438 | </note> | ||
439 | </section> | ||
440 | |||
441 | <section id="tileserver_create"> | ||
442 | <title>Creating the Tile Server View</title> | ||
443 | |||
444 | <para>To create a tile server view, perform the following steps in the | ||
445 | Enea Edge Management application:</para> | ||
446 | |||
447 | <orderedlist> | ||
448 | <listitem> | ||
449 | <para>Access the <emphasis role="bold">Security</emphasis> menu and | ||
450 | select <emphasis role="bold">Configuration</emphasis>. A new window | ||
451 | will open.</para> | ||
452 | </listitem> | ||
453 | |||
454 | <listitem> | ||
455 | <para>In the <emphasis role="bold">Security Configuration</emphasis> | ||
456 | window, navigate to the <emphasis role="bold">Views</emphasis> tab. | ||
457 | The <emphasis role="bold">Views Table</emphasis> will be | ||
458 | shown.</para> | ||
459 | </listitem> | ||
460 | |||
461 | <listitem> | ||
462 | <para>Press the <emphasis role="bold">Add</emphasis> button. A new | ||
463 | window will open.</para> | ||
464 | </listitem> | ||
465 | |||
466 | <listitem> | ||
467 | <para>In the <emphasis role="bold">Create View</emphasis> window, | ||
468 | set a name for the TileServer view, select | ||
469 | <literal>tileserver</literal> in the <emphasis role="bold">Map | ||
470 | Type</emphasis> drop-down menu and place the admin user in the | ||
471 | right-hand side list-box.</para> | ||
472 | </listitem> | ||
473 | |||
474 | <listitem> | ||
475 | <para>Press the <emphasis role="bold">OK</emphasis> button. The | ||
476 | current window will close and the success message <emphasis | ||
477 | role="bold">Created successfully</emphasis> will be shown.</para> | ||
478 | </listitem> | ||
479 | </orderedlist> | ||
480 | |||
481 | <para>A new entry will be added in the <emphasis role="bold">Views | ||
482 | Table</emphasis>.</para> | ||
483 | |||
484 | <figure> | ||
485 | <title>Create a tile server view</title> | ||
486 | |||
487 | <mediaobject> | ||
488 | <imageobject> | ||
489 | <imagedata align="center" contentwidth="600" | ||
490 | fileref="images/create_tileserver.png" /> | ||
491 | </imageobject> | ||
492 | </mediaobject> | ||
493 | </figure> | ||
494 | |||
495 | <para>In the main window, select the newly created tile server view in | ||
496 | the <emphasis role="bold">View</emphasis> drop-down menu. Upon a correct | ||
497 | configuration, the map will be loaded.</para> | ||
498 | </section> | ||
499 | |||
500 | <section id="tileserver_latlon"> | ||
501 | <title>Setting uCPE Device Location</title> | ||
502 | |||
503 | <para>To set the location of a managed uCPE device, perform the | ||
504 | following steps:</para> | ||
505 | |||
506 | <orderedlist> | ||
507 | <listitem> | ||
508 | <para>Access the <emphasis role="bold">Device</emphasis> menu and | ||
509 | select <emphasis role="bold">Manage</emphasis>. A new window will | ||
510 | open.</para> | ||
511 | </listitem> | ||
512 | |||
513 | <listitem> | ||
514 | <para>In the <emphasis role="bold">Manage Devices</emphasis> window, | ||
515 | navigate to the <emphasis role="bold">Devices</emphasis> tab. The | ||
516 | <emphasis role="bold">Managed Devices Table</emphasis> will be | ||
517 | shown.</para> | ||
518 | </listitem> | ||
519 | |||
520 | <listitem> | ||
521 | <para>Select de desired uCPE device. The device's properties will be | ||
522 | shown on the right side of the window.</para> | ||
523 | </listitem> | ||
524 | |||
525 | <listitem> | ||
526 | <para>Navigate to the <emphasis role="bold">Location</emphasis> tab. | ||
527 | Latitude and longitude can be set here.</para> | ||
528 | |||
529 | <note> | ||
530 | <para>Latitude and longitude should be in the decimal degrees (DD) | ||
531 | format.</para> | ||
532 | </note> | ||
533 | </listitem> | ||
534 | |||
535 | <listitem> | ||
536 | <para>Press the <emphasis role="bold">Apply</emphasis> button. The | ||
537 | <emphasis role="bold">Saved successfully</emphasis> message will be | ||
538 | shown.</para> | ||
539 | |||
540 | <para>The device will be automatically added on the map in the tile | ||
541 | server view. If the device is already added on the tile server map, | ||
542 | its location will be updated.</para> | ||
543 | </listitem> | ||
544 | </orderedlist> | ||
545 | </section> | ||
546 | |||
547 | <section id="tileserver_map"> | ||
548 | <title>Placing the uCPE Device on the Map</title> | ||
549 | |||
550 | <para>To place a uCPE device on the map in the tile server view, perform | ||
551 | the following steps:</para> | ||
552 | |||
553 | <orderedlist> | ||
554 | <listitem> | ||
555 | <para>Right-click on the map and choose the <emphasis | ||
556 | role="bold">Place device</emphasis> option. A new window will | ||
557 | open.</para> | ||
558 | </listitem> | ||
559 | |||
560 | <listitem> | ||
561 | <para>In the <emphasis role="bold">Add Device</emphasis> window, | ||
562 | select the desired device.</para> | ||
563 | </listitem> | ||
564 | |||
565 | <listitem> | ||
566 | <para>If the <emphasis role="bold">Override device | ||
567 | location</emphasis> checkbox is left unchecked, the device will be | ||
568 | placed at the coordinates previously set in the <emphasis | ||
569 | role="bold">Location</emphasis> tab.</para> | ||
570 | </listitem> | ||
571 | |||
572 | <listitem> | ||
573 | <para>If the <emphasis role="bold">Override device | ||
574 | location</emphasis> checkbox is checked, the coordinates set on the | ||
575 | device previously will be ignored, and the device will be placed at | ||
576 | the cursor's position.</para> | ||
577 | |||
578 | <note> | ||
579 | <para>Checking the <emphasis role="bold">Override device | ||
580 | location</emphasis> checkbox does not alter the coordinates | ||
581 | already set for the device.</para> | ||
582 | </note> | ||
583 | </listitem> | ||
584 | </orderedlist> | ||
585 | |||
586 | <para>A device already placed on the map can be dragged and dropped | ||
587 | inside the map. Coordinates will not be changed.</para> | ||
588 | |||
589 | <para>If two or more uCPE devices are too close together on the map, and | ||
590 | the current zoom level cannot accommodate all their icons, a cluster | ||
591 | will be shown. The cluster is represented by a large circle that | ||
592 | displays a number representing the number of devices it contains. The | ||
593 | color of the cluster changes according to the alarms of the devices in | ||
594 | the cluster.</para> | ||
595 | |||
596 | <para>Once clicked, the cluster will zoom in to a degree where all | ||
597 | elements can be distinguished. When hovering over the cluster, a window | ||
598 | with information about the cluster will be available. It will contain | ||
599 | the number of the devices in the cluster, as well as their status. The | ||
600 | Devices link will open a drop-down menu that contains all the | ||
601 | devices.</para> | ||
602 | </section> | ||
343 | </section> | 603 | </section> |
344 | </chapter> \ No newline at end of file | 604 | </chapter> \ No newline at end of file |
diff --git a/doc/book-enea-edge-getting-started/doc/troubleshooting.xml b/doc/book-enea-edge-getting-started/doc/troubleshooting.xml index 0e6322f..1693b5f 100644 --- a/doc/book-enea-edge-getting-started/doc/troubleshooting.xml +++ b/doc/book-enea-edge-getting-started/doc/troubleshooting.xml | |||
@@ -222,6 +222,15 @@ | |||
222 | </listitem> | 222 | </listitem> |
223 | </orderedlist></entry> | 223 | </orderedlist></entry> |
224 | </row> | 224 | </row> |
225 | |||
226 | <row> | ||
227 | <entry>Logging into the Enea Edge Management application over HTTP | ||
228 | fails, producing the error <literal>You have been automatically | ||
229 | logged out</literal>.</entry> | ||
230 | |||
231 | <entry>Clear the <literal>JSESSIONID</literal> browser's cookie | ||
232 | or close and restart the browser.</entry> | ||
233 | </row> | ||
225 | </tbody> | 234 | </tbody> |
226 | </tgroup> | 235 | </tgroup> |
227 | </table> | 236 | </table> |
diff --git a/doc/book-enea-edge-getting-started/doc/whitelabel.xml b/doc/book-enea-edge-getting-started/doc/whitelabel.xml new file mode 100644 index 0000000..7e98438 --- /dev/null +++ b/doc/book-enea-edge-getting-started/doc/whitelabel.xml | |||
@@ -0,0 +1,136 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | ||
2 | <chapter id="whitelabel"> | ||
3 | <title>White-labeling the Enea Edge Management Login</title> | ||
4 | |||
5 | <para>The Enea Edge Management login page and main page logos can be changed | ||
6 | to replace the Enea logo with a custom one. The login logo | ||
7 | URL, the title and the favicon may also be changed.</para> | ||
8 | |||
9 | <section id="white_conf_screen"> | ||
10 | <title>White-labeling Configuration Screen</title> | ||
11 | |||
12 | <para>In the <emphasis role="bold">System</emphasis> menu, click on the | ||
13 | <emphasis role="bold">Configuration</emphasis> sub-menu and on the | ||
14 | <emphasis role="bold">Properties</emphasis> tab click the <emphasis | ||
15 | role="bold">Whitelabel</emphasis> sub-tab. This will open a screen where | ||
16 | the following fields must be completed:</para> | ||
17 | |||
18 | <table id="white_conf_table"> | ||
19 | <title>White-label configuration screen</title> | ||
20 | |||
21 | <tgroup cols="2"> | ||
22 | <tbody> | ||
23 | <row> | ||
24 | <entry><emphasis role="bold">Company name</emphasis></entry> | ||
25 | |||
26 | <entry>The name of the company. The default value is "Enea AB". | ||
27 | The value must have max. 255 characters.</entry> | ||
28 | </row> | ||
29 | |||
30 | <row> | ||
31 | <entry><emphasis role="bold">Display title</emphasis></entry> | ||
32 | |||
33 | <entry>The product name. It is used in the login page and as | ||
34 | the title of the pages. The default value is "Enea Edge | ||
35 | Management". The value must have max. 255 characters.</entry> | ||
36 | </row> | ||
37 | |||
38 | <row> | ||
39 | <entry><emphasis role="bold">Login logo URL</emphasis></entry> | ||
40 | |||
41 | <entry>The official address of the company. It is used as a | ||
42 | hyperlink for the login logo. The default value is | ||
43 | "http://enea.com". This must be a valid and complete URL address, | ||
44 | starting with http / https.</entry> | ||
45 | </row> | ||
46 | |||
47 | <row> | ||
48 | <entry><emphasis role="bold">Login logo</emphasis></entry> | ||
49 | |||
50 | <entry>The logo image from the login page. The default value is | ||
51 | the image <filename>images/enea_logo.png</filename>. The logo | ||
52 | must be a PNG file with maximum 800 px width and 55 px | ||
53 | height.</entry> | ||
54 | </row> | ||
55 | |||
56 | <row> | ||
57 | <entry><emphasis role="bold">Display logo</emphasis></entry> | ||
58 | |||
59 | <entry>The logo image from the main screen. The default value is | ||
60 | the image <filename>images/enea_logo.png</filename>. The logo | ||
61 | must be a PNG file with maximum 800 px width and 55 px | ||
62 | height.</entry> | ||
63 | </row> | ||
64 | |||
65 | <row> | ||
66 | <entry><emphasis role="bold">Favicon</emphasis></entry> | ||
67 | |||
68 | <entry>The favicon icon. The default icon is | ||
69 | <filename>images/favicon/favicon.ico</filename>. The image must | ||
70 | be an ICO file with exactly 16 px width and 16 px height.</entry> | ||
71 | </row> | ||
72 | |||
73 | <row> | ||
74 | <entry><emphasis role="bold">Restart now</emphasis></entry> | ||
75 | |||
76 | <entry>If checked, when pressing the | ||
77 | <emphasis role="bold">Apply</emphasis> button, the | ||
78 | application will restart.</entry> | ||
79 | </row> | ||
80 | |||
81 | <row> | ||
82 | <entry><emphasis role="bold">Reset to defaults</emphasis></entry> | ||
83 | |||
84 | <entry>When pressed, all the values will be reset to the default | ||
85 | ones.</entry> | ||
86 | </row> | ||
87 | </tbody> | ||
88 | </tgroup> | ||
89 | </table> | ||
90 | |||
91 | <note> | ||
92 | <para>A restart is necessary in order to apply the changes in the | ||
93 | application. This can be done either by checking the <emphasis | ||
94 | role="bold">Restart now</emphasis> checkbox, before pressing the | ||
95 | <emphasis role="bold">Apply</emphasis> button, or alternatively, | ||
96 | by manually restarting the application.</para> | ||
97 | </note> | ||
98 | |||
99 | <para>The logo images and the favicon will be saved under a new folder: | ||
100 | <filename>images/whitelabel</filename>.</para> | ||
101 | |||
102 | <para>Only a user with administrative privileges will be able to modify | ||
103 | the Whitelabel values, the other users may only see the values.</para> | ||
104 | </section> | ||
105 | |||
106 | <section id="white_bck_restore"> | ||
107 | <title>Backup and restore when using White-labels</title> | ||
108 | |||
109 | <para>The backup from the application may be done by accessing the <emphasis | ||
110 | role="bold">System</emphasis> menu, then choosing <emphasis | ||
111 | role="bold">System Backup</emphasis>, selecting the <emphasis | ||
112 | role="bold">Backups</emphasis> tab, and clicking the <emphasis | ||
113 | role="bold">Backup Now</emphasis> button. For the <emphasis | ||
114 | role="bold">Backup Type</emphasis> select <literal>System | ||
115 | Backup</literal>. A backup will be created and it will appear in the | ||
116 | table of backups.</para> | ||
117 | |||
118 | <para>The restore operation is made from the same tab: <emphasis | ||
119 | role="bold">Backup</emphasis>. The backup file must be selected and | ||
120 | then the <emphasis role="bold">Restore</emphasis> button needs to be clicked. | ||
121 | In order to restore the Whitelabel settings, both the <emphasis | ||
122 | role="bold">EMS Configuration</emphasis> and the <emphasis | ||
123 | role="bold">Media Files (Images/Sounds)</emphasis> checkboxes must be | ||
124 | selected. The <emphasis role="bold">EMS | ||
125 | Configuration</emphasis> will restore the entries from the database and | ||
126 | the <emphasis role="bold">Media Files (Images/Sounds)</emphasis> will | ||
127 | restore the actual images.</para> | ||
128 | </section> | ||
129 | |||
130 | <section id="white_upgrade"> | ||
131 | <title>Upgrading when using White-labels</title> | ||
132 | |||
133 | <para>During an Enea Edge Management upgrade operation, the Whitelabel | ||
134 | settings will be preserved without any additional steps involved.</para> | ||
135 | </section> | ||
136 | </chapter> \ No newline at end of file | ||