Loading TOC...
Installation Guide for All Platforms (PDF)

MarkLogic Server 11.0 Product Documentation
Installation Guide for All Platforms — Chapter 2

« Previous chapter
Next chapter »

 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 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.

MarkLogic Server does not support downgrades. Once you have upgraded to a later release, you cannot downgrade to your original release. To retain the option to restore to a previous version of MarkLogic Server, make a complete backup of your content and security databases before upgrading.

Windows Service Parameters

When upgrading MarkLogic on Windows as a different user from the user that installed the previous version, the MarkLogic service parameters in the Windows registry will be changed. When the old version of MarkLogic is uninstalled, the service is deleted from the registry, including any customizations to the service parameters. When the new version of MarkLogic is installed, the service is re-created in the registry, with the default service parameters.

Before starting the upgraded version of MarkLogic, make any customization to the service parameters. Otherwise the default service parameters will be set and MarkLogic will start up running as the local system user. Any MarkLogic configuration files saved as the local system user (such as those modified when making changes in the Admin Interface) will be created with the Windows file permissions for the local system user.

When you make changes the user in the service parameters, you should also change data directory file permissions because, if MarkLogic is running for any amount of time as the local system user, it is likely that is has written files as the local system user.

Upgrading from Release 9.0-1 or Later

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

  1. Stop MarkLogic Server (as described in step 1 of Removing MarkLogic).
  2. Uninstall the old MarkLogic 9 release (as described in Removing MarkLogic).

    If you want to uninstall MarkLogic 9.0-4 or later, and if the converters package was previously installed with it, you will have to perform a two-step uninstall: first uninstall MarkLogic Converters and then uninstall MarkLogic Server. For more detail, see MarkLogic Converters Installation Changes Starting at Release 9.0-4 and Removing MarkLogic.

  3. Install the new MarkLogic 11 release (as described in Installing MarkLogic).

    If you want to install MarkLogic 9.0-4 or later, and you plan to use the converters package with it, you will have to perform a two-step installation: first install MarkLogic Server and then install MarkLogic Converters. For more detail, see MarkLogic Converters Installation Changes Starting at Release 9.0-4 and Installing MarkLogic.

  4. Start MarkLogic Server (as described in Starting MarkLogic Server).
  5. Open the Admin Interface in a browser (http://localhost:8001/).
  6. When the Admin Interface prompts you to upgrade the databases and the configuration files, click the button to confirm the upgrade.

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 11 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 MarkLogic 7 or MarkLogic 8

MarkLogic 11 installs in the same default directory as earlier versions of MarkLogic, so there is no need to move any old files around. The upgrade to MarkLogic 11 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 11 installation.

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

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 an earlier version to MarkLogic 11 are as follows:

  1. As a precaution, perform database backups on your earlier versions of MarkLogic Server databases.
  2. If you are upgrading from MarkLogic 7 and do not want to reindex a database, disable reindexing for that database before installing the new release (for example, set reindexer enable to false on the Database Configuration page of the Admin Interface in MarkLogic 7). The entire database will be reindexed after upgrading to MarkLogic 11 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. Stop MarkLogic Server (as described in step 1 of Removing MarkLogic).
  4. Uninstall the old MarkLogic release (as described in Removing MarkLogic).
  5. Install the new MarkLogic 11 release (as described in Installing MarkLogic).

    If you want to install MarkLogic 9.0-4 or later, and you plan to use the converters package with it, you will have to perform a two-step installation: first install MarkLogic Server and then install MarkLogic Converters. For more detail, see MarkLogic Converters Installation Changes Starting at Release 9.0-4 and Installing MarkLogic.

  6. Start MarkLogic Server (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 11, 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 8 and MarkLogic 11, as well as some incompatibilities between MarkLogic 7 and MarkLogic 11. Some of the incompatibilities might require minor code changes to your applications. For details on these incompatibilities, see the Release Notes.

Upgrading from Release 6.0 or earlier

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

Upgrading Clusters with DB Replication Configured

If you are upgrading clusters with DB replication configured, see Upgrading Clusters Configured with Database Replication in the Database Replication Guide for details.

Installing MarkLogic

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

Platform Perform the following:
Windows x64
  1. If you are upgrading from a previous MarkLogic release, review Upgrading from Previous Releases and perform necessary steps from that section first.
  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-version-amd64.msi icon to start the installer where version is the version of MarkLogic Server, for example, MarkLogic-10.0-4-amd64.msi.
  4. The Welcome page displays. Click Next.
  5. Select Typical.
  6. Click Install.
  7. Click Finish.

    If you are installing MarkLogic 9.0-4 or later, and you plan to use the converters package, also perform the following steps:

  8. Download the MarkLogic Converters package for Windows platform (for example, MarkLogicConverters-10.0-4-amd64.msi) from http://developer.marklogic.com to your desktop.
  9. Double click the MarkLogicConverters-10.0-4-amd64.msi icon to start the converters' installer.
  10. The welcome page displays: Welcome to the MarkLogic Converters Setup Wizard. Click Next.
  11. The Choose Setup Type page displays. Select Typical.
  12. The Ready to Install page displays. Click Install to start the installation.
  13. Installing MarkLogic Converters page displays. You may observe the progress there.
  14. The final page displays: Completing the MarkLogic Converters Setup Wizard. Click Finish.
Red Hat Linux x64
  1. If you are upgrading from a previous MarkLogic release, review Upgrading from Previous Releases and perform necessary steps from that section first.
  2. Download the MarkLogic Server installation package to /tmp or another location using your web browser. The latest installation packages are available from http://developer.marklogic.com.
  3. We recommend that you use yum to install MarkLogic instead of an rpm install. The yum install will automatically figure out the dependencies for you. As the root user, install the package with the following command: 
    yum install /tmp/MarkLogic-10.0-4x86_64.rpm
    1. For environments that don't allow a yum installation, the rpm install can be used. To do an rpm install: As the root user, install the package with the following command: 
      rpm -i /tmp/MarkLogic-10.0-4.x86_64.rpm

      If you are installing MarkLogic 9.0-4 or later, and you plan to use the converters package, also perform the following steps:

  4. Download the MarkLogic Converters package for Linux platform (for example, MarkLogicConverters-10.0-4.x86_64.rpm) from http://developer.marklogic.com to /tmp or another location.
  1. We recommend that you use yum to install MarkLogic instead of an rpm install. The yum install will automatically figure out all of the dependencies for you. As the root user, install the package with the following command: 
    yum install /MarkLogicConverters-10.0-4.x86_64.rpm
    1. For environments that don't allow a yum installation, the rpm install can be used. To do an rpm install:

      As the root user, install the package with the following command:

      rpm -i /tmp/MarkLogicConverters-10.0-4.x86_64.rpm
CentOS Linux
  1. If you are upgrading from a previous MarkLogic release, review Upgrading from Previous Releases and perform necessary steps from that section first.
  2. Download the MarkLogic Server installation package to /tmp or another location using your web browser. The latest installation packages are available from http://developer.marklogic.com.
  3. We recommend that you use yum to install MarkLogic instead of an rpm install. The yum install will automatically figure out the dependencies for you. As the root user, install the package with the following command: 
    yum install /tmp/MarkLogic-10.0-4.x86_64.rpm
    1. For environments that don't allow a yum installation, the rpm install can be used. To do an rpm install:

      As the root user, install the package with the following command:

      rpm -i /tmp/MarkLogic-10.0-4.x86_64.rpm

      If you are installing MarkLogic 9.0-4 or later, and you plan to use the converters package, also perform the following steps:

  4. Download the MarkLogic Converters package for Linux platform (for example, MarkLogicConverters-10.0-4.x86_64.rpm) from http://developer.marklogic.com to /tmp or another location.
  1. We recommend that you use yum to install MarkLogic instead of an rpm install. The yum install will automatically figure out all of the dependencies for you. As the root user, install the package with the following command: 
    yum install libgcc libgcc.i686 libstdc++ libstdc++.i686
    1. For environments that don't allow a yum installation, the rpm install can be used. To do an rpm install:

      As the root user, install the package with the following command:

      rpm -i /tmp/MarkLogicConverters-10.0-4.x86_64.rpm

      For CentOS 8, MarkLogic has a dependency on libnsl.so.1(). You can either rely on yum to pull in the dependency automatically, or install it manually.
Amazon Linux 2
  1. If you are upgrading from a previous MarkLogic release, review Upgrading from Previous Releases and perform necessary steps from that section first.
  2. Download the MarkLogic Server installation package to /tmp or another location using your web browser. The latest installation packages are available from http://developer.marklogic.com.
  3. We recommend that you use yum to install MarkLogic instead of an rpm install. The yum install will automatically figure out the dependencies for you. As the root user, load additional packages for EC2 support with the following command: 
    sudo yum install java-11-openjdk xfsprogs

    As the root user, create a symbolic link with the following command:

    sudo ln -s system-lsb /etc/redhat-lsb

    As the root user, install the MarkLogic Server installation package with the following command:

    sudo yum install MarkLogic-10.0-4.x86_64.rpm
    1. For environments that don't allow a yum installation, the rpm install can be used. To do an rpm install:

      As the root user, install the package with the following command:

      rpm -i /tmp/MarkLogic-10.0-4.x86_64.rpm

If you are installing MarkLogic 9.0-4 or later, and you plan to use the converters package, also perform the following steps:

  1. Download the MarkLogic Converters package for Linux platform (for example, MarkLogicConverters-10.0-4.x86_64.rpm) from http://developer.marklogic.com to /tmp or another location.
  2. We recommend that you use yum to install MarkLogic instead of an rpm install. The yum install will automatically figure out all of the dependencies for you. As the root user, install the package with the following command: 
    yum install libgcc libgcc.i686 libstdc++ libstdc++.i686
    1. For environments that don't allow a yum installation, the rpm install can be used. To do an rpm install:

      As the root user, install the package with the following command:

      rpm -i /tmp/MarkLogicConverters-10.0-4.x86_64.rpm
Mac OS X
  1. If you are upgrading from a previous MarkLogic release, review Upgrading from Previous Releases and perform necessary steps from that section first.
  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-10.0-4-x86_64.dmg icon to open the folder that contains the MarkLogic-10.0-4-x86_64.pkg installer. Double click on the installer to start.
  4. The Welcome page displays. Click Continue.
  5. In the Select a Destination window, select a destination to install MarkLogic Server or Continue to select the default destination.
  6. In the Installation Type window, click Install. An Installation window appears that displays the progress of the installation.
  7. When the installation Summary window appears, click Close.
  8. A MarkLogic control window appears from which you can start/stop MarkLogic Server, open the Admin Interface, and view the Error Log.

    If you are installing MarkLogic 9.0-4 or later, and you plan to use the converters package, perform also the following steps:

  9. Download the MarkLogic Converters package for Mac OS platform (e.g. MarkLogicConverters-10.0-4-x86_64.dmg) from http://developer.marklogic.com to your desktop.
  10. Double click the MarkLogicConverters-10.0-4-x86_64.dmg icon to open the folder that contains MarkLogicConverters-10.0-4-x86_64.pkg installer. Double click on the installer to start.
  11. The Welcome page displays. Click Continue.
  12. In the Select a Destination window, select the default destination.
  13. In the Installation Type window, click Install. An Installation window appears that displays the progress of the installation.
  14. When the installation Summary window appears, click Close.

    The Apple M1 chip is not supported.

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.

It is not recommended to install the converters while MarkLogic Server is running. The reason for this is that the server checks the converters presence and version number only upon start-up. So the server will not have accurate information about the converters in this case. The recommended installation procedure is to stop the server if it is running, install or upgrade the server, install the converters, then start the server.

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

Platform Installation Directory Default Data Directory (for configuration and log files)
Windows c:\Program Files\MarkLogic\ c:\Program Files\MarkLogic\Data
Red Hat Linux /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) a soft link to the alternate location.

In MarkLogic release 9.0-4 and later, MarkLogic Converters installation directory remains the same as in previous releases, namely:

Platform Converters Installation Directory
Windows c:\Program Files\MarkLogic\Converters
Red Hat Linux /opt/MarkLogic/Converters
Mac OS X ~/Library/MarkLogic/Converters

When a new node joins an existing cluster, the server does not try to figure out automatically whether the MarkLogic Converters package is needed or not. An XDMP-CVTNOTFOUND error will be thrown if converters/filters built-in functions are called on nodes that do not have MarkLogic Converters installed.

Starting MarkLogic Server

MarkLogic Server will automatically start when the computer reboots. To start MarkLogic Server without rebooting, perform the following command for the corresponding platform:

Platform Perform 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, 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:
/sbin/service MarkLogic start
Mac OS X Select 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.

Verifying Converters Installation Starting at Release 9.0-4

In MarkLogic 9.0-4 or later, after starting MarkLogic Server, you may verify whether the converters package was installed with use of the XQuery API function xdmp:host-status or the JavaScript API function xdmp.hostStatus.

Suppose you want to verify whether converters are installed on a node with hostname englab.marklogic.com.

Open Query Console URL in a browser:

http://englab.marklogic.com:8000/qconsole/

Perform steps described in one of the following sub-sections, depending on your API of choice.

Obtaining Converters Version with XQuery API

In the Query Console, select XQuery as Query Type.

Execute the following code:

xquery version "1.0-ml";
xdmp:host-status(xdmp:host("englab.marklogic.com"))

In the response, look for the converters-version element, for example:

<converters-version>9.0-4</converters-version>

If converters are not installed, the above element will have an empty value.

Obtaining Converters Version with JavaScript API

In the Query Console, select JavaScript as Query Type.

Execute the following code:

'use strict';
xdmp.hostStatus(xdmp.host("englab.marklogic.com"))

In the response, look for the convertersVersion element, for example:

"convertersVersion" : "9.0-4"

If converters are not installed, the above element will have an empty string as its value.

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 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 and a PKCS#11 wallet password. Enter the login name and password for the admin user, and enter the wallet password.

  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 start MarkLogic, as described in Installing MarkLogic 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 after installing MarkLogic you should enter a valid license key for the usage and features for which you are licensed. 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 for which 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 to Run as a Non-Daemon User

On UNIX-based systems (Linux), 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:
    Platform Perform the following to stop MarkLogic:
    Red Hat Linux As the root user, enter the following command:
    /sbin/service MarkLogic stop
  3. Edit the configuration file for your platform using a text editor such as vi.
    Platform Configuration File to Edit
    Red Hat Linux 
    /etc/marklogic.conf

    You must create the /etc/marklogic.conf file if it does not exist. This file is only read by the MarkLogic startup; it is never written to; therefore, it will survive an uninstallation of MarkLogic.

  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:
    export MARKLOGIC_USER=daemon

    to the following:

    export MARKLOGIC_USER=raymond
  5. Save the changes to the /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 you 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:
    Platform Default Data Directory (for configuration and log files, and default forest directory)
    Red Hat Linux /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.

On Linux systems, use the /etc/marklogic.conf script to set environment variables. Any configuration changes you make to the MarkLogic-supplied startup script (for example, /etc/sysconfig/MarkLogic) will not survive an upgrade and 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. If you use /etc/marklogic.conf for your environment variable changes, they will survive an upgrade and you will not need to merge your changes.

The following are default values of environment variables you can override in /etc/marklogic.conf on Linux-based systems (you will have to create the file if it does not exist):

export MARKLOGIC_INSTALL_DIR=/opt/MarkLogic 
export MARKLOGIC_DATA_DIR=/var/opt/MarkLogic
export MARKLOGIC_FSTYPE=ext4
export MARKLOGIC_USER=daemon
export MARKLOGIC_PID_FILE=/var/run/MarkLogic.pid
export MARKLOGIC_UMASK=022
export MARKLOGIC_DISABLE_JVM=0
export MARKLOGIC_EC2_HOST
export TZ=:/etc/localtime

Removing MarkLogic

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

Platform Perform the following:
Windows
  1. Stop MarkLogic: select Start > Programs > MarkLogic Server > Stop MarkLogic Server.

    If you are using Windows, 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.

  2. If you are uninstalling MarkLogic 9.0-4 or later, and you previously had the converters package installed, you need to uninstall it prior to uninstalling MarkLogic Server: select MarkLogic Converters in Add/Remove Programs of Control Panel, right click on it, and select Uninstall.
  3. Uninstall MarkLogic: select MarkLogic Server in Add/Remove Programs of Control Panel, right click on it, and select Uninstall.
Red Hat Linux
  1. Stop MarkLogic: as the root user, enter the following command: 
    /sbin/service MarkLogic stop
  2. If you are uninstalling MarkLogic 9.0-4 or later, and you previously had the converters package installed, you need to uninstall it prior to uninstalling MarkLogic Server: as the root user, enter the following command: 
    yum remove MarkLogicConverters
    1. For environments that don't allow a yum uninstallation, the rpm uninstall can be used. To do an rpm uninstall: as the root user, uninstall the package with the following command: 
      rpm -e MarkLogicConverters
  3. Uninstall MarkLogic: as the root user, enter the following command: 
    yum remove MarkLogic
    1. For environments that don't allow a yum uninstallation, the rpm uninstall can be used. To do an rpm uninstall: as the root user, uninstall the package with the following command: 
      rpm -e MarkLogic
Mac OS X
  1. Stop MarkLogic: select System Preferences > MarkLogic to open the MarkLogic control window, and click Stop MarkLogic Server.
  2. If you are uninstalling MarkLogic 9.0-4 or later, and you previously had the converters package installed, you need to uninstall it prior to uninstalling MarkLogic Server, with use of the following commands: 
    sudo pkgutil --forget com.marklogic.converters
    rm ~/Library/MarkLogic/Converters
  3. 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
  4. To entirely remove MarkLogic, remove the following directories: 
    ~/Library/MarkLogic
~/Library/Application Support/MarkLogic
~/Library/StartupItems/MarkLogic
~/Library/PreferencePanes/MarkLogic.prefPane
  5. 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.

In case you previously used converters/filters and want to remove this functionality:

  • To remove MarkLogic Converters from a node that has MarkLogic 9.0-4 or later release installed, you can use package management tool, such as Control Panel on Windows or rpm on Linux, to uninstall MarkLogic Converters.
  • To remove converters/filters from a node that has MarkLogic 9.0-3 or earlier release installed, you need to uninstall that release of MarkLogic, and then install MarkLogic Server from release 9.0-4 or later but do not install MarkLogic Converters.
« Previous chapter
Next chapter »