You are viewing the RapidMiner Hub documentation for version 9.10 - Check here for latest version

RapidMiner Server home directory

The RapidMiner Server home directory is created automatically by the RapidMiner Server installer – see the installation guide to install and start using RapidMiner Server.

This document outlines the purpose of the various files and subdirectories within the RapidMiner Server home directory.

What is the RapidMiner Server home directory?

The RapidMiner Server home directory is where your RapidMiner Server configuration and data is stored. In particular it stores the contents of the RapidMiner Server repository, including all user data that was uploaded from RapidMiner Studio and generated via RapidMiner processes.

What does the RapidMiner Server home directory contain?

To get access to the home directory, read Editing files within containers: the home directory.

Your RapidMiner Server home directory contains the following directories and files:

Path	Description
`.RapidMiner/`	Execution context directory used by RapidMiner Core.
`data/`	Data directory which contains persistent data like the repository content and caches.
`data/repository/`	Contains the repository content.
`configuration/`	Contains application configuration.
`configuration/standalone.xml`	Allows configuring various aspects of how RapidMiner Server behaves, such as its database connection, exposed ports, etc.
`job-agent-home/`	Home folder of the bundled Job Agent.
`resources/jdbc/`	Contains externally installed JDBC drivers.
`resources/extensions/`	Contains extensions used by RapidMiner Server. See how to install extensions for more information.
`resources/licenses/`	Contains the RapidMiner Server license(s).
`resources/libs/`	Contains custom Java libraries which are used in a RapidMiner process.
`resources/modules/`	Contains external JBoss modules, by default RapidMiner Server's JDBC driver is placed within this directory.
`log/`	Contains log files for RapidMiner Server.

Handling disk space

By default, all user generated contents like processes, models or data sets will be put inside the RapidMiner AI Hub home directory. As those contents can grow in size depending on your users' use of Projects and the Remote Repository, we advise to always have enough space left on the disk which is hosting the RapidMiner AI Hub home directory.

In addition to regularly checking disk space availability as admin, AI Hub provides two safety mechanisms to reject uploading any items which would exceed available disk space when using Projects. By default, at least five gigabytes are required to be available for the underlying Git and LFS storage. Although the default values should provide an adequate safety, checks can be disabled or configured further inside the execution.properties file. Adjust to your liking if needed.

repositories.gitEnableDiskspaceCheckHook = true
repositories.gitDiskspaceCheckThreshold = 5120M
repositories.lfsEnableDiskspaceCheck = true
repositories.minLfsDiskspaceCheckThreshold = 5120M

Setting the RapidMiner Server home directory

Note that the RapidMiner Server home directory is created automatically by the RapidMiner Server installer.

The home directory location is defined by the RAPIDMINER_SERVER_HOME environment variable.

Securing the RapidMiner Server home directory

The repository data, the standalone.xml, and other configuration files all contain information that may be considered secret (server settings, repository content, database passwords, etc).

For production use, we strongly recommend that you secure this directory against unauthorized access.

We recommend the following precautions:

Assign a separate restricted user account on the machine for running RapidMiner Server (not a root/administrator user)

If you wish to run RapidMiner Server on port 80, use a reverse proxy server like Apache HTTP Server or nginx (do not run as root/Administrator if security of the home directory is important to you)
Ensure that only the user running RapidMiner Server can access the RapidMiner Server home directory, and that this user has read, write and execute permissions, by setting file system permissions appropriately for your operating system.
Do not use the embedded Job Agent. Instead configure external Job Agents and use a different user account that is not allowed to access the RapidMiner Server home directory.
Ensure that your file system is encrypted (e.g. via eCryptfs, dm-crypt, EFS or FileVault)

Technical notes

One RapidMiner Server home directory per RapidMiner Server instance!

You can only have one RapidMiner Server home directory per RapidMiner Server installation. If you have multiple RapidMiner Server installations, you will need to set up a RapidMiner Server home directory for each installation.
Where possible, you should choose a location for your RapidMiner Server home directory that will never need to be moved. Some home contents are location-sensitive, so moving the home directory may corrupt them.
The RapidMiner Server home directory contains the RapidMiner Server repository content. As this content can be uploaded by the user the file system needs to support the UTF-8 charset encoding. Example configuration for Linux via /etc/environment:
```
  export LANG=en_US.UTF-8
  export LANGUAGE=en_US:en
  export LC_ALL=en_US.UTF-8
```
As noted above, data/repository/ contains the repository content being managed by RapidMiner Server. We strongly recommend that customers never modify it, nor interact with it directly.

Categories

Versions