Installing Rulex Platform¶
Rulex Platform software is delivered in two different architectural versions: a standalone installation or a cloud/server deployment.
The standalone version is installed on computers or virtual machines and provides an easy entry point for all the people who want to play with their data and start immediately to get value from our software.
The cloud/server version, on the other hand, is the typical installation in enterprise environments where scaling and reducing computational hardware costs are of the utmost importance. Rulex Platform supports all most important cloud/server providers (Azure, Google, Red Hat Openshift, AWS…).
Prerequisites¶
Rulex Platform’s installation process is very easy and intuitive.
The software will quickly be up and running on your machine.
Note
Windows OS, Ubuntu and Darwin are currently supported.
To start using Rulex Platform standalone version and to install it on your machine, you need to satisfy the following prerequisites:
Rulex Platform Installer: the installer is the executable that will guide you through the installation phase, providing all the files required to run Rulex Platform. The installer file format will be
.exefor Windows,.debfor Ubuntu and.dmgfor Darwin.- Product Key: the Product Key is a code, which is provided along with the installer, identifying all the features of the purchased license. It is a combination of alphanumerical characters that contains:
The services purchased and the limitations you have on their use (e.g. the tasks included in your package);
The number of users that can use the services simultaneously;
The maximum number of sessions that can be run at the same time.
To receive the Product Key, you can contact your Rulex Point of Contact or you can fill in the form linked here to receive a 30-days free trial.
In order to use Rulex Platform in the best way possible, the machine you are using must comply with certain requirements (all the values listed below should be considered as recommended):
Requirement Area |
Details |
|---|---|
Runtime prerequisite |
Microsoft Windows 10 (64 bit) - 1909 or higher. |
CPU |
CPU with x86_64 architecture. 4 core minimum, 8 core recommended. |
RAM |
4 GB (minimum), 16 GB (recommended), 32 GB (best performance) - single user application. |
Hard Disk Space |
50 GB (minimum), 100 GB (recommended), 200 GB (best performance) - single user application. |
IOPS |
1000 minimum, 2000 recommended. |
Network |
|
Additional tools |
Microsoft C++ Redistributable, which can be downloaded from here. The link is also provided during the installation process in the standard installation. |
Warning
It is required to enable the Long paths (linked here) on the Windows machine where Rulex Platform will be installed.
Requirement Area |
Details |
|---|---|
Runtime |
Ubuntu 22.04 LTS (Jammy Jellyfish) |
CPU |
CPU with x86_64 architecture. 4 core minimum, 8 core recommended. |
RAM |
4 GB (minimum), 16 GB (recommended), 32 GB (best performance) - single user application. |
Hard Disk Space |
50 GB (minimum), 100 GB (recommended), 200 GB (best performance) - single user application. |
IOPS |
1000 minimum, 2000 recommended. |
Network |
|
Requirement Area |
Details |
|---|---|
Runtime |
macOS Sonoma |
CPU |
Mac Apple Silicon from M1 to latest M-series chip - ARM64 |
RAM |
8 GB (minimum) – 16 GB (recommended) - single user application |
Hard Disk Space |
256 GB (minimum) – 512 GB (recommended) - single user application |
IOPS |
1000 recommended, 2000 optimum. |
Network |
|
Rulex Platform Installer wizard installation¶
The standalone version of Rulex Platform is installed through a dedicated application, the Rulex Platform Installer. The installation is therefore performed in two stages:
the Rulex Platform Installer is installed on the machine, as explained in this section;
the Rulex Platform Installer is used to install Rulex Platform, as explained in the next section.
To install Rulex Platform Installer, follow the steps below:
Locate the folder where you saved the Rulex Platform Installer file on your personal computer.
Double-click the installer file to launch the installation.
Click Next in the welcome screen to get started.
Click I Agree in the Terms and Conditions window.
If you do not accept the terms and conditions, Rulex Platform Installer will not be installed.Insert your product key.
Wait until the Valid product key message appears, then click OK.
Select the required installation option:
Anyone who uses this computer (all users) - to allow all computer users to use Rulex Platform Installer.
This option is called a machine wide installation and is available only to the system administrator of the machine.
Only for me (username) - to allow only the current user (i.e. yourself) to use this installation of Rulex Platform Installer.
Click Next to install Rulex Platform Installer in the proposed default location, otherwise click Browse to navigate to a different folder.
Click Install.
Select the Run Rulex Platform Installer checkbox if you want Rulex Platform Installer to open automatically at the end of the installation process.
Click Finish to end the installation process.
The installation on Ubuntu must be performed as follows:
In the Ubuntu terminal, type the following command:
sudo dpkg -i your_installer_name.debDefine the installation option by typing either 0 or 1:
0 means the installation will be performed on the current user, so Rulex Platform Installer will be stored in the path
/home/username/opt/rulexinstaller.1 means the installation will be performed machine-wide, so all users within the machine will have Rulex Platform Installer installed, so it will be stored in the path
/opt/rulexinstaller.
Insert the Product Key in the required field.
Type the username. This username is going to become admin of the new installation of Rulex Platform Installer.
Specify the configuration file path. This field is not mandatory, so it can be left empty by pressing Enter on the keyboard.
If any dependency is missing, type
sudo apt --fix-broken installto install any missing dependency.To run Rulex Platform Installer, type
./rulexinstallerif you are already in the folder where it is stored, while type/path/to/rulexinstallerif it is stored in a folder different from the one you are working on
Ubuntu uninstallation
In order to uninstall Rulex Platform Installer on Ubuntu follow the steps explained below.
Open Ubuntu.
Write the command
sudo apt purge rulexinstallerand press Enter key. You will be asked if you want to continue with the operation. At this point typeYas yes and press Enter key.Finally, type your username if the application was installed on your account only, press Enter key and wait until the uninstallation has been completed.
Note
If you want to know more about the difference between Purge and Remove refer to the Ubuntu technical documentation.
Note
Uninstalling Rulex Platform Installer does not remove the installations of Rulex Platform created through it, which must be deleted from the Installer itself (see Installing Rulex Platform with the Installer).
Note
If Rulex Platform was installed silently (i.e. without the Installer), it can be uninstalled with the command sudo apt purge rulexplatform, following the same steps described above.
The installation on Darwin follows the steps below:
Download the installer.
Double-click on the downloaded installer file.
Drag the Rulex Platform Installer icon onto the Applications folder icon following the arrow’s direction in the window that automatically appears.
Eject the application from the desktop or from the Locations list located in the left panel of the Finder.
In the Finder, double-click the application to launch it. Therefore, a progress bar will show you the status.
At this point a message will inform you that the application has been downloaded from the internet and that Apple verified that it is safe. Click Open to ultimate the application launch.
Click CLOSE when the Operation Forbidden message appears.
Insert the requested product key in the corresponding box.
Wait few seconds for Rulex Platform Installer main page to load. If an error message appears, simply refresh the page by clicking on the View option and select Reload or by pressing Command + R.
Warning
If you want to uninstall the application, you must delete it by moving it into the trash bin. However, by deleting the application, the product key is not automatically removed.
In order to delete the product key as well, you must open the Library and delete the entire RulexInstaller folder.
Installing Rulex Platform through the Installer¶
Once Rulex Platform Installer has been installed, it is used to create, modify, inspect, launch and delete the installations of Rulex Platform on the machine. The procedure does not depend on the operating system, apart from the differences explicitly mentioned.
Installing Rulex Platform through the Installer is a guided process divided into five steps:
Home: list of installations and actions on them;
New installation: installation parameters (type, name, scope, product key and directory);
Select components: choice of the Platform and components versions;
Installing: uninstallation, download and installation;
Installation summary: final summary.
The complete description of each step, including how to modify, inspect, launch and delete an existing installation and how to recover from errors, is provided in the dedicated page Installing Rulex Platform with the Installer. The same operations can also be performed from the command line, as explained in the Rulex Platform silent installation section.
Rulex Platform Installer silent installation¶
In some occurrences you need to install Rulex Platform Installer silently through an automatic script, for example to distribute it to many machines.
Rulex Platform Installer is an electron-builder application, therefore it is installed silently using the standard mechanism of each package format: NSIS on Windows, DMG on macOS and deb on Ubuntu. This procedure installs only the Installer: Rulex Platform is then installed through the Installer itself, as described in the Rulex Platform silent installation section.
The Installer is delivered as an NSIS setup executable. To install it silently, run it from PowerShell with the following command:
Start-Process -FilePath ".\your_installer_name.exe" -ArgumentList "/S" -Wait -PassThru
Where the arguments perform the following:
/S launches the installer in silent mode;
/allusers installs the Installer for all users (machine wide installation). It requires an elevated PowerShell session (Run as administrator);
/currentuser installs the Installer only for the current user;
/D=C:\path\to\folder sets the installation folder. It must be the last argument and must not be enclosed in quotes, even if the path contains spaces.
For example, the following command performs a machine-wide installation in a custom folder:
Start-Process -FilePath ".\your_installer_name.exe" -ArgumentList "/S", "/allusers", "/D=C:\Rulex\Installer" -Wait -PassThru
The -Wait option makes PowerShell wait for the end of the installation, while -PassThru returns the process, whose ExitCode property is 0 if the operation is successful and a different value if it fails.
To uninstall the Installer silently, run the Uninstall <application name>.exe file located in its installation folder with the /S argument (add /allusers for a machine-wide installation).
The Installer is delivered as a .deb package. To install it silently, type:
sudo DEBIAN_FRONTEND=noninteractive apt-get install -y ./your_installer_name.deb
Compared to dpkg -i, this command also installs any missing dependency automatically. The command returns 0 if the operation is successful and a different value if it fails.
To uninstall the Installer silently, type:
sudo apt-get purge -y rulexinstaller
The Installer is delivered as a .dmg disk image, which does not provide a silent installation switch: the installation consists in copying the application into the Applications folder, and it can be scripted by mounting the image, copying the application and unmounting the image:
hdiutil attach your_installer_name.dmg -nobrowse -quiet -mountpoint /Volumes/RulexInstaller
sudo cp -R "/Volumes/RulexInstaller/<application name>.app" /Applications/
hdiutil detach /Volumes/RulexInstaller -quiet
Each command returns 0 if the operation is successful and a different value if it fails.
To uninstall the Installer silently, delete the application with sudo rm -rf "/Applications/<application name>.app". As for the manual procedure, the product key is not removed automatically.
Rulex Platform silent installation¶
Once Rulex Platform Installer has been installed, Rulex Platform can be installed silently by invoking the command line interface (CLI) of the Installer from an automatic script. The CLI does not depend on the operating system and allows to install, update and uninstall Rulex Platform, to check for available updates and to list the installations and the available modules.
For example, the following command installs silently the latest version of the Platform for the current user on Windows:
./RulexInstaller.exe install --module platform --productKey xxxxx-xxxxx-xxxxx-xxxxx-xxxxx --silent
The complete reference of the commands, of the options and of the exit codes is provided in the Rulex Platform Installer CLI section of the page Installing Rulex Platform with the Installer.
- Rulex Platform Cloud
- Rulex Platform Server
- Installing Rulex Platform with the Installer
- Standalone or Server configuration file