summaryrefslogtreecommitdiffstats
path: root/doc/book-enea-edge-getting-started/doc/whitelabel.xml
blob: 7e984382c2d152ddce6bea337c5f9ca609419d3d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
<?xml version="1.0" encoding="ISO-8859-1"?>
<chapter id="whitelabel">
  <title>White-labeling the Enea Edge Management Login</title>

  <para>The Enea Edge Management login page and main page logos can be changed
  to replace the Enea logo with a custom one. The login logo
  URL, the title and the favicon may also be changed.</para>

  <section id="white_conf_screen">
    <title>White-labeling Configuration Screen</title>

    <para>In the <emphasis role="bold">System</emphasis> menu, click on the
    <emphasis role="bold">Configuration</emphasis> sub-menu and on the
    <emphasis role="bold">Properties</emphasis> tab click the <emphasis
    role="bold">Whitelabel</emphasis> sub-tab. This will open a screen where
      the following fields must be completed:</para>

    <table id="white_conf_table">
      <title>White-label configuration screen</title>

      <tgroup cols="2">
        <tbody>
          <row>
            <entry><emphasis role="bold">Company name</emphasis></entry>

            <entry>The name of the company. The default value is "Enea AB".
            The value must have max. 255 characters.</entry>
          </row>

          <row>
            <entry><emphasis role="bold">Display title</emphasis></entry>

            <entry>The product name. It is used in the login page and as
            the title of the pages. The default value is "Enea Edge
            Management". The value must have max. 255 characters.</entry>
          </row>

          <row>
            <entry><emphasis role="bold">Login logo URL</emphasis></entry>

            <entry>The official address of the company. It is used as a
            hyperlink for the login logo. The default value is
            "http://enea.com". This must be a valid and complete URL address,
            starting with http / https.</entry>
          </row>

          <row>
            <entry><emphasis role="bold">Login logo</emphasis></entry>

            <entry>The logo image from the login page. The default value is
            the image <filename>images/enea_logo.png</filename>. The logo
            must be a PNG file with maximum 800 px width and 55 px
            height.</entry>
          </row>

          <row>
            <entry><emphasis role="bold">Display logo</emphasis></entry>

            <entry>The logo image from the main screen. The default value is
            the image <filename>images/enea_logo.png</filename>. The logo
            must be a PNG file with maximum 800 px width and 55 px
            height.</entry>
          </row>

          <row>
            <entry><emphasis role="bold">Favicon</emphasis></entry>

            <entry>The favicon icon. The default icon is
            <filename>images/favicon/favicon.ico</filename>. The image must
            be an ICO file with exactly 16 px width and 16 px height.</entry>
          </row>

          <row>
            <entry><emphasis role="bold">Restart now</emphasis></entry>

            <entry>If checked, when pressing the 
              <emphasis role="bold">Apply</emphasis> button, the
            application will restart.</entry>
          </row>

          <row>
            <entry><emphasis role="bold">Reset to defaults</emphasis></entry>

            <entry>When pressed, all the values will be reset to the default
            ones.</entry>
          </row>
        </tbody>
      </tgroup>
    </table>

    <note>
      <para>A restart is necessary in order to apply the changes in the
      application. This can be done either by checking the <emphasis
      role="bold">Restart now</emphasis> checkbox, before pressing the
      <emphasis role="bold">Apply</emphasis> button, or alternatively, 
        by manually restarting the application.</para>
    </note>

    <para>The logo images and the favicon will be saved under a new folder:
      <filename>images/whitelabel</filename>.</para>

    <para>Only a user with administrative privileges will be able to modify
    the Whitelabel values, the other users may only see the values.</para>
  </section>

  <section id="white_bck_restore">
    <title>Backup and restore when using White-labels</title>

    <para>The backup from the application may be done by accessing the <emphasis
    role="bold">System</emphasis> menu, then choosing <emphasis
    role="bold">System Backup</emphasis>, selecting the <emphasis
    role="bold">Backups</emphasis> tab, and clicking the <emphasis
    role="bold">Backup Now</emphasis> button. For the <emphasis
    role="bold">Backup Type</emphasis> select <literal>System
    Backup</literal>. A backup will be created and it will appear in the
    table of backups.</para>

    <para>The restore operation is made from the same tab: <emphasis
    role="bold">Backup</emphasis>. The backup file must be selected and
    then the <emphasis role="bold">Restore</emphasis> button needs to be clicked. 
      In order to restore the Whitelabel settings, both the <emphasis
    role="bold">EMS Configuration</emphasis> and the <emphasis
    role="bold">Media Files (Images/Sounds)</emphasis> checkboxes must be
    selected. The <emphasis role="bold">EMS
    Configuration</emphasis> will restore the entries from the database and
    the <emphasis role="bold">Media Files (Images/Sounds)</emphasis> will
    restore the actual images.</para>
  </section>

  <section id="white_upgrade">
    <title>Upgrading when using White-labels</title>

    <para>During an Enea Edge Management upgrade operation, the Whitelabel
    settings will be preserved without any additional steps involved.</para>
  </section>
</chapter>