Download offline documentation#
| Version | Release date | Documentation (zip) |
|---|---|---|
| 13.09.24 | lim_docs_ |
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 general LIM processes, architecture, system requirements, information about compatibility of LUNA Index Module and LUNA PLATFORM and release notes.
Documents are provided in PDF and HTML formats.
| File | Description |
|---|---|
| LIM_Release_Notes | Release notes. |
| LIM_Administrator_Manual | Administrator manual. |
| LIM_System_Requirements | System requirements. |
| LIM_LP_Compatibility* | Compatibility of LUNA Index Module and LUNA PLATFORM versions. |
* PDF format only
Installation manuals#
The following manuals describe how to deploy and upgrade in a variety of ways.
The manuals can be found in the "./docs/InstallationManuals" directory.
Documents are provided in PDF and HTML formats.
| File | Description |
|---|---|
| LIM_Installation_Manual | Manual installation. Describes preparing the environment and launching all Docker containers manually on a separate server. |
| LIM_Upgrade_Manual | Manual upgrade. Describes updating the environment and launching new Docker containers manually on a separate server. |
| LIM_Docker_Compose_Deployment_Example | Example deployment using Docker Compose. Describes installing on a bare-metal server from scratch using an example Docker Compose script in the distribution package. |
Reference manuals#
These manuals describe the OpenAPI 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 |
Developer manual#
The LIM developer manual for developers and DevOps is available for LIM. The manual can be found in the "./docs/ServiceManuals" directory.