Differences

This shows you the differences between two versions of the page.

--- devel:documentation:modules [2018/10/22 12:13]
sourek [Table]
+++ devel:documentation:modules [2019/03/01 11:38]
kotisovam [Admin guide (to be completed)] change of title
@@ Line 1: / Line 1: @@
+<- .:confidential_storage | Confidential storage agenda ^ .:start | Documentation ^ .:modules_reg | Modules: User registration ->
+====== Modules ======
+The Architecture of CzechIdM is highly [[.architecture:dev:modularity| modular]]. The core module serves as a basic module and is essential for the application run. All other modules are usually dependent on the Core module. The Acc module users Core module services and is also very important to the application, but the application can run with the module turned off. The module takes care of user accounts on connected systems. Usually the module is ON on almost all cases.
+Other important module for the application is IC module. It manages the communication with the connected systems. The module is ON in almost all cases.
+Except basic application modules, there are other complementary modules available. [[https://www.czechidm.com/blog/slide/modules/| Modules Pricing]]
+^ Basic application modules  ^ description                                                                                                       ^ documentation                   ^ license  ^ available  ^
+| core                       | Application core - basic services, entities and REST interface                                                    | [[.:start]]                     | MIT      | for free   |
+| acc                        | user account management                                                                                           |                                 | MIT      | for free   |
+| ic                         | Connectors for the communication with other systems. At the time mainly ConnId project connectors are supported.  | [[.systems:dev:ic-connectors]]  | MIT      | for free   |
+| example                    | Example module, servers for new developers as example                                                             |                                 | MIT      | for free   |
+| vs                         | Virtual systems - manage accounts on systems via tasks                                                            | [[.:modules_vs]]                | MIT      | for free   |
+| rpt                        | Reports module. Interfaces for creating new reporst                                                               | [[.:modules_rpt]]               | MIT      | for free   |
+| extras                     | Contains various features, which are not suited to be in any other module                                         | [[.:modules_extras]]            | MIT      | for free   |
+^ Complementary modules      ^ description                                                                                                       ^ documentation                   ^ license  ^ available  ^
+| reg                        | Users registration to CzechIdM via web GUI                                                                        | [[.:modules_reg]]               |          | paid       |
+| ca                         | Internal certificate authority with RESTful API (deprecated)                                                      | [[.:modules_ca|]]               |          | paid       |
+| openam                     | OpenAM user authentication, user data exchange                                                                    | [[.:modules_openam]]            |          | paid       |
+| pwd-reset                  | Password reset module. User can reset lost password via email link                                                | [[.:modules_pwd]]               |          | paid       |
+| reports                    | Reports module. Admins can prepare a report of users or roles and download it                                     | [[.:modules_reports]]           |          | paid       |
+| crt                        | Managing of certificates and certificate authorities                                                              | [[.:modules_crt|]]              |          | paid       |
+| sms                        | Sms gateway module with implementation of some gateways                                                           | [[.:modules_sms|]]              |          | paid       |
+In CzechIdM modules can be switched on and off in GUI.
+====== Read more ======
+===== Admin guide  =====
+  * [[.adm:modules|Modules overview]]
+===== Devel tutorials =====
+  * [[tutorial:dev:create_new_czechidm_module| How to create a new module]]
+  * [[tutorial:dev:override_filter| Custom module - overwrite filters]]
+  * [[tutorial:dev:module_development| Module development process]]