-
Notifications
You must be signed in to change notification settings - Fork 0
/
modules.html
73 lines (59 loc) · 3.78 KB
/
modules.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
---
layout: default
head_title: "LESK: Modules"
title: Modules
---
<div class="row">
<div class="12u">
<p>Small features can be grouped into modules and managed, enabled and upgraded, without impacting the entire site.</p>
<p>A number of modules have already been created, here is the current list:</p>
<div class="table-wrapper">
<table>
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="https://github.com/leskhq/LESK-Module_ActiveDirectoryInspector">Active Directory Inspector</a></td>
<td>A simple Active Directory browser.</td>
</tr>
<tr>
<td><a href="https://github.com/leskhq/LESK-Module_LegacyClientSupport">Legacy Client Support</a></td>
<td>Provide a way to block or warn users to upgrade, based on the Web Browser used.</td>
</tr>
<tr>
<td><a href="https://github.com/leskhq/LESK-Module_ReportsUsers">Reports Users</a></td>
<td>Provides some reports on users and their permissions for admin purpose.</td>
</tr>
<tr>
<td><a href="https://github.com/leskhq/LESK-Module_Reservation">Reservation</a></td>
<td>Allows the management of reservable items.</td>
</tr>
<tr>
<td><a href="https://github.com/leskhq/LESK-Module_SQLUtils">SQL Utils</a></td>
<td>A set of utility functions and classes to help interact with SQL Servers.</td>
</tr>
</tbody>
</table>
</div>
<h4>Module conventions</h4>
<p>In order to avoid conflicts some naming conventions are recommended below:</p>
<p><strong>Module name:</strong> The module name should be composed of the prefix "LESK-Module" followed by the module namespace as
defined in the <code>composer.json</code> of the module. Both parts should be separated by an underscore "_". For
example, "LESK-Module_ActiveDirectoryInspector" in the case of the "Active Directory Inspector" module.</p>
<p><strong>Module tables:</strong> Keeping in mind the limitations of the underlying RDBMS systems, in particular, Oracle DB limits
database objects names to 30 bytes. Module table names should be composed of the prefix "mod", followed by a unique
and short identifier for the module for example "adinsp" and finally the name of the table. All parts should
be separated by an underscore "_". The total length should remain under 30 characters. For example, the
full table name for the module could be "mod_adinsp_users" or "mod_adinsp_groups"</p>
<p><strong>Module settings:</strong> Module settings should be composed of the lower case slug of the module, followed by the setting
variable itself. All parts should be separated by a period ".". For example two settings for the "Active Directory
Inspector" module are "active_directory_inspector.account_suffix" and "active_directory_inspector.port".</p>
<p>Additional documentation can be found on the <a href="https://github.com/leskhq/lesk-modules">lesk-modules</a> and look at a
concrete example such as the <a href="https://github.com/leskhq/LESK-Module_ActiveDirectoryInspector">Active Directory Inspector</a> module for more details.</p>
</div>
</div>
{% include footer.html prev_page="rapyd" prev_title="Rapyd" next_page="lern" next_title="LERN" %}