### Sample Service Bus Only Installation Configuration

Source: https://help.relativity.com/Server2025/Content/Installing_and_Upgrading/Relativity_installation.htm

A sample RelativityResponse.txt file configuration for a service bus-only installation, including all necessary parameters for message broker setup.

```text
INSTALLSERVICEBUS=1
INSTALLDIR=C:\Program Files\kCura Corporation\Relativity
PRIMARYSQLINSTANCE=ML12
EDDSDBOPASSWORD=MySecretPassword
SERVICEUSERNAME=example\exampleusername
SERVICEPASSWORD=MySecretPassword 
USEWINAUTH=1
SERVICEBUSPROVIDER=RabbitMQ
SERVERFQDN=myRabbitMQFQDN
SHAREDACCESSKEY=myRabbitMQPassword
SHAREDACCESSKEYNAME=myRabbitMQUserName
SERVICENAMESPACE=Relativity
TLSENABLED=1
```

--------------------------------

### Sample RelativityResponse.txt File

Source: https://help.relativity.com/Server2025/Content/Installing_and_Upgrading/Relativity_installation.htm

A complete example of a configuration file for a web-only installation.

```text
INSTALLWEB=1
INSTALLDIR=C:\Program Files\kCura Corporation\Relativity
PRIMARYSQLINSTANCE=ML12
EDDSDBOPASSWORD=MySecretPassword
SERVICEUSERNAME=example\exampleusername
SERVICEPASSWORD=MySecretPassword 
USEWINAUTH=1
ENABLEWINAUTH=1
```

--------------------------------

### Example InvariantResponse.txt for Queue Manager

Source: https://help.relativity.com/Server2025/Content/Installing_and_Upgrading/Worker_manager_server_installation/Installing_the_worker_manager_server.htm

A sample configuration file for a queue manager installation.

```text
INSTALLQUEUEMANAGER=1
INSTALLWORKER=0
SQLINSTANCE=MySQLServer
RELATIVITYSQLINSTANCE=MyRelativitySQLServer
SERVICEUSERNAME=domain/username
SERVICEPASSWORD=MySecretPassword
```

--------------------------------

### Set Web Server Installation

Source: https://help.relativity.com/Server2025/Content/Installing_and_Upgrading/Relativity_Upgrade/Upgrading_your_web_server.htm

Set INSTALLWEB to 1 to install the web server. If set to 0 and the web server is already installed, it will be removed.

```ini
INSTALLWEB=1
```

--------------------------------

### Confirm Environment Watch setup

Source: https://help.relativity.com/Server2025/Content/Environment_Watch/Set_up_Environment_Watch_using_the_Relativity_Server_CLI.htm

Confirm the initiation of the setup process by entering 'y'.

```text
 Confirm you would like to perform the 'Environment Watch' setup [y/n] (y): y  
```

--------------------------------

### Run Relativity Environment Watch Installer

Source: https://help.relativity.com/Server2025/Content/Environment_Watch/Install_Environment_Watch_Monitoring_Agents.htm

Execute the installer from the extracted Server Bundle. This installs the monitoring agent. Ensure you have the Server-bundle zip file downloaded and extracted.

```powershell
Relativity.EnvironmentWatch.Installer.xx.x.xxxx.exe
```

--------------------------------

### Initialize Environment Watch setup

Source: https://help.relativity.com/Server2025/Content/Environment_Watch/Set_up_Environment_Watch_using_the_Relativity_Server_CLI.htm

Run the setup command from the extracted server bundle directory and select Environment Watch from the menu.

```text
 C:\Server.Bundle.x.y.z\relsvr.exe setup  
  
 Relativity Server CLI - 24.0.1196  
 Copyright (c) 2025, Relativity ODA LLC  
  
 What would you like to setup?  
   DataGrid  
 > Environment watch  
   Exit  
```

--------------------------------

### DropIt Command Line Example - Save, Drop, and Placeholder

Source: https://help.relativity.com/Server2025/Content/Installing_and_Upgrading/Hot_fixes_and_patches.htm

Example demonstrating saving original DLLs, dropping new DLLs, and specifying a placeholder for the WorkerNetworkPath.

```bash
DropIt -s -m "C:\Temp\hot fix 2\manifest.xml" –p:WorkerNetworkPath "\\EMTTEST\InvariantNetworkShare" –p:InvariantRPC "D:\Program Files\kCura Corporation\Invariant\RPC"
```

--------------------------------

### Configure Distributed SQL Server Installation

Source: https://help.relativity.com/Server2025/Content/Installing_and_Upgrading/Relativity_Upgrade/Upgrading_your_primary_SQL_Server.htm

Set INSTALLPRIMARYDATABASE to zero and INSTALLDISTRIBUTEDDATABASE to one for a distributed SQL Server setup. The installation directory must be local to the machine.

```ini
INSTALLPRIMARYDATABASE=0
```

```ini
INSTALLDISTRIBUTEDDATABASE=1
```

```ini
INSTALLDIR=C:\Program Files\kCura Corporation\Relativity
```

```ini
PRIMARYSQLINSTANCE=ML12
```

```ini
EDDSDBOPASSWORD=MySecretPassword
```

```ini
SERVICEUSERNAME=example\exampleusername
```

```ini
SERVICEPASSWORD=MySecretPassword
```

```ini
USEWINAUTH=1
```

--------------------------------

### Sample Service Bus Only Installation Configuration

Source: https://help.relativity.com/Server2025/Content/Installing_and_Upgrading/Relativity_Upgrade/Upgrading_Relativity_Service_Bus.htm

A sample RelativityResponse.txt file configuration for installing only the service bus components.

```ini
INSTALLSERVICEBUS=1
INSTALLDIR=C:\Program Files\kCura Corporation\Relativity
PRIMARYSQLINSTANCE=ML12
EDDSDBOPASSWORD=MySecretPassword
SERVICEUSERNAME=example\exampleusername
SERVICEPASSWORD=MySecretPassword 
USEWINAUTH=1
SERVICEBUSPROVIDER=RabbitMQ
SERVERFQDN=localhost
SHAREDACCESSKEY=guest
SHAREDACCESSKEYNAME=guest
SERVICENAMESPACE=Relativity
TLSENABLED=1
```

--------------------------------

### DropIt Command Line Example - Save, Drop, and Relativity Placeholder

Source: https://help.relativity.com/Server2025/Content/Installing_and_Upgrading/Hot_fixes_and_patches.htm

Example demonstrating saving original DLLs, dropping new DLLs, and specifying a placeholder for Relativity.

```bash
DropIt -s -m "C:\Temp\hot fix 5\manifest.xml" –p:Relativity "D:\Program Files\kCura Corporation\Relativity"
```

--------------------------------

### Get Kibana Service Details (PowerShell)

Source: https://help.relativity.com/Server2025/Content/Elasticstack/Kibana_Troubleshooting.htm

Retrieves detailed information about the Kibana service, including its name, state, start mode, and the account it runs under.

```powershell
Get-CimInstance -ClassName Win32_Service -Filter "Name='kibana'" | Select-Object Name, State, StartMode, StartName
```

--------------------------------

### Initialize Data Grid Setup

Source: https://help.relativity.com/Server2025/Content/Environment_Watch/Enable_Data_Grid_Audit.htm

Run the Relativity Server CLI executable to begin the Data Grid configuration process.

```text
C:\Server.Bundle.x.y.z\relsvr.exe setup  
Relativity Server CLI - 24.0.1196  
Copyright (c) 2025, Relativity ODA LLC  
  
What would you like to setup?  
> DataGrid  
  Environment watch  
  Exit  
```

--------------------------------

### DropIt Command Line Examples

Source: https://help.relativity.com/Server2025/Content/Installing_and_Upgrading/Hot_fixes_and_patches.htm

Illustrative examples of how to use the DropIt command line with various options.

```APIDOC
### Examples

1. **Saving and Dropping DLLs with Placeholder Replacement:**
   ```
   DropIt -s -m "C:\Temp\hot fix 2\manifest.xml" –p:WorkerNetworkPath "\\EMTTEST\InvariantNetworkShare" –p:InvariantRPC "D:\Program Files\kCura Corporation\Invariant\RPC"
   ```
   *This command saves original DLLs, drops new DLLs using the specified manifest, and replaces the `WorkerNetworkPath` and `InvariantRPC` placeholders with provided network paths.*

2. **Saving and Dropping DLLs with Relativity Placeholder Replacement:**
   ```
   DropIt -s -m "C:\Temp\hot fix 5\manifest.xml" –p:Relativity "D:\Program Files\kCura Corporation\Relativity"
   ```
   *This command saves original DLLs, drops new DLLs, and replaces the `Relativity` placeholder with the specified directory.*

3. **Saving DLLs and Replacing Worker Network Path:**
   ```
   DropIt -s -replaceWorkerNetworkPath "\\EMTTEST\InvariantNetworkShare"
   ```
   *This command saves original DLLs and replaces the `WorkerNetworkPath` using the provided network path. Note: The manifest file (`-m`) is required for dropping DLLs, but this example focuses on the `-replaceWorkerNetworkPath` functionality.*
```

--------------------------------

### Development Single-Node Configuration

Source: https://help.relativity.com/Server2025/Content/Elasticstack/Installing_Elastic_Stack.htm

Example configuration for a single-node development Elasticsearch cluster. This setup assigns all roles (master, data, ingest) to a single node and is suitable for local testing.

```yaml
# Development single-node configuration  
cluster.name: dev-cluster  
node.name: dev-node-1  
node.roles: ["master", "data", "ingest"]  
network.host: localhost  
http.port: 9200  
```

--------------------------------

### Curator Setup Parameters

Source: https://help.relativity.com/Server2025/Content/Relativity/Data_Grid/Backing_up_Data_Grid.htm

Defines parameters for setting up Elasticsearch Curator, including hostnames, repository names, credentials, and paths to the MSI installer and Curator directory. It also includes an option to use SSL.

```powershell
Param(
$probHostName = "dg-ramp-01",
$marvelHostName = "dg-ramp-agt",
$repositoryName = "datagridbackup",
[string]$esUsername = "esadmin",
[string]$esPassword = "esadmin",
[string]$marvelUsername = "marvel",
[string]$marvelPassword = "marvel",
$curatorMsiPath = "C:\Curator\elasticsearch-curator-4.2.6-win32.msi",
$curatorPath = "C:\Curator",
$useSSL = "True"
)

$httpAuth = [system.Text.Encoding]::ASCII
$httpAuth = "$esUsername`:$esPassword"
$httpAuthMarvel = [system.Text.Encoding]::ASCII
$httpAuthMarvel = "$marvelUsername`:$marvelPassword"
$powerShellPath = (Resolve-Path /Windows/System32/WindowsPowerShell/v1.0/).Path

```

--------------------------------

### Curator Setup PowerShell Script

Source: https://help.relativity.com/Server2025/Content/Relativity/Data_Grid/Backing_up_Data_Grid.htm

This PowerShell script automates the installation of Curator, creates necessary configuration and action files (prodConfig.yml, prodBackup.yml, prodCleanUp.yml), and sets up Windows tasks for backup and cleanup. Ensure the MSI path and other parameters are correctly set.

```powershell
<##>
Param(
$probHostName = "masternodename",
$marvelHostName = "marvelnodename",
$repositoryName = "datagridbackup",
[string]$esUsername = "esadmin",
[string]$esPassword = "esadmin",
[string]$marvelUsername = "marvel",
[string]$marvelPassword = "marvel",
$curatorMsiPath = "C:\\Curator\\elasticsearch-curator-4.2.6-win32.msi",
$curatorPath = "C:\\Curator",
$useSSL = "False"
)

$httpAuth = [system.Text.Encoding]::ASCII
$httpAuth = "$esUsername`:$esPassword"
$httpAuthMarvel = [system.Text.Encoding]::ASCII
$httpAuthMarvel = "$marvelUsername`:$marvelPassword"
$powerShellPath = (Resolve-Path /Windows/System32/WindowsPowerShell/v1.0/).Path

function IsCuratorInstalled {
    $isInstalled = ((Get-ChildItem "HKLM:\\Software\\Microsoft\\Windows\\CurrentVersion\\Uninstall") | Where-Object { $_.GetValue( "DisplayName" ) -eq "elasticsearch-curator" } )
 
    If (!$isInstalled) {
        Try{
            Write-Host "Installing Curator 4.2.6" -ForegroundColor Green
            Start-Process msiexec.exe -Wait -ArgumentList "/I $curatorMsiPath /quiet" -ErrorAction Stop
            Write-Host "Installation Complete."
        }Catch{
            $ErrorMessage = $_.Exception.Message; Break
        }
    }else{
    Write-Host "Curator is already installed." -ForegroundColor Green
    }
}
IsCuratorInstalled
         
function MakeFiles
{
function MakeProdConfigYML
{
$prodConfigYml = @"
---
# Remember, leave a key empty if there is no value.  None will be a string,
# not a Python "NoneType"
client:
  hosts:
  - $probHostName
  port: 9200
  url_prefix:
  use_ssl: $useSSL
  certificate:
  client_cert:
  client_key:
  ssl_no_validate: True
  http_auth: $httpAuth
  timeout: 30
  master_only: False
 
logging:
  loglevel: INFO
  logfile:
  logformat: default
  blacklist: ['elasticsearch', 'urllib3']
"@
 
$prodConfigYml | Out-File .\prodConfig.yml -Encoding ascii
}
MakeProdConfigYML
 
function MakeBackupActionYML
{
$prodBackupYml = @"
# Remember, leave a key empty if there is no value.  None will be a string,
# not a Python "NoneType"
#
# Also remember that all examples have 'disable_action' set to True.  If you
# want to use this action as a template, be sure to set this to False after
# copying it.
# Leaving name blank will result in the default 'curator-%Y%m%d%H%M%S'
actions:
  1:
    action: snapshot
    description: "Created snapshots for all indexes."
    options:
      repository: $repositoryName
      name:
      ignore_unavailable: False
      include_global_state: True
      partial: False
      wait_for_completion: True
      skip_repo_fs_check: False
      timeout_override:
      continue_if_exception: False
      disable_action: False
    filters:
    -  filtertype: none
"@
 
$prodBackupYml | Out-File .\prodBackup.yml -Encoding ascii
}
MakeBackupActionYML
 
function MakeCleanUpActionYML
{
$prodCleanUpYml = @"
# Remember, leave a key empty if there is no value.  None will be a string,
# not a Python "NoneType"
#
# Also remember that all examples have 'disable_action' set to True.  If you
# want to use this action as a template, be sure to set this to False after
# copying it.
# Leaving name blank will result in the default 'curator-%Y%m%d%H%M%S'
actions:
  1:
    action: delete_snapshots
    description: "Deletes snapshots older than 14 days."
    options:
      repository: $repositoryName
      retry_interval:
      retry_count:
      timeout_override:
      continue_if_exception: False
      disable_action: False
    filters:
    -  filtertype: pattern
       kind: prefix
       value: curator-
       exclude:
    -  filtertype: age
       source: creation_date
       direction: older
       unit: days
       unit_count: 14
       exclude:
"@
 
$prodCleanUpYml | Out-File .\prodCleanUp.yml -Encoding ascii
}
MakeCleanUpActionYML
 
function MakeMarvelConfigYML
{
$marvelConfigYml = @"
---
# Remember, leave a key empty if there is no value.

```

--------------------------------

### List Installed Plugins

Source: https://help.relativity.com/Server2025/Content/Elasticstack/Installing_Elastic_Stack.htm

Verify the installation of the 'mapper-size' plugin by listing all installed Elasticsearch plugins.

```powershell
.\elasticsearch-plugin list  

```

--------------------------------

### Installer Log Directory

Source: https://help.relativity.com/Server2025/Content/Environment_Watch/Install_Environment_Watch_Monitoring_Agents.htm

Refer to the installer logs in the %TEMP% directory for troubleshooting installation issues.

```powershell
%TEMP%
```

--------------------------------

### Configure Agent Installation

Source: https://help.relativity.com/Server2025/Content/Installing_and_Upgrading/Relativity_installation.htm

Set INSTALLAGENTS to 1 to install the agent server. This setting only applies to initial installations.

```text
INSTALLAGENTS=1
```