Installation

For proper installation you need to clone project from git.

Surroundings

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

Required predefined dependencies:

  • Python 3.12 is required.

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

  • Python setuptools module can be installed via pip (pip install setuptools).

Dependencies installation

After surroundings installation launch setup.py with install parameter.

python setup.py install

If surrounding is installed correctly, this script will install all dependencies and carry out versioning automatically.

If all dependencies are already installed and only versioning is required, launch versioneer.py script with version parameter from root folder. Please note that for versioning git files are required.

If you need to install dependencies without versioning, you should use dependencies file placed in luna_streams_retranslator.egg-info

pip install -r requires.txt

Configuration

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

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, path to config, suffix for log files (for different workers). By default 5250 port is used. Also it possible to run service with config from luna-configurator (see configurator).

Example:

./run.py --port 5250 --config ./configs/myconfig.conf --log_suffix 1

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

python -m unittest tests.unittests_main

All tests should perform successfully.