Documentation

Quick Start

Android

The simplest way is to install and run the Android app.

Note

If you cannot use the Google Playstore, you can download a signed APK from Github.

Desktop

Desktop users can launch Minima from a JNLP file. The Java Network Launch Protocol.

Install Open Web Start

First, download and install Open Web Start.

Download the Minima JNLP file

Download the Minima JNLP file and open / double-click it to install Minima as an application. A desktop shortcut will be created for you and you will be shown a security warning, select Run.

To ensure that Minima is always launched with Open Web Start, you may need to right-click > open with... and choose Open Web Start. If possible, choose "always".

Mac & Windows

Further guidance can be found here for Mac and here for Windows.

CLI

At it's core, Minima is a Java application. So on a server or CLI the easiest way to run Minima is to install Java and download the latest minima.jar.

Note

You can download the latest version of Minima from the Minima GitHub releases page.

To run Minima, you need to have Java installed on your system. You can check if you have Java installed by running the following command in your terminal:

Terminal
java -version

Note

If you don't have Java installed, you can download it from the Java website.

Navigate to the directory where you saved the Minima jar

Terminal
cd /path/to/minima.jar

Run Minima

Adding -mdsenable -mdspassword INSERTPASSWORD will enable the minidapp system.

Adding -p2pnodes megammr.minima.global:9001 will automatically connect you to the peer-to-peer network.

Terminal
    java -jar minima.jar -data .minima -mdsenable -mdspassword INSERTPASSWORD

Tip

When you first run Minima the first thing you need is to add some connections.

You can get this list by asking any user on the network to share their connections or by running

peers action:addpeers peerslist:megammr.minima.global:9001

Alternatively, copy this link directly into the app when prompted to join the network (also in Settings > 'Add connections')

https://spartacusrex.com/minimapeers.txt

Docker

Start a new docker container

There is also a nice docker image that you can use if you have Docker installed. Set a secure password below.

Terminal
docker run -d -e minima_mdspassword=INSERTYOURPASSWORD -e minima_desktop=true -v ~/minimadocker:/home/minima/data -p 9001-9003:9001-9003 --restart unless-stopped --name minima minimaglobal/minima:latest

Log into your node

Then you log into your node via https://127.0.0.1:9003/

Further guidance on starting a node in Docker desktop can be found here

Next Steps

On this page