# Configuration Guide

## Introduction

This page describes the available configuration options for Mockdoor. Configuration can be done via environment variables or updating the appsettings.json files in the source code.

## Configuration Structure

```
"DeploymentConfiguration": {
   "PathBase": "/dev/mockdoor/",
   "SeedOnStartup": null,
   "ForceHttps": false,
   "Debug": false,
   "DebuggerUrl": "https://localhost:7275/dev/mockdoordebugger/debug/default/",
   "DatabaseConfig": {
     "Provider": 2,
     "ConnectionString": "Data Source=Data/mockdoor.debug.db;"
   }
}
```

<div class="code-toolbar" id="bkmrk-copy"><div class="toolbar"><div class="toolbar-item">  
</div></div></div>Above shows the configuration options available. To set them in an environment varaible use the format `"Parent__Child__Property=Value"` for example to set the `PathBase` to `"/test/path/"` you would put the environment variable `DeploymentConfiguration__PathBase=/test/path/"`.

## Docker example

For docker you can set the environment variable using the `-e` argument when running the container. For example to run the container with the above configuration and also setting the `"SeedOnStartup=Data/DemoSampleData.json"` you would run the following command

```
docker run -d -p 44304:80 --name mockdoor -e DeploymentConfiguration__PathBase=/test/path/ -e DeploymentConfiguration__SeedOnStartup=Data/DemoSampleData.json" mockdoor/server
```

<div class="code-toolbar" id="bkmrk-copy-0"><div class="toolbar"><div class="toolbar-item">  
</div></div></div>## Configuration Details

<div class="table-container" id="bkmrk-property-environment"><table style="width: 111.197%; height: 791px; display: block; overflow-x: auto; white-space: nowrap;"><thead><tr style="height: 63.3906px;"><th style="width: 4.19818%; height: 63.3906px;">Property</th><th style="width: 13.8737%; height: 63.3906px;">Environment Variable Path</th><th style="white-space: break-spaces; min-width: 400px; height: 63.3906px;">Description</th><th style="min-width: 300px; height: 63.3906px;">Example</th><th style="width: 8.10118%; height: 63.3906px;">Default</th></tr></thead><tbody><tr style="height: 113.781px;"><td style="width: 4.19818%; height: 113.781px;">PathBase</td><td style="width: 13.8737%; height: 113.781px;">DeploymentConfiguration\_\_PathBase</td><td style="white-space: break-spaces; height: 113.781px;">Sets a custom base path, this changes the path used to access Mockdoor. For example if /test/path/ is used then instead of accessing Mockdoor homepage at `https://localhost:44304` you access it from `https://localhost:44304/test/path/`. This is useful for when Mockdoor is behind a reverse proxy or in a K8 container and is not running on the base address.</td><td style="width: 46.5823%; height: 113.781px;">`"/test/path/"`</td><td style="width: 8.10118%; height: 113.781px;">`/`</td></tr><tr style="height: 80.1875px;"><td style="width: 4.19818%; height: 80.1875px;">SeedOnStartup</td><td style="width: 13.8737%; height: 80.1875px;">DeploymentConfiguration\_\_SeedOnStartup</td><td style="white-space: break-spaces; height: 80.1875px;">Sets a json database import file to import during startup. This must be added to the Mockdoor Server project in order to be accessible. There is a sample file under the Data folder called `DemoSampleData.json`</td><td style="width: 46.5823%; height: 80.1875px;">`Data/DemoSampleData.json`</td><td style="width: 8.10118%; height: 80.1875px;">`null`</td></tr><tr style="height: 63.3906px;"><td style="width: 4.19818%; height: 63.3906px;">ForceHttps</td><td style="width: 13.8737%; height: 63.3906px;">DeploymentConfiguration\_\_ForceHttps</td><td style="white-space: break-spaces; height: 63.3906px;">If true, this forces all request to Mockdoor to redirect to the https standard</td><td style="width: 46.5823%; height: 63.3906px;">`true`</td><td style="width: 8.10118%; height: 63.3906px;">`false`</td></tr><tr style="height: 113.781px;"><td style="width: 4.19818%; height: 113.781px;">Debug</td><td style="width: 13.8737%; height: 113.781px;">DeploymentConfiguration\_\_Debug</td><td style="white-space: break-spaces; height: 113.781px;">Sets if Mockdoor enables its additional debugging and diagnostics features. If true additional diagnostics page(s) will be enabled when errors occured. This can also affect the level of detail in some error messages in the UI</td><td style="width: 46.5823%; height: 113.781px;">`true`</td><td style="width: 8.10118%; height: 113.781px;">`true` when running in debug mode and `false` if not</td></tr><tr style="height: 96.9844px;"><td style="width: 4.19818%; height: 96.9844px;">DebuggerUrl</td><td style="width: 13.8737%; height: 96.9844px;">DeploymentConfiguration\_\_DebuggerUrl</td><td style="white-space: break-spaces; height: 96.9844px;">This is currently a unsupported feature that allows Mockdoor to send the Live feed feature to an external debugger application. This application has not been released as it does not add to Mockdoor anymore (since the Livefeed is now embedded). This may be improved and updated in the future but for now that makes this setting not useful.</td><td style="width: 46.5823%; height: 96.9844px;">`https://localhost:7275/debug/`</td><td style="width: 8.10118%; height: 96.9844px;">`null`</td></tr><tr style="height: 96.9844px;"><td style="width: 4.19818%; height: 96.9844px;">Provider</td><td style="width: 13.8737%; height: 96.9844px;">DeploymentConfiguration\_\_DatabaseConfig\_\_Provider</td><td style="white-space: break-spaces; height: 96.9844px;">Defines which database provider to use, 1 = Microsoft SQL Server, 2 = Sqlite</td><td style="width: 46.5823%; height: 96.9844px;">`1`</td><td style="width: 8.10118%; height: 96.9844px;">`null`</td></tr><tr style="height: 96.9844px;"><td style="width: 4.19818%; height: 96.9844px;">ConnectionString</td><td style="width: 13.8737%; height: 96.9844px;">DeploymentConfiguration\_\_DatabaseConfig\_\_ConnectionString</td><td style="white-space: break-spaces; height: 96.9844px;">The database connection string to use. Must be the correct format for the provider specified</td><td style="width: 46.5823%; height: 96.9844px;">`Data Source=Data/mockdoor.debug.db;`</td><td style="width: 8.10118%; height: 96.9844px;">`Data Source=Data/mockdoor.debug.db;`</td></tr></tbody></table>

</div>## Startup Configuration Diagnostics

During startup the connection string will be tested. If it finds the database it not on the latest version if will list the pending changes (migrations) and ask you to apply them. For new installs or when pointing to a new databse this will always appear the first time you run Mockdoor.

Mockdoor will also Create the database if it does no exist so long as the connection string provided has sufficient permissions to do so. If the connection string fails for any reason and Debug mode is enabled a connection string debugging page appears. Here you can test the connection string in the UI by changing it directly to test the connection until it works. This does not support persisting the configuration so once a working connection string is found you could copy it into the environment variable or appsettings, replacing the bad connection string.

<div id="bkmrk-fig.1---diagnostic-p" style="display: flex;"><div style="flex-grow: 1;"><figure style="margin: revert;">[ ![diagnostics screen](https://wiki.mymockdoor.com/uploads/images/gallery/2022-12/EBvvjWke9xP24hTm-mockdoor-database-diag-page-1.png) ](https://wiki.mymockdoor.com/uploads/images/gallery/2022-12/EBvvjWke9xP24hTm-mockdoor-database-diag-page-1.png)<figcaption>**Fig.1 - Diagnostic page on invalid database connection string**</figcaption></figure></div><div style="flex-grow: 1;"><figure style="margin: revert;">[ ![diagnostics screen](https://wiki.mymockdoor.com/uploads/images/gallery/2022-12/scaled-1680-/0GJNknfmeS4InjTB-mockdoor-diag-page-test-pass.png) ](https://wiki.mymockdoor.com/uploads/images/gallery/2022-12/scaled-1680-/0GJNknfmeS4InjTB-mockdoor-diag-page-test-pass.png)<figcaption>**Fig.2 - Diagnostics page on fixing connection string**</figcaption></figure></div></div>