Skip to content

Launcher GUI Guide

The Mirumoji Launcher (mirumoji-gui) is the recommended way to install, configure, and manage your Mirumoji application. It provides a user-friendly graphical interface that handles all the complex setup steps for you.

Installation

Interface Tabs

This is the main control panel for your application.

Launcher Tab Screenshot

Controls
  • Start App: Starts the Mirumoji application using the settings from the Configuration tab.
  • Stop App: Stops the Mirumoji application.
  • Build Locally: Builds the necessary Docker images on your machine instead of downloading them. This is for more advanced use cases.
System Info
  • Shows the status of Docker and whether an NVIDIA GPU is detected. You can click the refresh button to re-check the status.
App Status
  • Indicates whether the main Mirumoji application is Running, Not Ready, or Unhealthy.

This tab allows you to configure all aspects of your Mirumoji installation before you start it.

Configuration Tab Screenshot

Image Repository

Choose whether to download the pre-built Docker images from GitHub or DockerHub.

OpenAI API Key (Required)

You must provide a valid OpenAI API key for the application's AI features to work.

Modal Tokens (CPU Only)

If you are running in CPU mode, you must provide your Modal Token ID and Secret. This is required for transcription tasks.

Use Local Docker Images

If toggled, the launcher will use images you built locally with the "Build Locally" button instead of pulling pre-built ones.

Clean Stop

If toggled, stopping the application will also remove all of its data (Docker volumes). This is useful for a fresh start.

Use NVIDIA GPU

If an NVIDIA GPU is detected on your system, this option will be available. Toggling it on will use the GPU-enabled backend for significantly faster AI performance.

Warning

The availability of the "Use NVIDIA GPU" option depends on whether an NVIDIA GPU is detected on your system and if the necessary drivers and NVIDIA Container Toolkit are installed. Refer to the Manual Setup Guide for more details.

This tab allows you to view the real-time logs from the running Mirumoji application, which is useful for monitoring its activity or debugging issues.

Logs Tab Screenshot

Start/Stop Streaming

Use these buttons to connect or disconnect from the log stream.

Tip

For advanced users who prefer the command line, see the Launcher CLI Reference