Skip to content

Installation

To get started with MiruSuite, head to Downloads and download the latest version for your OS.

Windows (x64)

Prerequisites

MiruSuite requires working graphics drivers for your NVIDIA GPU. Make sure to install the latest drivers from the NVIDIA website.

A simple way to check if your drivers are working correctly is by opening a terminal (cmd.exe) and running the following command:

shell
nvidia-smi

If the command returns an error, please reinstall your NVIDIA drivers.

Installation

You will receive a ZIP file with MiruSuite and all required dependencies. No installation necessary.

  1. Unzip the file and move the complete folder to a location of your choice. (You can later add a shortcut to your desktop or start menu if you like.)
  2. Run MiruSuite.exe (double click)

WARNING

While MiruSuite is still becoming more popular, you might get a warning that the software is from an unsigned developer similar to the following. You can ignore this warning and run the software. Make sure that you only download MiruSuite from a trusted source (*.mirusuite.com, *.mirusuite.de), and never from any other site. Windows SmartScreen warning

  1. If you get a prompt from Windows Firewall, make sure to allow network traffic for private and public networks. Windows Firewall
  2. Wait until you see MiruSuite is running. If instead the launcher shows a warning that the current port is blocked, see Changing the ports.
  3. As soon as MiruSuite has booted up, you can open the web UI using the Launch GUI button or manually connect to https://localhost:8443/ in your browser. We recommend using Google Chrome for the best experience.

WARNING

Due to browser restrictions, the web UI uses a self-signed certificate. You will get a warning that the connection is not secure. You can ignore this warning (a connection to localhost is always secure!) and proceed to the website. More information

  1. MiruSuite will ask you for your license key (or license file). If you're starting MiruSuite for the first time, you will automatically receive a free trial license valid for 14 days.

macOS (Apple Silicon)

You will receive a disk image (.dmg file).

  1. After downloading, open the dmg file. You should see something like this: Opened macOS disk image Drag and drop MiruSuite to your Applications folder. Replace if prompted. MiruSuite is now installed.
  2. Run MiruSuite (via your Launchpad or Spotlight). Make sure to give MiruSuite permissions for camera, file, and microphone access when prompted.
  3. Wait until you see MiruSuite is running (see the image below). If instead the launcher shows a warning that the current port is blocked, see Changing the ports. MiruSuite Launcher on macOS
  4. As soon as MiruSuite has booted up, you can open the web UI using the Launch GUI button or manually connect to https://localhost:8443/ in your browser. We recommend using Google Chrome for the best experience.

WARNING

Due to browser restrictions, the web UI uses a self-signed certificate. You will get a warning that the connection is not secure. You can ignore this warning (a connection to localhost is always secure!) and proceed to the website. More information

  1. MiruSuite will ask you for your license key (or license file). If you're starting MiruSuite for the first time, you will automatically receive a free trial license valid for 14 days.

WARNING

We recommend disabling automatic display sleep in the system settings, as this can cause macOS to pause the webcam feeds.

Changing the ports

If MiruSuite warns that the selected port is blocked (for example because another application is already using it), you can change the ports in the launcher:

  1. Open the MiruSuite launcher application. MiruSuite Launcher on macOS
  2. Click the Settings icon (cog) in the top right.
  3. Change the ports individually for HTTP and HTTPS.
  4. Save/apply the settings and confirm to restart the MiruSuite server automatically.

When you change the HTTPS port, the web UI address changes accordingly (for example https://localhost:<your-https-port>/).