Distribution documentation#
This section covers the documentation package for LIM. All the documents can be found in "/docs" folder of the distribution package.
Operation manuals#
These manuals cover system deployment and architecture.
Most of the documents are provided in PDF and HTML formats. The PDF document is easier for navigation, the HTML document is more convenient to copy the commands. If there is no Internet connection, the HTML version requires template_VL.css.
| File | Description |
|---|---|
| LIM_Administrator_Manual.pdf | Administrator manual for LUNA Index Module |
| LIM_Installation_Manual.* | General concepts for the full installation of LIM using Docker containers. The example for installation on a single server is given in the manual |
| LIM_Docker_Compose_Example.* | General concepts for the full installation of LIM using Docker Compose. The example for installation on a single server is given in the manual |
* PDF and HTML formats
Reference manuals#
These manuals describe the Open API specifications for LIM services. OpenAPI specification is the only valid document providing up-to-date information about the service API. The specification can be used:
- By documentation generation tools to visualize the API.
- By code generation tools.
All the documents and code generated using this specification can include inaccuracies and should be carefully checked.
The manuals can be found in the "./docs/ReferenceManuals" directory. This directory includes documents in the YML and HTML format. Documents in YML format contain requests to all LIM services. You can use them to automatically generate requests in Postman. It is not guaranteed that all requests will be imported correctly, manual editing may be required. Documents in HTML format are used to visualize these specification and may not be complete.
| File | Description |
|---|---|
| IndexedMatcherReferenceManual.* | Indexed Matcher service API description |
| IndexerReferenceManual.* | Indexer service API description |
| IndexManagerReferenceManual.* | Index Manager service API description |
* YML and HTML formats
Developer Manual#
The LIM developer manual for developers and DevOps is available for LIM. The manual can be found in the "./docs/ServiceManuals" directory.