Installation
Compiling MistServer
We consider compiling and running MistServer the most efficient way, due to the configurable nature of MistServer chances are you will want to make your own adjustments and run MistServer your way.
Dependencies
- C++ compiler
- Meson
- mbedtls (optional, automatically compiled as a subproject if SSL is enabled and mbedtls is not installed system-wide)
- libsrt (optional, automatically compiled as a subproject if SRT is enabled and libsrt is not installed system-wide)
- librist (optional, automatically compiled as a subproject if RIST is enabled and librist is not installed system-wide).
Easy compile command
git clone https://github.com/DDVTECH/mistserver.git && cd mistserver && meson setup build -DNORIST=true && meson compile -C build
You will find the MistServer binaries within the mistserver/build folder. Should you wish to make MistServer available as a service please have a look at the service scripts included within the main directory.
Running MistServer
MistServer can be ran without an installation as well. Simply boot up the MistController(.exe) when you download the binaries and you're good to go. The configurations will be saved in the same folder as config.json.
Do note that some of MistServer's automatic error recovery features will not function properly when not running as a system service.
What OS is best for MistServer?
MistServer can run in every OS, however the clear winner is Linux with no meaningful difference between AMD and ARM. This is because MistServer relies heavily on shared memory to share stream data between processes and quickly and efficiently handle transformations between protocols and inputs. Windows and MacOS have a limited implementation in comparison and will take efficiency losses because of it.
Docker is a very close second as MistServer can run very efficiently in a dedicated environment thanks to Docker. The only reason it comes second is due to the slightly more complex setup in comparison to just running it on a server.
Choose your platform
- Linux
- Windows
- MacOS
- Docker
Linux specific instructions
MistServer as a system service
The easiest method to start with MistServer is to install it through the terminal. There's 2 requirements:
- You are running the script as root
curlis installed
Install using:
curl -o - https://releases.mistserver.org/is/mistserver_64Vlatest.tar.gz 2>/dev/null | sh
Uninstall using:
curl -o - https://releases.mistserver.org/uninstallscript.sh 2>/dev/null | sh
Your configurations will be stored within /etc/mistserver.conf.
From the binaries
Should you wish to run MistServer from a terminal download the latest binaries from https://r.mistserver.org/dl/mistserver_64Vlatest.tar.gz unpack the binaries and boot MistController.
Windows specific instructions
When running MistServer in Windows there's something to keep in mind. MistServer is an application that boots several other applications that in turn open listening ports. This is behaviour that defender/firewall applications will be unhappy with. To bypass Windows defender/firewall security it might be easier to opt for using MistServer in Docker Desktop.
Docker Desktop
Docker can run MistServer more efficient than the Windows version of MistServer as the Docker build can run the Linux version of the binaries. Apart from making sure you forward the ports you will also want to pay attention to setting a bigger size for shared memory through --shm-size. We recommend following the instructions at our Docker installation.
Installing MistServer
You can find the latest MistServer installer at https://r.mistserver.org/dl/mistserver_cyg64Vlatest.exe. The installer should help you install MistServer. Once installed you can boot MistServer through the MistServer Shell which is a compatibility layer for MistServer and Windows.
All MistServer files and configurations will be within the installation folder.
MacOS specific instructions
MacoS
Brew
Brew is a very popular way to add homebrew packages to your MacOS. You can use it to install MistServer through:
brew tap ddvtech/mistserver
brew install mistserver
Binaries
You can download MistServer as well, we've made the binaries compatible with both Intel and ARM based Macs, so there is only one download. You'll find them at https://r.mistserver.org/dl/mistserver_mach64Vlatest.zip. Afterwards run MistController to start MistServer.
Docker specific instructions
For detailed instructions, please visit our docker installation page
Docker run bare minimum sharing host network
docker run --shm-size=1G --network=host ddvtech/mistserver:latest
**Docker run bare minimum publishing ports
docker run --shm-size=1G -p 8080:8080 -p 4242:4242 -p 4200:4200 -p 5444:5444 -p 8889:8889/udp -p 18203:18203/udp -p 4433:4433 ddvtech/mistserver:latest