1. Support Home
  2. NetDocuments for Administrators
  3. ndMirror

ndMirror Installation and Configuration

Follow
Avatar
Iryna Kuziv

Table of Contents

Setup Prerequisites

NetDocuments ndMirror is a paid add-on service connected to the NetDocuments repository. In sections below, you can find information about the recommended accesses and setup prerequisites as well as the table illustrating the user roles and the difference between them.

NetDocuments Repository Access

You need to be a repository and cabinet administrator for each repository and cabinet you want mirrored.

Windows Access

You need to have administrative privileges to the following locations:

  • A computer where ndMirror is installed.
  • Storage location where the document files are stored.
  • SQL Server instance.

Setup Requirements

In the table below, you can find the recommended SQL Server, OS, and .NET setup requirements.

Setup Prerequisites Comments
Supported OS
  • Windows Server 2012 R2 64-bit or Windows Server 2016 64 bit.
  • Also, you can run ndMirror on any Windows 7 (64 bit) or higher Desktop OS.

If your server is running Windows Server 2012, you may need to enable the Internet Explorer Enhanced Security Configuration.

To turn on Internet Explorer Enhanced Security Configuration:

  1. To open the Local Server configuration page, click Configure this local server.
  2. In the Properties area, click the Off link next to IE Enhanced Security Configuration.
In the Internet Explorer Enhanced Security Configuration dialog box, under Administrators or Users, click On.
SQL Server
  • Microsoft SQL Server 2012 (R2), 2014, or 2016
  • Microsoft SQL Express is not recommended

Warning: The free of charge Microsoft SQL Express imposes database size limitations that make it not suitable for most firms. There are too many variables to be able to specify just how many documents and transactions may put a firm over this limit.

You can set up the SQL Server instance on the same server as ndMirror or on a separate server.
.NET

.NET Framework 4.6.2 or 4.7 is required for installation.

To install .NET Framework, click the following links:

Note: To view the ndMirror Web Administrative Dashboard, you must have a web browser installed.

User Roles

The following table illustrates the user roles and the difference between them.

User role Definition

installer.jpg

Installer user
  • Must have permissions to the MS SQL Server.
  • Runs the installer and does all preparations.
  • Creates the database.
  • Adds the Login and Access permissions to the database for the database user.

Note: Instead of the installer user, you can use an SQL user, who has the same rights listed above.

ndmirror.jpg

ndMirror user
  • Is a Windows user who needs to have the Log on as a Service right (granted by the installer user).
  • Runs the service and makes use of the ND administrator credentials entered by the Dashboard user in order to communicate with NetDocuments.

database.jpg

Database user
  • Needs to have SELECT, INSERT, UPDATE, and DELETE permissions in the database and gives read and write permissions to the database.
  • Has db_owner (db_owner right already includes read, write, and admin permissions), or both db_datareader and db_datawriter rights.

Note: Usually, it is the same user as Windows service user. However, it can be an MS SQL Server user (provided using the connection string). For more information about the connection string, click here.

dashboard.jpg

Dashboard user

 Has access to the Web Administrative Dashboard and is responsible for submitting NetDocuments credentials. There can be more than one user of the Web Administrative Dashboard.

NetDocuments administrator

A repository and cabinet administrator. User credentials are entered by the Dashboard user and used by the ndMirror user to download documents and other data.

It is recommended to set up a special service account with these rights so that ndMirror activity is not tied to a specific user.

Back to Top

Installer Setup

After downloading the ndMirror installer, follow steps below to begin the installation.

  1. Double-click the .exe installer, and then click Run to continue.
  2. In the Welcome to the NetDocuments ndMirror Setup Wizard dialog box, click Next.

Note: To cancel the installation at any time, click Exit.

The Welcome to the NetDocuments ndMirror Setup Wizard dialog box

  1. Read the license agreement, select the I accept the terms in the Terms of Use check box, and then click Next.
  2. In the Destination Folder dialog box, specify the installation folder.

Note: The default location for installing ndMirror is C:\Program Files\NetDocuments\ndMirror\<version number>. To specify another installation folder, click Change.

The Destination Folder dialog box

  1. Create a user during this step if you have not done it already. You need to create a service user (Windows or Active Directory Domain account) on behalf of which ndMirror Windows Service will be running. This user should have the following rights:
  • Write permission to the folders or network share where you are going to mirror the content.
  • Access to the SQL Server database to store all metadata and ndMirror additional information.
In the Service Account dialog box, do the following:
a. Click Use Custom Domain Account.
b. To add a user, click Select User, enter a password, and then click Next.
 
Note: The default option is Use Custom Domain Account. We do not recommend selecting the Use Local System Account option, because this account has a high level of access to the operating system, thus exposes it to the security risks. After selecting the Use Local System Account option, the User and Password fields, as well as the Select User link, become unavailable.

The Service Account dialog box

  1. In the Database Connection dialog box, do one of the following:
  • To open the Connection Properties dialog box where you can configure SQL Server properties, click Connect Database.
OR
  • To manually configure the connection string, click Advanced.

The Database Connection dialog box

  1. If you have chosen Connect Database, then, in the Connection Properties dialog box, specify the data source and server name, and then specify the authentication properties.

The Connection Properties dialog box

ndMirror will offer to create the database if one does not already exist. The default name of the database is ndMirror. You will also be prompted to grant ndMirror access to the database.

Note: To test the database connection, click Test Connection.

  1. Click OK to proceed.
  2. In the Global Storage Location Configuration dialog box, define the global storage location where the mirrored document content from NetDocuments is stored. This can be a local folder or a network share. Make sure that the ndMirror user has sufficient access rights to this folder. The path specification supports replaceable parameters.

Note: You can change the global storage location as well as the individual storage location per each cabinet on the Web Administrative Dashboard. For more information, see Global Storage Location and Cabinets.

The Global Storage Location Configuration dialog box

For example, if you specify the storage location in the format C:/NetDocuments/ndMirror/%alpha%/%cab%, its local path will be C:/NetDocuments/ndMirror/L/Legal Agreements. The %alpha% replaceable parameter must be used in the middle of the path.

  1. In the Global Filtering dialog box, specify content synchronization options. For more information, see Global Filtering.

The Global Filtering dialog box

  1. In the Network Configuration dialog box, configure proxy settings to access NetDocuments. The System Proxy option is selected by default.

The Network Configuration dialog box

  1. In the SMTP Configuration dialog box, select the Enable email notifications check box if you want to receive emails about errors or other helpful information.

Note: You can configure SMTP settings on the Web Administrative Dashboard. For more information, see SMTP Configuration.

The SMTP Configuration dialog box

  1. In the Web Administrative Dashboard dialog box, specify the dashboard port. Make sure that this port is unique. If you would like to access your application from other machines in the same network, installer opens this port automatically.

The Web Administrative Dashboard dialog box

  1. In the Web Administrative Dashboard dialog box, click Find to add user or groups that will have the authorization to access and configure ndMirror using the Web Administrative Dashboard.

Add Windows or domain users and groups that will be able to manage ndMirror and access the Web Administrative Dashboard. The installer creates the ndMirrorAdministrators group automatically. To remove the ndMirrorAdministrators group, click the  icon. You can further edit or remove users and groups on the Administrator Access page of the Web Administrative Dashboard. For more information, see Administrator Access.

The Web Administrative Dashboard dialog box

  1. In the Install Summary dialog box, revise the configuration details, and then click Install.

The Install Summary dialog box

  1. In the NetDocuments ndMirror Installation Completed dialog box, click Finish. The Web Administrative Dashboard automatically opens in your default browser and requests you to log in as the dashboard user.

The NetDocuments ndMirror Installation Completed dialog box

Note: To ensure the security of sensitive data, ndMirror stores the encrypted connection string, Client Secret Refresh token, and email password.

Back to Top

Repairing ndMirror

If ndMirror is not working properly it could be due to corrupted installation files; you can try repairing the application. To repair the application, do one of the following:

  • Run the same installation file, and then click Repair.
  • Click Change for the NetDocuments ndMirror in Programs and Features (in Control Panel > Programs).

Warning: After the repair operation, the modified files are restored to its default state, including application configuration file, for example, if it has been changed to enable REST API tracing.

Post-installation Configuration Steps

  1. The Web Administrative Dashboard requires authentication. ndMirror uses integrated Windows authentication. Keep in mind, it may use different policies, so if you enter wrong credentials several times your account will be blocked. You need to restart the browser to authenticate again. Multiple attempts of failed logins may lock your domain account (this depends on your Windows/Domain group policy).

Note: The default URL of Web Administrative Dashboard is http://machine-name:9090, you may also use http://localhost:9090 or 127.0.0.1. You can access the Web Administrative Dashboard from another machine using the port specified during the installation. By default, ndMirror installs the NetDocuments ndMirror View Dashboard All TCP firewall rule during the installation to allow a connection based on the TCP protocol to the port provided during the installation.

  1. Navigate to the Settings tab in the left pane, and then click NetDocuments Authentication.

The NetDocuments Authentication page

  1. Enter credentials for each host where you are going to mirror the cabinets. The following hosts are available:
    • netvoyage.com
    • netdocuments.com
    • netdocuments.com
    • netdocuments.com
  2. After selecting the host (for example, the Vault US host), click New Credentials.
  3. In the Adding credentials to Vault US dialog box, enter NetDocuments credentials in the corresponding fields, and then click Login.

Note: You need to add the corresponding host and port as a Trusted Site in Internet Explorer.

  1. To allow ndMirror to interact with NetDocuments Document Management System, click Allow.

The Adding credentials to Vault US dialog box

  1. After successful login, copy and paste the displayed code into the field below, and then click Add.

The Adding credentials to Vault US dialog box

Tip: In some environments, you may not be able to see the code on the same page, as some authorization methods cannot display it. To display the code on the separate page, click the link in the Note of the Adding credentials to Vault US dialog box, copy, and then paste the code back into the corresponding field.

  1. To add cabinets for synchronization, click Add cabinet to sync.
  2. In the Add cabinet to synchronize dialog box:

a. Select a cabinet to synchronize from the drop-down box.

b. Specify the individual storage location by clearing the Use global storage location check box, and then enter a new storage location. If you want to use the global storage location that you have specified during the installation, do not clear the check box. For more information, see Global Storage Location.

c. Set individual content filtering options by clearing the Use global filtering check box, and then specify the needed synchronization options. If you want to use the global filtering settings you have specified during the installation, do not clear the check box. For more information, see Global Filtering.

d. To apply changes, click Save.

The Add cabinet to synchronize dialog box

Note: From the Choose cabinet to synchronize drop-down box, you will be able to see and select only those cabinets to which you have administrator rights. If you lose administrative access to a certain cabinet, synchronization will be paused and the corresponding log will be recorded.

  1. Repeat step 8 and 9 for all cabinets that you want to mirror at this host (Vault, EU, or AU).
  2. To see if the synchronization has already started and to check its progress, navigate to the Dashboard page.
Note: Statistics is cached and is not updated immediately (only logs and synchronization sessions).