Installation

For proper installation you need to clone project from git.

Surroundings

The service can be installed on Windows 10 and AlmaLinux 9 (not tested on other system versions).

Required predefined dependencies:

  • Python of version 3.13 is required.

  • It is strongly recommended to create virtual surroundings for python dependencies installation.

Dependencies installation

After surroundings installation launch pip install with “-r requirements.txt” parameter.

pip install -r requirements.txt

Configuration

After dependencies installation configuration file should be set. File is placed in “./luna_api/configs/config.conf”.

Luna-Image-Store preparation

For Luna-Image-Store usage you should create bucket from config.conf. To do this, use storages tool provided by VisionLabs.

Monitoring

For sending monitoring you should prepare monitoring database for usage by luna-api. To do this, use storages tool provided by VisionLabs.

First launch and testing

If all previous actions are executed successfully, server is ready to work. To start server please launch run.py script. While start you can add arguments: server message port and path to config file if it is not in default location. By default 5000 port is used. Example:

./run.py --port=5001 --config=./configs/devconfig.conf

After server is started, testing is recommended. To perform testing execute command

python -m unittest tests.unittests_main

All tests should perform successfully.


Note

In case of running the application in a container, you also have the option to specify environment variables using command line arguments, as shown in the example below. Please be warned that Bash may not accept variable names containing a dot (‘.’) symbol, so quoting is required.

docker run -e "VL_SETTINGS.LUNA_CONFIGURATOR.LUNA_CONFIGURATOR_USER=your_username"
-e "VL_SETTINGS.LUNA_CONFIGURATOR.LUNA_CONFIGURATOR_PASS=your_password" luna-api