MarkLogic Server Administrator’s Guide 2 MarkLogic 9 May, 2017 Last Revised: 9.0-12, February, 2020 Copyright © 2020 MarkLogic Corporation. All rights reserved. MarkLogic Server Version MarkLogic 9—May, 2017 Page 2—Administrator’s Guide MarkLogic Server Table of Contents Table of Contents Administrator’s Guide 1.0 Introduction ..................................................................................................17 1.1 Objectives .............................................................................................................17 1.2 Audience ...............................................................................................................17 1.3 Scope and Requirements .......................................................................................17 1.4 Architecture Overview ..........................................................................................18 2.0 Administrative Interface ..............................................................................21 2.1 Overview of the Admin Interface .........................................................................21 2.2 Accessing the Admin Interface .............................................................................22 2.3 Logging Off the Admin Interface .........................................................................22 2.4 Creating and Managing Administrators ................................................................22 3.0 Common Administrative Procedures ...........................................................23 3.1 Installing and Upgrading MarkLogic Server ........................................................23 3.2 Starting and Stopping MarkLogic Server .............................................................23 3.3 Creating and Configuring Forests and Databases .................................................24 3.4 Creating and Configuring App Servers ................................................................24 3.5 Setting up Users, Roles, Privileges, and Permissions ...........................................25 3.6 Loading Content into a Database ..........................................................................25 3.7 Running The XQuery Use Cases and Building Simple Applications ..................25 3.8 Backing up and Restoring Data ............................................................................25 3.9 Monitoring and Tuning Performance ...................................................................26 3.10 Scripting and Scheduling Administrative Tasks ...................................................27 3.11 Configuring Clusters, Groups and Failover ..........................................................27 4.0 Starting and Stopping MarkLogic Server ....................................................29 4.1 Starting the Server ................................................................................................29 4.2 Stopping the Server ...............................................................................................29 4.2.1 Using System Command to Stop MarkLogic Server ................................30 4.2.2 Using the Admin Interface to Stop MarkLogic Server .............................30 4.3 Restarting the Server .............................................................................................31 4.4 Example XQuery Scripts ......................................................................................31 4.4.1 Script that Restarts MarkLogic Server ......................................................31 4.4.2 Script that Stops MarkLogic Server ..........................................................31 5.0 Clusters .........................................................................................................33 5.1 Overview of Cluster Configuration ......................................................................33 MarkLogic 9—May, 2017 Administrator’s Guide—Page 3 MarkLogic Server Version MarkLogic 9—May, 2017 Table of Contents 5.2 OpenSSL FIPS 140-2 Mode .................................................................................33 5.3 Procedures for Configuring Clusters ....................................................................33 5.3.1 Configuring OpenSSL FIPS 140-2 Mode .................................................34 5.3.2 Cluster Encryption Options ......................................................................35 5.3.2.1 Change the Internal KMS Password .........................................39 5.3.2.2 Synchronizing the KMS Keys ...................................................40 5.3.3 Configuring Ops Director .........................................................................40 5.3.4 Coupling Clusters .....................................................................................40 5.4 Configuring a MarkLogic Application Message and Banner ...............................48 5.4.1 Example Configuration .............................................................................48 5.4.2 Configuration Reference ...........................................................................49 5.4.3 Example: Creating a New Configuration Document ................................50 5.4.4 Example: Activate/Deactivate a Configuration ........................................51 5.4.5 Example: Modify the Notification Dialog Text ........................................52 5.4.6 Example: Modify the Banner Text ...........................................................52 6.0 Groups ..........................................................................................................53 6.1 Overview of Groups ..............................................................................................53 6.2 Example ................................................................................................................54 6.3 Procedures for Configuring and Managing Groups ..............................................55 6.3.1 Creating a New Group ..............................................................................55 6.3.2 Group Settings ..........................................................................................57 6.3.3 Enabling SSL communication over XDQP ..............................................64 6.3.4 Configuring an SMTP Server ...................................................................65 6.3.5 Restarting All Hosts in a Group ................................................................65 6.3.6 Deleting a Group .......................................................................................66 7.0 HTTP Servers ...............................................................................................67 7.1 HTTP Server Overview ........................................................................................67 7.2 Procedures for Creating and Managing HTTP Servers ........................................68 7.2.1 Creating a New HTTP Server ...................................................................68 7.2.2 Setting Output Options for an HTTP Server ............................................72 7.2.3 Viewing HTTP Server Settings ................................................................73 7.2.4 Deleting an HTTP Server .........................................................................73 7.2.5 Canceling a Request ..................................................................................74 8.0 XDBC Servers ..............................................................................................77 8.1 XDBC Server Overview .......................................................................................77 8.2 Procedures for Creating and Managing XDBC Servers .......................................78 8.2.1 Creating a New XDBC Server ..................................................................78 8.2.2 Setting Output Options for an XDBC Server ...........................................82 8.2.3 Viewing XDBC Server Settings ...............................................................83 8.2.4 Deleting an XDBC Server ........................................................................83 Page 4—Administrator’s Guide MarkLogic Server Table of Contents 9.0 WebDAV Servers ........................................................................................85 9.1 WebDAV Server Overview ..................................................................................85 9.1.1 Accesses a Database for Read and Write, Not XQuery Execution ..........86 9.1.2 WebDAV Server Security ........................................................................86 9.1.3 Directories .................................................................................................87 9.1.3.1 Automatic Directory Creation in a Database Settings ..............87 9.1.3.2 Properties and URIs of Directories ...........................................88 9.1.4 Server Root Directory ...............................................................................89 9.1.5 Documents in a WebDAV Server .............................................................89 9.2 Procedures for Creating and Managing WebDAV Servers ..................................90 9.2.1 Creating a New WebDAV Server .............................................................90 9.2.2 Setting Output Options for a WebDAV Server ........................................93 9.2.3 Viewing WebDAV Server Settings ..........................................................94 9.2.4 Deleting a WebDAV Server .....................................................................94