Installing Rayjas on Linux

Minimum Requirements

Permissions

Rayjas requires administrative permissions to be able to function to its full potential. For effective installation and execution, rayjas require administrative permissions however the python virtual environment should not be created with administrative permissions. The automated installer is designed to take all this into consideration when setting up things. We, therefore, recommend that you install/upgrade using the installer only.

Installing

Thanks to the automated installer, installing Rayjas on your Linux system is an easy task. Simply run the install script with/without the -i flag.

./install.sh -i

OR

./install.sh

Rayjas installer provides auto-detection of the operating system, installation of necessary dependencies, and essential modification of configurations on the fly. This ensures that the installation is tailor optimized for the specific system, to which rayjas is being deployed.

The latest version of rayjas requires python 3.7 – 3.10. make sure you have one of these versions on your system before proceeding. Most of the standard Linux operating systems come pre-installed with python, which can be an added benefit. Apart from this, the installer will try to install the required version of python (if not found on the system). If you already have the supported version of the python interpreter, the installation will be much faster.

The overall Installation function can broadly be distributed into the following parts:

• Checking & installing the required python version
• Installing the core
• Installing modules

While the installer will take care of everything for you, things can definitely be faster if you already have a supported python version on your system. Additionally, after installation is complete you can install addon modules to enhance functionality. The installer will assist you in installing modules as well.

For more information, check out the installer on Github and follow through with the detailed instructions provided in the ReadMe file. If something does not work well for you, consider creating issues in the GitHub repo itself with details of the issue.

Uninstalling

Removing an installed copy of rayjas from your system is even easier. Simply run the install script with the remove flag.

./install.sh -r

Uninstall will remove all rayjas files and folders as well as any other resources (modules, configs etc) that were created/added to run with rayjas. You can read more about the uninstall process in the github readme file.

Updating

Updating software can be a real pain, given the configuration changes you have made to it over time and the new feature additions being pushed in the update. Rayjas payload consists of runtime libraries that are optimized based on platform type and python version. Correctly substituting them in the right location during installation as well as the update can be quite challenging.

The rayjas installer packs its own smart update mechanism within it. While most of the complexity is handled by the bash script, some of the advanced configuration update magic is handled by the accompanying python script.

The update process will first update the core and then install the updated version of each module that was in use, thereby updating the entire software in an efficient manner.

NOTE: We recommend taking a complete backup of your existing rayjas installation before attempting to upgrade to prevent loss of data of any sort (if you have made important config changes).

Use the following instructions on the installer to initiate an upgrade request for your existing installation.

Rayjas Modules

Modules are the backbone of good software that allows it to extend its capabilities on demand instead of having to cram everything into the core itself. Rayjas supports various modules that carry out different types of tasks. All the supported modules are deployed to the cloud along with the software core. when you install rayjas you get only the basic minimal payload.

You can install modules on-demand using the installer itself. All you need to know is the name of the module. Additionally, to configure the module you will also need to read the documentation on the module.

Installing Modules

To install a module follow the instructions given here.

Removing Modules

To remove an installed module follow the instructions given here.

Updating Modules

Modules are shipped in parity with the core distribution. Therefore you cannot update modules as such. To get a newer version of a module you will need to update the core installation.

NOTE: You must always restart rayjas service for changes to take effect.