Installation Guide for All Platforms (PDF)

Installation Guide for All Platforms — Chapter 2

Procedures

Procedures

This section describes the following procedures to install MarkLogic on your system.

Upgrading from Previous Releases

If you have previously installed MarkLogic on a machine, you must uninstall the old release before proceeding with the new installation. For information on removing the software, see Removing MarkLogic Server or the Installation Guide from the previous release. This section describes the following information and upgrade paths:

If you are upgrading a cluster to a new release, see Upgrading a Cluster to a New Maintenance Release of MarkLogic Server in the Scalability, Availability, and Failover Guide. The security database and the schemas database must be on the same host, and that host should be the first host you upgrade when upgrading a cluster.

Note That Reindexing is On By Default

Before upgrading to MarkLogic 7 from MarkLogic 5 or 4.2, be aware that database reindexing is enabled by default.

If you are upgrading from MarkLogic 6, a reindex is not required, so you can skip this section.

If you have a very large database, or if you have many databases configured, they will start reindexing after you install MarkLogic 7, as soon as you accept the license key. Reindexing is a CPU and disk-intensive process, and it can take some time. Consequently, it can slow down the machine, particularly if the machine has a slow disk system (for example, a development laptop).

If you want to delay reindexing, set reindex enable to false in your database configurations before you install MarkLogic 7 (that is, you must set reindex enable to false in MarkLogic 5, or 4.2). MarkLogic 7 will then run in 5.0 or 4.2 compatibility mode until reindexing is enabled and completes. To re-enable indexing, set reindex enable to true in each of your database configurations after completing the installation (that is, after accepting the license key and after performing the configuration and security database upgrades). After reindexing has been enabled, it will commence immediately and continue until it is done, or until reindexing is disabled. For details about database compatibility, see Upgrades and Database Compatibility.

Upgrading from Release 7.0-1 or Later

To upgrade from release 7.0-1 or later to the current MarkLogic 7 release (for example, if you are installing a maintenance release of MarkLogic 7), perform the following basic steps:

  1. Shut down MarkLogic 7 (as described in step 1 of Removing MarkLogic Server).
  2. Uninstall the old MarkLogic 7 release (as described in Removing MarkLogic Server).
  3. Install the new MarkLogic 7 release (as described in Installing MarkLogic Server).

If you are upgrading a cluster to a new release, see Upgrading a Cluster to a New Maintenance Release of MarkLogic Server in the Scalability, Availability, and Failover Guide. The security database and the schemas database must be on the same host, and that host should be the first host you upgrade when upgrading a cluster.

If you are upgrading two clusters that make use of database replication to replicate the security database on the master cluster, then you must enter the following to manually upgrade the security database configuration files on the machine that hosts the replica security database:

http://host:8001/security-upgrade-go.xqy?force=true

There is no direct upgrade path from Early Access releases of MarkLogic 7 to this release. If you need to move any data from an Early Access release to this release, you must re-create the data in the current release.

Upgrading from Release 6.0, 5.0,or 4.2

MarkLogic 7 installs in the same default directory as MarkLogic 6, MarkLogic 5, and 4.2, so there is no need to move any old files around. The upgrade to MarkLogic 7 does incorporate an automatic update to the Security database and to the configuration files. The Security database upgrade occurs when you first access the Admin Interface after the MarkLogic 7 installation.

Uninstalling a previous release of MarkLogic does not remove or delete the user data files (the forests and configuration information). When upgrading to MarkLogic 7, you must first uninstall previous releases of MarkLogic Server.

If you are upgrading a cluster of two or more servers, you must first upgrade the server in which the Security database is mounted. The Security database must be available before subsequent hosts can join the cluster.

The basic steps to upgrade from MarkLogic 6, MarkLogic 5, or 4.2 to MarkLogic 7 are as follows:

  1. As a precaution, perform database backups on your MarkLogic Server 6.0, 5.0, or 4.2 databases.
  2. If you do not want to reindex a database, disable reindexing for that database before installing MarkLogic Server 6.0, 5.0, or 4.2 (set reindexer enable to false on the Database Configuration page of the Admin Interface). The entire database will be reindexed after upgrading to MarkLogic 7 unless you disable reindexing. For details, see Upgrades and Database Compatibility. You can always reindex the database later by setting reindexer enable database configuration option to true.
  3. Shut down MarkLogic Server 6.0, 5.0, or 4.2 (as described in step 1 of Removing MarkLogic Server).
  4. Uninstall MarkLogic Server 6.0, 5.0, or 4.2 (as described in Removing MarkLogic Server).
  5. Install MarkLogic 7 (as described in Installing MarkLogic Server).
  6. Start MarkLogic 7 (as described in Starting MarkLogic Server).
  7. Open the Admin Interface in a browser (http://localhost:8001/).
  8. When the Admin Interface prompts you to upgrade the Security database and the configuration files, click the button to confirm the upgrade.
  9. If you have CPF installed in any database and you want to use any of the new pipelines in MarkLogic 7, then you must reinstall CPF for those databases. To reinstall CPF for a database, in the Admin Interface navigate to Databases -> database-name -> Content Processing, click the Install tab, and click the Reinstall button. This loads all of the new pipelines into the triggers database configured for that database.

There are some known application incompatibilities between MarkLogic 7 and MarkLogic 6, as well as some incompatibilities between 5.0 and 4.2. Some of the incompatibilities might require minor code changes to your applications. For details on these incompatibilities, see the Release Notes.

Upgrading from Release 4.1 or earlier

MarkLogic 7 only supports upgrading from Release 4.2 or later; it does not provide a direct upgrade path for previous releases of MarkLogic Server. If you are upgrading from a 4.1 or earlier release of MarkLogic Server, either install this release as a clean installation or upgrade your existing release to the latest Release 4.2, 5.0. or 6.0 before installing this release. For details on upgrading a Release 4.1 or earlier release, see the Installation Guide for MarkLogic Server 4.1. If you are upgrading from 4.1 and do not want to reindex your content, set the reindexer enable to false before upgrading. You can run MarkLogic 7 in either 3.2, 4.0, 4.1, 4.2, or 5.0 compatibility mode, as described in Upgrades and Database Compatibility.

Installing MarkLogic Server

This section describes the procedure for installing MarkLogic Server on each platform. Perform the procedure corresponding to the platform to which you are installing.

If you are upgrading a cluster to a new release, see Upgrading a Cluster to a New Maintenance Release of MarkLogic Server in the Scalability, Availability, and Failover Guide. The security database and the schemas database must be on the same host, and that host should be the first host you upgrade when upgrading a cluster.

PlatformPerform the following:
Windows x64
  1. Shut down and uninstall the previous release of MarkLogic Server (if you are upgrading from 6.0, 5.0, or 4.2, see Upgrading from Release 6.0, 5.0,or 4.2, if you are upgrading from 7.0-1 or later, see Removing MarkLogic Server).
  2. Download the MarkLogic Server installation package to your desktop. The latest installation packages are available from http://developer.marklogic.com.
  3. Double click the MarkLogic-7.0-1-amd64.msi icon to start the installer.

    If you are installing a release other than 7.0-1, double-click on the appropriately named installer icon.

  4. The Welcome page displays. Click Next.
  5. Select Typical.
  6. Click Install.
  7. Click Finish.
Red Hat Linux x64
  1. Shut down and uninstall the previous release of MarkLogic Server (if you are upgrading from 6.0, 5.0, or 4.2, see Upgrading from Release 6.0, 5.0,or 4.2, if you are upgrading from 7.0-1 or later, see Removing MarkLogic Server).
  2. Download the package to /tmp or another location using your web browser. The latest installation packages are available from the http://developer.marklogic.com.

    If you are using Firefox or another browser that is configured to associate rpm files, the browser will prompt you for the root password (if you are not already running as root) and you can follow the prompts to complete the installation. When the installation is complete, you can skip the next step. Otherwise, continue to the next step.

  3. As the root user, install the package with the following command:
    rpm -i /tmp/MarkLogic-7.0-1.x86_64.rpm

    If you are installing a release other than 7.0-1, replace the characters 7.0-1 in the line above with the appropriate release number.

  4. If you are using HDFS, make sure the server is configured to use HDFS with a Hadoop HDFS client and any needed environment variables set in the /etc/sysconfig/MarkLogic file. For details, see HDFS Storage in the Query Performance and Tuning Guide.
Sun Solaris x64
  1. Shut down and uninstall the previous release of MarkLogic Server (see Removing MarkLogic Server).
  2. Download the package to /var/spool/pkg using your web browser. The latest installation packages are available from http://developer.marklogic.com.
  3. Unpack the compressed tar file in /var/spool/pkg with the following shell commands:
    % cd /var/spool/pkg
    % uncompress MARKlogic-7.0-1-amd64.tar.Z
    % tar xf MARKlogic-7.0-1-amd64.tar
    % rm MARKlogic-7.0-1-amd64.tar

    If you are installing a release other than 7.0-1, replace the characters 7.0-1 in the line above with the appropriate release number.

  4. As the root user, install the package with the following command:
    # pkgadd MARKlogic
Mac OS X
  1. Download the MarkLogic Server installation package to your desktop. The latest installation packages are available from the http://developer.marklogic.com.
  2. Double click the MarkLogic-7.0-1-x86_64.dmg icon to open the folder that contains the MarkLogic-7.0-1-x86_64.pkg installer. Double click on the installer to start.
  3. The Welcome page displays. Click Continue.
  4. In the Select a Destination window, select a destination to install MarkLogic Server or Continue to select the default destination.
  5. In the Installation Type window, click Install. An Installation window appears that displays the progress of the installation.
  6. When the installation Summary window appears, click Close.
  7. A MarkLogic control window appears from which you can start/stop MarkLogic Server, open the Admin Interface, and view the Error Log.

The following table shows the installation directory (<marklogic-dir>) and the default data directory for each platform:

PlatformInstallation DirectoryDefault Data Directory (for configuration and log files)
Windowsc:\Program Files\MarkLogic\c:\Program Files\MarkLogic\Data
Red Hat Linux/opt/MarkLogic/var/opt/MarkLogic
Sun Solaris/opt/MARKlogic/var/opt/MARKlogic
Mac OS X~/Library/MarkLogic~/Library/Application Support/MarkLogic/Data

The default forest directory is the same as the default data directory if the optional data directory is not specified during forest creation. On UNIX platforms, if you want MarkLogic Server to use another location for its default data directory, make your data directory (/var/opt/MarkLogic on Linux and /var/opt/MARKlogic on Solaris) a soft link to the alternate location.

If you have an entity enrichment license, you must first install the entity enrichment packages before you can use the feature. For the installation procedure for entity enrichment, see Installing the Entity Enrichment Libraries in the Search Developer's Guide.

Starting MarkLogic Server

MarkLogic Server will automatically start when the computer reboots. To start MarkLogic Server without rebooting, perform the following command for the platform on which you are running:

PlatformPerform the following:
Windows

Select Start > Programs > MarkLogic Server > Start MarkLogic Server.

When you start MarkLogic Server from the Start menu, the Windows service configuration for MarkLogic Server is set to start automatically. Also, if you are using Windows Vista or Windows 7, to start the service you must right-click the Start MarkLogic Server link in the Start menu and choose Run as Administrator, then choose to allow the action.

Red Hat Linux

As the root user, enter the following command:

/etc/init.d/MarkLogic start
Sun Solaris

As the root user, enter the following command:

/etc/init.d/MarkLogic start
Mac OS XSelect System Preferences > MarkLogic to open the MarkLogic control window. Click Start MarkLogic Server.

This starts all of the App Servers that are configured on your MarkLogic Server.

Configuring the First and Subsequent Hosts

The following configuration procedures different depending on if you run MarkLogic Server in a cluster configuration or on a single host. The procedures are as follows:

If you are configuring MarkLogic Server as a standalone host, or if this is the first host in a cluster configuration, follow the installation instructions in Section 2.4.1. Otherwise, follow the installation instructions in Section 2.4.2.

If you are upgrading a cluster to a new release, see Upgrading a Cluster to a New Maintenance Release of MarkLogic Server in the Scalability, Availability, and Failover Guide. The security database and the schemas database must be on the same host, and that host should be the first host you upgrade when upgrading a cluster.

Configuring a Single Host or the First Host in a Cluster

To configure this installation as a single host, or as the first host in a cluster, perform the following steps:

  1. Install MarkLogic and start MarkLogic as described in Installing MarkLogic Server and Starting MarkLogic Server.
  2. Log into the Admin Interface in a browser. It is on port 8001 of the host in which MarkLogic is running (for example, on the localhost, http://localhost:8001). The Server Install page appears.

  3. Click OK to continue.
  4. Wait for the server to restart.
  5. After the server restarts, you will be prompted to join a cluster.

  6. Click Skip.
  7. You will be prompted to create an admin user. Enter the login name and password for the admin user.

  8. Click OK.
  9. You will be prompted to log in with your admin username and password.

You will now see the Admin Interface. If you do not need to add any hosts at this time, skip to Section 2.6.

Configuring an Additional Host in a Cluster

All hosts in a cluster have to be on the same platform. To configure this installation as an additional host in a cluster of the same platform, perform the following steps:

  1. On the node you want to add to an existing cluster, install MarkLogic and startMarkLogic, as described in Installing MarkLogic Server and Starting MarkLogic Server.
  2. Log into the Admin Interface in a browser. It is on port 8001 of the host in which MarkLogic is running (for example, on the localhost, http://localhost:8001). The Server Install page appears.

  3. Click OK to continue.
  4. Wait for the server to restart.
  5. After the server restarts, you will be prompted to join a cluster.

  6. Enter the DNS name or the IP address of one of the machines in the cluster. For instance, if this is the second host you are installing, you can enter the DNS name of the first host you installed.
  7. Click OK.
  8. You will be prompted for an admin username and password. You can use the admin username and password you created when installing the first host. Click OK.
  9. Select a Group to assign this host. Click OK.

  10. Click OK to confirm that you are joining the cluster.

  11. You have now joined the cluster.

  12. Click OK to transfer the cluster configuration information.

You have completed the process to join a cluster and will now see the Admin Interface.

Leaving a Cluster and Becoming a Single Host

If your host is currently in a cluster of multiple hosts, and you would like to leave the cluster and switch to a single host environment, follow the steps in this section.

A host cannot leave a cluster if there are still forests assigned to it or if it has any foreign clusters associated with it; you must delete all forests assigned to the host and de-couple any clusters associated with a host before you can leave the cluster. However, you can delete the configuration only for a forest and the forest data will remain on the filesystem, allowing you to add the forest back to the host after changing the configuration. For instructions on adding a forest to a host, see the Administrator's Guide.

Perform the following steps to leave the cluster to which a host is connected.

  1. Run the Admin Interface from the host you want to remove from the cluster.
  2. Click the Hosts icon in the left menu tree. The Host Summary page appears.
  3. Click the name of the host you want to remove from the cluster, either from the left menu tree or from the Host Summary page. The Host Configuration page appears:

    The Leave button only appears if the Admin Interface is running from this host.

  4. Click the Leave button
  5. Click OK to confirm leaving the cluster.
  6. The host restarts to load the new configuration.
  7. Follow the instructions in sections 'Configuring a Single Host or the First Host in a Cluster' or 'Configuring an Additional Host in a Cluster' as appropriate.

Entering a License Key

MarkLogic will run without a license key, but you should enter a valid key for what you are licensed for after installing MarkLogic. At any time, you can change the license key for a host from the Host Status page. You might need to change the license key if your license key expires, if you need to use some features that are not covered in your existing license key, if you upgrade your hardware with more CPUs and/or more cores, if you need a license that covers a larger database, if you require different languages, or for various other reasons. Changing the license key sometimes results in an automatic restart of MarkLogic (for example, if your new license enables a new language).

To change the license key for a host, perform the following steps using the Admin Interface:

  1. Click the Hosts icon on the left tree menu.
  2. Click the name of the host in which contains you want to change the license key, either on the tree menu or the summary page. The Host Configuration page appears.
  3. Click the Status tab. The Host Status page appears.
  4. Click the License Key button. The License Key Entry page appears.
  5. Enter your new license key information. For information about licensing of MarkLogic Server, contact your MarkLogic sales representative.
  6. After entering valid information in the Licensee and License Key fields, click OK. If it needs to, MarkLogic will automatically restart, and the new license key will take effect.

Checking for the Correct Software Version

After logging in with your admin username and password, the Admin Interface appears. In the left corner of the Admin Interface, the version number and product edition are displayed.

To view more details about the release of MarkLogic Server that is installed and licensed, complete the following steps:

  1. Click the Hosts icon on the left tree menu.
  2. Select the name of the host you just installed, either from the left menu tree or from the Host Summary page.
  3. Click the Status tab. The Host Status page appears.
  4. Check that <version> is correct.

To begin using MarkLogic Server, see the following document:

Otherwise, you are finished with the Admin Interface for now. You have successfully installed MarkLogic on your system.

Configuring MarkLogic Server on UNIX Systems to Run as a Non-daemon User

On UNIX-based systems (Linux and Solaris), MarkLogic runs as the UNIX user named daemon. This section describes how to change a configuration to run as a different named UNIX user. This procedure must be run by the root user. Additionally, the root user is still required for installing and uninstalling MarkLogic and for starting and stopping MarkLogic from the startup scripts.

To modify an installation to run as a user other than daemon, perform the following steps:

  1. In a command window on the machine in which you installed MarkLogic, log in as the root user.
  2. Make sure MarkLogic is stopped. If it is still running, stop it as follows:
    PlatformPerform the following to stop MarkLogic:
    Red Hat Linux

    As the root user, enter the following command:

    /etc/init.d/MarkLogic stop
    Sun Solaris

    As the root user, enter the following command:

    /etc/init.d/MarkLogic stop
  3. Edit the configuration file for your platform using a text editor such as vi.
    PlatformConfiguration File to Edit
    Red Hat Linux
    /etc/sysconfig/MarkLogic
    Sun Solaris
    /etc/MarkLogic.conf
  4. In the file, edit the MARKLOGIC_USER environment variable to point to the user in which you want MarkLogic Server to run. For example, if you want it to run as a user named raymond, change the following line:
    MARKLOGIC_USER=daemon

    to the following:

    MARKLOGIC_USER=raymond
  5. Save the changes to the /etc/sysconfig/MarkLogic or /etc/MarkLogic.conf file.
  6. If you have not yet started MarkLogic after performing a clean installation (that is, after installing into a directory where MarkLogic has never been installed), then you are done and you can skip the rest of the steps in this procedure. If have an existing installation (for example, if you are upgrading to a maintenance release), then continue with the following steps.
  7. For all of the MarkLogic files owned by daemon, you need to change the owner to the new user. This includes all forest data and all of the configuration files. By default, the forest data is in the following directories:
    PlatformDefault Data Directory (for configuration and log files, and default forest directory)
    Red Hat Linux/var/opt/MarkLogic
    Sun Solaris/var/opt/MARKlogic

    For example, on a Linux system, perform a command similar to the following, which changes the owner to the user specified earlier in the /etc/sysconfig/MarkLogic file:

    chown -R raymond /var/opt/MarkLogic
  8. Make sure to change the owner for all forests in the system, otherwise forests will fail to mount upon startup. Note that the above command only changes the owner for forests installed in the default directory. You need to run a similar command on the data directory for each forest in which a data directory is specified.
  9. When you have completed all the file and directory ownership changes, start MarkLogic as described in Starting MarkLogic Server.

Once you have performed this procedure, all new files created by MarkLogic are created with the new user ownership; there will be no need to change any ownership again.

The configuration changes you made to the startup scripts need to be merged in during any upgrade of MarkLogic (because the installation installs a new version of the startup scripts). Under Linux, the unistallation process saves an old version of the scripts (for example, /etc/sysconfig/MarkLogic.rpmsave), so you can use that version to merge in your changes. If you perform a clean installation (not an upgrade installation), however, you will need to run this entire procedure again.

Removing MarkLogic Server

To remove MarkLogic from your system, complete the following steps:

  1. Stop MarkLogic by performing the following action based on the platform in which you are running:
    PlatformPerform the following:
    Windows

    Select Start > Programs > MarkLogic Server > Stop MarkLogic Server.

    If you are using Windows Vista or Windows 7, to stop the service you must right-click the Stop MarkLogic Server link in the Start menu and choose Run as Administrator, then choose to allow the action.

    Red Hat Linux

    As the root user, enter the following command:

    /etc/init.d/MarkLogic stop
    Sun Solaris

    As the root user, enter the following command:

    /etc/init.d/MarkLogic stop
    Mac OS XSelect System Preferences > MarkLogic to open the MarkLogic control window. Click Stop MarkLogic Server.
  2. Once the server is stopped, you can uninstall MarkLogic package by performing the following action based on the platform in which you are running:
    PlatformPerform the following:
    WindowsUse the Add/Remove Programs Control Panel to uninstall MarkLogic.
    Red Hat Linux

    As the root user, enter the following command:

    rpm -e MarkLogic
    Sun Solaris

    As the root user, enter the following command:

    pkgrm MARKlogic
    Mac OS X

    No action is necessary when upgrading.

    If you want to remove the user data and do a fresh install, then remove the following directory:

    ~/Library/Application Support/MarkLogic/Data

    To entirely remove MarkLogic, remove the following directories:

    ~/Library/MarkLogic
    ~/Library/Application Support/MarkLogic
    ~/Library/StartupItems/MarkLogic
    ~/Library/PreferencePanes/MarkLogic.prefPane

    To make Mac OS X completely forget it ever had a MarkLogic installation, run the following command from a terminal window:

    sudo pkgutil --forget com.marklogic.server

    Using this procedure to remove MarkLogic from your system will not remove user data (configuration information, XQuery files used by HTTP or XDBC servers, or forest content). This data is left in place to simplify the software upgrade process. If you wish to remove the user data, you must do so manually using standard operating system commands.