Installing and Starting RapidMiner Server

 

The following sections describe all the steps required to get RapidMiner Server installed and running. If you are familiar with these procedures, you can use the Quick Start as a reference for the installation process instead of these more detailed instructions.

  • Prepare for the installation
  • Create a database server, if necessary
  • Download RapidMiner Server
  • Install and configure
  • Start the server and complete web-based configuration
  • Connect to RapidMiner Studio

Prerequisites

The following are required to successfully install RapidMiner Server:

If it is not already present, need install Java 8. The installer displays an error message if it finds Java 7 (or a version earlier than 7), but does not block the installation.
The RapidMiner Server database (schema) stores configuration files, cron job details, user report requests, and other RapidMiner support data. You can use an existing database server or create a new one; it can reside locally or on a remote host. Refer to these instructions for an example of creating a database schema for use by the RapidMiner service, using one of the many supported database platforms.
During installation you will need to supply database access credentials for a user with read, write, and create and delete tables permissions. You can refer to this example of setting permissions using MySQL.例子
You need a fully functioning RapidMiner Studio client to use RapidMiner Server for any meaningful operations.

Once the prerequisites are met, you can begin the installation.

Installation Instructions

Use the following steps to 1) download 2) configure, and 3) install RapidMiner Server. Once the installation process is complete, the settings are saved to a configuration file. You can later modify the file (for example, change hostname or ports) and easily install the RapidMiner Server service on a different machine.

Downloading RapidMiner Server

Follow these steps to download the full RapidMiner Server package:

1. Log into RapidMiner from the RapidMiner web page and click the Download link in the upper right corner.

2. From the Downloads page, register or sign in. Then, select the appropriate type of installation for your environment:

  • Select Full Server Package for the complete RapidMiner Server installation— a JBoss application server and the RapidMiner Server application software EAR file. This is the correct choice for new installations and rare cases that require you to replace the applications server.
  • Select EAR file if you already have a JBoss application server running and simply want to add the RapidMiner deployment package to your JBoss server installation. This is the faster (and recommended) installation path if you only need to upgrade the application software.

3. Unlike RapidMiner Studio, you do not need to pick an operating system platform for the Server edition. Click Download to download the zip file rapidminer-server-installer-x.x.x.zip, which contains the RapidMiner Server package.

4. Extract the contents of the download file to an installation directory.

Installing the full server package

The following steps describe Full Server Package installation. The installation script requires Java 8; if it is not available (not on the path or JAVA_HOME is not set), the installer will not run correctly. If it does not run, check your Java installation.

Note for Windows Users: It is helpful to run the installation as Admin. This allows the installer to register the service. Additionally, a standard user is not allowed to write to all folders on the system (for example, C:\Program Files). If you do not want to register RapidMiner Server as a service and plan to install to a folder you have write access to, admin privileges are not required.

1. Change to the bin directory (within the installation directory) to locate the start script (or batch file) for the installation.

  • For Windows, use the file rapidminer-server-installer.bat
  • For Linux, Unix, or Mac OS, use the file rapidminer-server-installer

2. As Admin, run the appropriate installer script.The RapidMiner Server Installer window opens. This is not the RapidMiner service; it is a tool to help you preconfigure the service.

download_rmserver

3. In the RapidMiner Server Installer window, read the Before You Start text and click Next when you are ready.

4.In the next window, select your installation type. You can install either locally or you can create a configuration file used for a headless installation. If you select a headless installation, browse to a file location for storing the resulting XML file. Click Next. 

5. Scroll to the bottom of the EULA screen, check the box to accept, and click Next.                 

6. Enter or browse to the location where RapidMiner Server should be installed. Click Next. The RapidMiner Server Installer License window opens.                 

7. From your account portal Licenses page, copy the license key to your clipboard. (See this additional information if you need help copying your key.)

8. Paste the key into the License window. The license registration information updates based on the details of the entered license. Click Next.                 

rmserver_license

Steps to copy a license key:

  • To copy a license number to your clipboard::


 1. Log in to your account and come to the license number page.

rmserver_license

When the page opens, make sure the Server tab is selected. Your license information, including license type and expiration, displays:
rmserver_license

2. Click View License Key next to the appropriate license to display the key.
rmserver_license

3.Click in the box containing the key to select it, then copy it to your clipboard.

The Server Settings window opens.                       


Configuring RapidMiner Server Settings

  • On this screen, you set the connection settings for RapidMiner Server.

    rmserver_server

    In the RapidMiner Server Settings window, enter the server settings:                       

    Enter the hostname or IP address for the local machine hosting the RapidMiner Server service.
    Check this box to prevent the server from binding to all available local interfaces. You may want to check this, for example, if the server has more than one IP address and you want to limit the RapidMiner service to run on only one.
    Enter the port used over which clients, typically RapidMiner Studio, will connect. The default port is 8080.
    Enter the memory allowed, as defined by your license. If you enter a value larger than your license allows, you will receive an error on startup.
    Select this option to register RapidMiner Server to run as Windows service. You must have Admin privileges for this setting to take effect. (Under UNIX you can autostart RapidMiner Server but the method is dependent on your UNIX distribution.)
    Enter an identifier for the version of RapidMiner Server; this is the ID by which Windows refers to the service. The default value is composed of the RapidMiner Server release and version number.
    Enter the name to display in the services list.
     Verify that the path to the Java 8 directory, which was automatically completed based on the setting of JAVA_HOME, is correct. If it is not filled in or is not correct, browse to the directory containing your Java 8 installation. Be certain that if you have multiple Java versions, you select the folder that contains Java 8.
    Click Next to open the Database Configuration window.


Configuring RapidMiner Server’s Database Connection

  • On this screen you configure and test RapidMiner Server’s database connection.

    Note: If your database system is not one of the available choices (MySQL, MSSQL, Oracle, PostgreSQL), see the RapidMiner Support knowledgebase article for information on modifying your configuration file.                       

    rmserver_db_config

    Enter your database settings:

    Enter the hostname or IP address for the local machine hosting the RapidMiner Server installation. For the local machine, enter localhost or 127.0.0.1.
    Enter the port number used to access the RapidMiner Server database.
    Enter the name of your existing database or the name of the database you created. 
    Enter the name of the user with login privileges to the RapidMiner Server database. 
    Enter the password for the user with login privileges to the RapidMiner Server database.
    From the drop-down list, select the database system to be used for the RapidMiner Server database. 
    Specify the appropriate JDBC connector, a JAR file that contains the driver class information for the system to connect to a database from Java. If you want to use a driver different from those included, set the path for the new driver package file in this field.

    Click Test Connection to verify connectivity. If you receive a message that your database connection was successful, click Next to configure email settings. If you receive an error, double-check your username and password entries.                     


Configuring Email Settings

  • Optionally, you can complete the fields of the E-Mail Server window to register an email account. RapidMiner Server uses this address to send email notifications based on triggers, process results, and password resets.

    If you do not plan to use this functionality, leave the fields blank and clickl  Install to begin the installation.                                                                  

    Note: Be certain to either complete all fields or leave all fields blank; partial email configuration prevents RapidMiner Server from starting.                                                                 

    rmserver_email_server

    If you do plan to configure an email server:  1. Enter your email server settings:

    Mail server name. The name of the proxy that sent the message (such as smtp.gmail.com or smtp.mail.yahoo.com).                                                                                           
    The port number to connect to the SMTP server. No encryption protocol default port number is 25, the cryptographic protocol defaults to port 465 (SSL) or 587 (TSL). 
    Mail address, as the sender of the message (From) address.
    Enter the user name (for example, admin) to connect to the mail server.
    Enter the password used to authenticate the named user.                                                                                                                      

    Complete the fields and click Check Check Icon Install to begin the installation.                                                                

    Note: If you do not have the correct administrative privileges, you receive a message telling you that the service was not registered to Windows services. If you receive the following message, however, the RapidMiner Server installation was successful:

    rmserver_email_server


Starting RapidMiner Server

  • After reading the information on the Success screen, click OK to complete the installation. Start RapidMiner Server in one of the following ways:

    • Start the RapidMiner Server manually: In the bin directory of your RapidMiner Server installation directory (for example, C:\RapidMinerServer\bin), find and execute the standalone.sh (Unix) or standalone.bat (Windows) file.
    • Start the RapidMiner Server service from the command line (Windows only):Enter net start at the command line to start the service .
    • Start the RapidMiner Server service through the Windows tool (Windows only):Browse to the Services directory on your machine (or search Services from the Start menu) and locate the RapidMiner Server service. Right-click the service name and select to either start the service immediately or, through the Properties option, to automatically start the service at system start-up.

    When you start RapidMiner Server using the standalone script, the command window displays progress as the program populates the database with all its required tables. If this is the first start-up, the process may take several minutes.

    Note: You can ignore the final message that the administration console service was not able to start.                       

    When you start via the Windows service, you do not see the progress, just the final Started message in your Services window.

    Once you have started the server, either via the services option or the standalone script, log in to the web interface. Open a web browser pointed at the http://: (for example, http://localhost:8080). The login credentials for first time use are: http:// : The login credentials for first time use are:

    • User: admin
    • Password: changeit

    Important: Please be certain to change your password immediately.                       


Completing the Installation

  • Once logged in, complete the final installation steps.

    1. From the SQL Dialect pull-down, verify that the database type displayed is the one you used to create the RapidMiner Server database.

    2. Verify the setting for the integrated Quartz scheduler, which is enabled by default.

    3. Specify the path to the plugin directory. You can install additional RapidMiner extensions by placing them in, or saving them to, this directory. Note that all extensions bundled with RapidMiner Studio are also bundled with RapidMiner Server (no installation is necessary). These bundled extensions are stored in a separate directory that is independent of the path specified here. Be sure that you have write permission to the directory.

    4. Specify the path to the uploads directory. This is the directory where RapidMiner Server stores temporary files needed for processes. The installation process creates a local uploads directory in the installation folder. However, if you install RapidMiner Server on a relatively small hard disk and, for example, use many file objects in processes or if you have large resulting files, consider creating a directory elsewhere in the cluster to store the temporary files. Be sure that you have write permission to the directory.

    5. Click Start installation now. When the installation completes, the RapidMiner Server Home page appears:
    rmserver_installer_settings


Changing the administrator password

  • Your first action, once installation is complete, is to change the administrator password. It is important to change the password at this point because connecting to RapidMiner Studio requires that you enter RapidMiner Server login credentials. Changing your credentials later means that you will have to correct this connection as well. To change the password:

      1. Expand the Administration menu on the left side of the window.
      2. Select Preferences. The Preferences settings for user admin display.
    rmserver_installer_settings

    Complete the fields as follows:

    • Display name:On installation, the field defaults to admin. Leave it, or change it to any name you want displayed for the administrator. The display name appears in parentheses in the window title.
    • Email address: Enter the email address associated with the admin account.                         
    • Password: Enter a new password for the administrator account. The password must be at least 8 alphanumeric characters.
    • Repeat password: Re-enter the new password to confirm. 

    3. Click Submit. The new display name appears, as well as a confirmation of password change.
    change-password

    Congratulations, your RapidMiner Server installation is complete. Next up, connecting to RapidMiner Studio.


Connecting RapidMiner Server to RapidMiner Studio

  • Once you have finished installing RapidMiner Server, you associate it as a repository for RapidMiner Studio. In RapidMiner Studio you will design and test processes; in RapidMiner Server you can deploy the process on a larger scale.

    To create the association, first open RapidMiner Studio:

    1. In RapidMiner Studio, from the Repositories tab, click the Add Repository: 
    rmstudio-new-repo

    2.From the New Repository window, select New RapidMiner Server Repository. Click Next.
    rmstudio-server-repo

    3. From the resulting window, specify the parameters for the repository connection. 
    rmstudio-server-creds

    Complete the fields as follows:

    • Alias: Enter the name to display in the Repository list in RapidMiner Studio.                         
    • Repository URL: Enter the database host and port you set when you configured database connections.
    • User: Enter a valid username for a user with access to RapidMiner Server. On installation, user admin is accepted.                         
    • Password: Enter the password associated with the user. On installation, password changeit is accepted.                         

    4. Click Test Connection to verify the credentials and test the connection to RapidMiner Server.

    5.Click  Finish to add RapidMiner Server as a repository.
    rmstudio-server-connected

    That’s it! Get predictions at lightning speed, integrate your in-house data sources, and collaborate with coworkers and contributors throughout your organization and beyond. Welcome to RapidMiner Server. Have fun!