Skip to content

Setup Guide

This guide will help you get the Mirumoji application running on your system.

System Prerequisites

The launcher uses Git to fetch the application files. Download Git.

Mirumoji runs using Docker containers. Docker Desktop provides the necessary Docker engine and command-line tools.

Security Considerations

Security Considerations

Since this is a bundled application program, it's common to have securities concerns regarding what exactly it is executing. This has been bundled as an executable mainly for the sake of convenience, so that you don't have to manually find which docker-compose file is suitable for the version you want to run, look up docker build and compose commands, etc.

MacOS

On newer macOS versions, you might see a security warning the first time you run the launcher because it's a downloaded application. You may need to go to "System Settings" > "Privacy & Security", scroll down, and click "Open Anyway" or allow the app.

The executables for the various OSes are created in a GitHub Actions Runner with PyInstaller and the code used to create them can be found in this repository at .github/workflows/build_release.yaml. All the executable does is execute the launcher.py file, like the Python Package Option, with the added convenience that you don't need to have python, or the python dependencies the script needs, installed in order to run it.

On the first time access on any device, the browser will display a security warning because the HTTPS certificate is self-signed. This presents very little risk since the application runs entirely inside your system and is only available inside your local network. To learn more about this you can follow the link provided on self-signed.

Setup Options

1 - Download the CLI Launcher

macOS and Linux
  1. Open your terminal.
  2. Navigate to the directory where you saved the launcher.
  3. Make the file executable: 
    chmod +x mirumoji-launcher-linux

2 - Run the Launcher

  1. Open Command Prompt or PowerShell.
  2. Navigate to the directory where you saved mirumoji-launcher-windows.exe.
  3. Run the launcher by typing: 
    .\mirumoji-launcher-windows.exe gui
  1. In the Terminal (after making it executable) 
    ./mirumoji-launcher-macos gui
  1. In your terminal (after making it executable): 
    ./mirumoji-launcher-linux gui

3 - Start Through GUI

If you have any doubts about the GUI you can check the Launcher GUI Guide

1 - Install

Install the mirumoji python package

pip install mirumoji

2 - Run the GUI

In the same python environment you installed the mirumoji package run

mirumoji-gui

Accessing the Application

Once the containers are running the application will be live in your localhost over HTTPS.

You can access it from any device inside your local network by accessing your computer's local IPv4 address over HTTPS.

Manual Setup

Please refer to the Manual Setup Page

If you encounter any issues, please feel free to open an issue.