Deploying MDriven Server and MDriven Turnkey
This is the starting point for installing and running MDriven Server and MDriven Turnkey on your own servers or in the cloud. Start by choosing the installation that matches the download you use; the guides further down cover configuration, operations and scaling for all platforms.
Choose your installation
MDriven Server and MDriven Turnkey are downloaded from the MDriven downloads page in the same variants as below. Use the same variant for both.
| Download | Runs on | Hosted by | Start here |
|---|---|---|---|
| Windows .NET Core (recommended for Windows) | Windows Server, Windows 10/11 | IIS (as a reverse proxy) | Install on Windows (.NET Core) |
| Windows .NET Framework | Windows Server, Windows 10/11 | IIS (.NET Framework 4.x application pool) | Install on Windows (.NET Framework) |
| Linux | Linux x64 (e.g. Ubuntu) | systemd service behind Nginx or Apache, or Docker | Install on Linux as services, Docker |
| Linux Arm64 | Linux on ARM 64-bit (e.g. Raspberry Pi 4/5, ARM servers) | as Linux | The Linux guide, with the Arm64 download |
| Linux MUSL | Linux distributions built on musl, such as Alpine | as Linux, typically in containers | The Linux guide or Docker, with the MUSL download |
| macOS x64 / macOS Arm64 | Intel or Apple Silicon Macs | Terminal or service (launchd), or Docker | Native macOS |
| (no download needed) | Microsoft Azure | Azure App Service | Install on Azure |
.NET Core or .NET Framework?
- .NET Core (the "Core" builds) is the recommended choice for new installations on every platform. Each application is a self-contained program with its own built-in web server – see How MDriven Core runs.
- .NET Framework is still supported on Windows, but it is not the recommended path for new installations. Existing installations can move with Migrating from .NET Framework to .NET Core.
Windows
- Installing on Windows – which guide to use
- Install on Windows with IIS – .NET Core (recommended)
- MDriven Installation Scripts – install and update whole environments with PowerShell
- Manual installation of the Core builds in IIS
- Install on Windows with IIS – .NET Framework
IIS configuration
- Application pool user and folder permissions
- Certificates and HTTPS on IIS
- Turn on WebSockets in IIS
- Maximum upload size (maxAllowedContentLength)
- CORS
- Simple URLs with IIS URL Rewrite
- MDriven Server with Windows authentication (.NET Framework)
- Memory optimization when hosting many sites
Troubleshooting on IIS
Windows development machine
- LocalServers – the local MDriven Server and Turnkey that MDriven Designer starts for you
- Run MDriven locally with Docker
Microsoft Azure
- Azure Web App – overview
- Install MDriven Server and Turnkey on Microsoft Azure
- Log in with Microsoft Entra ID (Azure AD)
Docker
- Deploying MDriven Server and Turnkey with Docker – overview and downloads
- Run MDriven locally with Docker
- Production deployment with Docker and Nginx
- Production databases: PostgreSQL, MySQL, SQL Server
- Advanced Docker Compose configuration
Linux
- Install MDriven Server and Turnkey on Ubuntu as services
- Nginx as a reverse proxy, with Let's Encrypt
- Apache as a reverse proxy
- MDriven on a Synology NAS
macOS
Configuration (all platforms)
- CommandLineOverride.xml – startup parameters of the Core builds
- MDrivenServerOverride.xml – where Turnkey finds its MDriven Server
- HardServerUrl.xml – the address an application uses for itself
- Turnkey settings
- Store the data in SQL Server
Operating the installation
- Logs of MDriven Turnkey and MDriven Server
- Writing to the Windows event log
- Upgrading MDriven products
- Stable and Canary builds
- Backup and restore
Scaling
- Load balancing MDriven Turnkey and MDriven Server
- Scaling MDriven Server (master, slave and history servers)
CI/CD
Older notes
These pages describe earlier ways of installing MDriven. They are kept for existing installations and for reference.
- Set up MDriven Turnkey on premise – the classic .NET Framework installation from the MDriven Book
- Automate deployment with msdeploy (Web Deploy) – replaced by the MDriven Installation Scripts
- Publishing Turnkey to your own Azure account from MDriven Designer
- Deploying to Azure from OneDrive (retired by Microsoft in 2023)
- Let's Encrypt site extension for Azure
- Docker Desktop on Intel Macs
- Introduction of the .NET Core builds
- IIS Express
- Developer notes on WSL
