-
Notifications
You must be signed in to change notification settings - Fork 30
/
help.html
251 lines (193 loc) · 9.82 KB
/
help.html
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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
<div data-layout="row sm-column">
<div data-self="size-xxsmall">
<nav id="help-menu">
<ul data-layout="rows">
<li><a href="#help-overview" class="button">Overview</a>
<li><a href="#help-modules" class="button">Module</a>
<li><a href="#help-theme" class="button">Theme</a>
<!-- <li><a href="#help-themefinder" class="button">Theme Finder</a>-->
<li><a href="#help-preload" class="button">Preload</a>
<li><a href="#help-preferences" class="button">Preferences</a>
<li><a href="#help-development" class="button">Development</a>
</ul>
</nav>
</div>
<article id="help-module">
<section id="help-overview">
<h3>Overview</h3>
<p>X-Update module is an update manager, also known as software update service (SUS), to quickly update your web application and extend with add-ons.
With the introduction of this multi-purpose module, you can perform the following tasks :
upgrade the core system, update and install modules, themes and single components (preloads).
<p>The update manager also provides support for language catalogs (localization) and installation of multiple instances of D3 modules—duplicatable and free to rename client side directory.
In addition, you can manage your FTP/SSH credentials in the module preferences.
This module can download all critical updates and security patches to your server as soon as they become available.
The deployment is as fast as possible by downloading archives from a central repository, such as GitHub and GitLab.
<p>X-Update automatically monitors the central repository, single source of truth for upgrades and updates of installed add-ons.
<p>Available updates are highlighted in admin top notification, and front-end if you install the X-Update's block.
<div class="confirm">If your SSL certificate is not valid, check <b>cURL: Disable SSL verification</b> in module's preferences.</div>
</section>
<section id="help-modules">
<h3>Module</h3>
<p>Modules can add new functionality to your Web Application Platform or enhance and extend existing functionality.
<p>There are different types of modules (utility, service, etc.) usually classified as follows :
<table class="outer">
<thead>
<tr>
<th>Category</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><b>Core</b> </td>
<td>Modules <b style="color:var(--color-red);">required</b> by the Bundle Package</td>
</tr>
<tr>
<td><b>Trust module</b> </td>
<td>D3 modules running multiple instances</td>
</tr>
<tr>
<td><b>X2 Modules</b> </td>
<td>Single instance</td>
</tr>
</tbody>
</table>
<h3>Core modules</h3>
<p>The default settings ensures that required core modules are running and redirects
to the built-in installation wizard if any required module is missing in your application.
<h3>Trust modules</h3>
<p>D3 nodules are installed in the Trust_PATH directory. These modules are duplicable, or duplicatable which means you can install
multiple client-side instances, each with its own directory name, database tables, language, and custom templates.
<h3>X2 Modules</h3>
<p>These modules are installed in the public side and run a single instance.
The core modules, <b>legacy System and Renderer</b>, are designed to ensure backward compatibility
and easier upgrades from previous versions. Thus providing forward compatibility with the extensible
built-in features such as delegate and preload (hooks, extensions).
<div class="error">NOTE ! The Legacy system can not guarantee backwards compatibility
with deprecated code of module versions that are no longer supported by developers.
Beware of your Web Application Platform version — <b><{$smarty.const.XOOPS_VERSION}></b></div>
<h4 class="help-rel"><i class="i-help"></i> Related content</h4>
<ul>
<li><a href="<{$help}>=legacy">Module Management ⭢</a>
<li><a href="#!">Guide to multi-tenant and multiple instances</a>
</ul>
</section>
<section id="help-theme">
<h3>Theme</h3>
<p>This section provides a brief introduction to download and install Themes
to customize the global appearance of your website.
<p>The core Render is framework-agnostic, which means Themes can be built with
different CSS and JavaScript frameworks.
<ol>
<li>Select a Theme and follow the wizard steps
<li>Browse to » Theme Management
<li>Select your Default Theme
</ol>
<p>Theme Management allows you to "Select" the default theme and to select multiple themes available to users.
<h3>Allow Users to select Theme</h3>
<p>Any theme that is "checked" in Theme Management will be available to users in the block "Themes".
<p>If you install the block "Themes" and grant users permission, they can then select their favorite theme and customize the look and feel of the website.
<h4 class="help-rel"><i class="i-help"></i> Related content</h4>
<ul>
<li><a href="<{$help}>=legacyRender">Getting started with themes ⭢</a>
</ul>
</section>
<section id="help-themefinder">
<h3>ThemeFinder</h3>
<p>Service to select and preview Themes.
<div class="error">Note : The service is not up-to-date and might be removed soon due the lack of developers interest.</div>
</section>
<section id="help-preload">
<h3>Preload</h3>
<p>This section provides a brief introduction to Preloads and walks through the installation of a simple extension.
<p><b>Preloads</b> are commonly <b>Single File Components</b> that extend the Web Application Platform with customized functionality:
<ul>
<li>Productivity workflow
<li>Web page content enrichment
<li>Information aggregation
<li>Custom UI components
</ul>
<p>In a nutshell, Preloads are simple extensions, or plugins, to add new functionality,
enhance the current usability or customize a design without hacking the core system.
<h3>Enable and disable a Preload</h3>
<p>Unlike modules, Preloads do not have a control panel.
<p>A Preload is installed in the public directory <span class="badge">/preloads/</span>
<p>To disable a preload, the best practice is to use X-elFinder<br>
The file manager can be used to delete or move the preload file to a directory <span class="badge">/preloads/disabled/</span>
<h4 class="help-rel"><i class="i-help"></i> Related content</h4>
<ul>
<li><a href="<{$help}>=legacy">Delegate mechanism and Preload ⭢</a>
</ul>
</section>
<section id="help-preferences">
<h3>Preferences</h3>
<p>X-Update manager provides several options to get and deploy add-ons :
<ul>
<li>FTP, Login password for FTP or passphrase of private key for SSH2 Key-Auth
<li>Private key for SSH connection
<li>Write permissions of files and folders
<li>Update only used Language
<li>Disabled items from Store list
<li>Select a Tag module
<li>Preload files edited with X-elFinder
<li>View the debug output
<li>Add-on Store URL
<li>HTTP maximum connections
</ul>
<div class="confirm">Disable SSL verification :
Turn off cURL's verification to bypass SSL certificate validation for local and test servers.
</div>
<h4 class="help-rel"><i class="i-help"></i> Related content</h4>
<ul>
<li><a href="#!">Guide to create and manage your own Update Store</a>
</ul>
</section>
<section id="help-development">
<h3>Development</h3>
<table class="outer">
<tbody>
<tr>
<td>Bundle Package</td>
<td>XCL 2.3.3</td>
</tr>
<tr>
<td>Module name</td>
<td>Xupdate</td>
</tr>
<tr>
<td>Type</td>
<td>Trust module (software update service)</td>
</tr>
<tr>
<td>Level</td>
<td>Required</td>
</tr>
<tr>
<td>Author</td>
<td>Update by Nuno Luciano aka gigamaster, 2020 XCL23, Nobuhiro Yasutomi aka nbuy</td>
</tr>
<tr>
<td>Author</td>
<td>Domifara, Hamaco, Kilica Hikawa, Naoki Okino aka naao, Naoki Sawada aka nao-pon</td>
</tr>
<tr>
<td>Author</td>
<td>Naoki Sawada aka nao-pon, Lead developer</td>
</tr>
<tr>
<td>Copyright </td>
<td>(c) 2012-2023 The XOOPSCube Project, Authors</td>
</tr>
<tr>
<td>license</td>
<td>GPL 2.0</td>
</tr>
<tr>
<td>🌐 Repository URL</td>
<td><a href="https://github.com/xoopscube/xupdate" target="_blank">https://github.com/xoopscube/xupdate ⭧</a></td>
</tr>
</tbody>
</table>
</section>
</article>
</div>