We will be using Docker software to make running a Minima node simple.
Once your node is set up, you will be able to use Minima's decentralized applications.
What is Docker?
Docker is an open-source software platform that simplifies the process of running, testing and managing applications. It uses the operating system of the computer on which it’s installed to provide an independent computing environment for an application to run on.
Start a new Minima node
Remove existing nodes
Before starting, stop any existing nodes you started manually by typing
quit into the Terminal where the Minima logs are running.
Start a new Minima node using Docker
- Download and run the Docker installer from here. Please check your system requirements.
- Once installed, open Docker
- Click on the settings icon, and select Start Docker Desktop when you log in
- Click Apply & Restart
- Open the Linux Terminal
- Copy and paste the following into the Terminal
SET YOUR PASSWORD
Make sure to change the password below from
123 to a secure password using lowercase letters and numbers only of your choice. This will be the password to access your Minidapp Hub.
docker run -d -e minima_mdspassword=123 -e minima_desktop=true -v ~/minimadocker9001:/home/minima/data -p 9001-9004:9001-9004 --restart unless-stopped --name minima9001 minimaglobal/minima:latest
- Press the Enter key to run the command and start your node.
What do all the parameters mean?
-d: daemon mode, Minima will run in the background
-e minima_mdspassword=123: sets the password for your MiniDapp system to 123. YOU MUST USE A SECURE PASSWORD USING LOWERCASE LETTERS AND NUMBERS ONLY
-e minima_desktop = true: sets your node type as a desktop node that does not receive incoming connections
-v ~/minimadocker9001:/home/minima/data: creates a local folder called minimadocker9001 in your home directory and maps it to the /home/minima/data directory in Docker. The minimadocker9001 folder is where the Minima database and is also where your backups will be stored.
-p 9001-9004:9001-9004: the port number mapping from your desktop to the Docker container
--restart unless-stopped: ensures your container automatically restarts unless you stop it
--name minima9001: sets the name of your Minima container to minima9001
minimaglobal/minima:latest: specifies where to pull the Minima code from
- You will notice a container in Docker called minima9001, this is running your Minima node.
- Click on minima9001 to check the logs and ensure your node has started up
Congratulations - your node is now installed & running!
To ensure your node updates automatically when a new version of Minima is released, continue to start a Watchtower container.
Automate updates with Watchtower
What is a Watchtower container?
Once set up, a Watchtower container enables automatic updates of your Minima node when a new version is released. It will pull down the latest Minima version and restart with the same parameters you initially specified.
Create the Watchtower container by pasting the following command into the Linux Terminal.
docker run -d --restart unless-stopped --name watchtower -e WATCHTOWER_CLEANUP=true -e WATCHTOWER_TIMEOUT=60s -e WATCHTOWER_POLL_INTERVAL=28800 -v /var/run/docker.sock:/var/run/docker.sock containrrr/watchtower
Press the Enter key to run the command and start the Watchtower.
You will see the Watchtower in Docker.
Every 8 hours, the Watchtower will check whether there is a new version of Minima and will update if so.
Continue to access your MiniDapp hub and setup your Incentive Program account to start earning Rewards.
Access your MiniDapp hub
The first time accessing your MiniDapp hub, you may need to pass through the security warning - see below - as the MiniDapp system currently uses self-signed certificates.
- Go to https://127.0.0.1:9003/ in your web browser
Click on Advanced, then Proceed. Or in Google Chrome, you may have to click anywhere on the page and type
thisisunsafe to proceed. Details for other browsers can be found here.
You will see your MiniDapp System (MDS) login page.
Enter your password to login, if you don't remember, you can check here.
You will see your MiniDapp hub!
Set up your Incentive Program account
If you have registered for the Incentive Program you must connect your Incentive ID to your node to start receiving daily Rewards.
If you have not registered, click here to sign up.
- Open the Incentive Program minidapp
Follow the instructions to login to the Incentive Program website and copy your Incentive ID
Paste your Incentive ID into the field provided and click Update
- Check the Rewards page to check your balance!
How to check your Minima hub password
You can use the Docker CLI/Terminal to interact with your node, for example to check your status, balance, password, incentive program setup or to create a backup.
- From the Containers screen, click on minima9001 to view the logs
- Click on CLI or Terminal (depending on the version)
minimaand press Enter, you will see the Minima Terminal appear
Other useful commands:
status - see the status of your node
incentivecash - check your Incentive Program balance
incentivecash uid: - setup your Incentive Program account by connecting your Incentive ID
help - show all commands
How to start a second node in Docker
To run a second node in Docker, you can create another container using different port numbers, file path and name.
- To create a node on port 8001:
docker run -d -e minima_mdspassword=123 -e minima_desktop=true -v ~/minimadocker8001:/home/minima/data -p 8001-8004:9001-9004 --restart unless-stopped --name minima8001 minimaglobal/minima:latest
- To access your MiniDapps on the second node, go to https://127.0.0.1:8003/ (8003 instead of 9003) and repeat the steps in Access your MiniDapp hub.
How to start a test node as a developer
To create a private test node from Genesis, use the following start up command:
docker run -d -e minima_mdspassword=123 -e minima_desktop=true -e minima_genesis=true -e minima_test=true -e minima_nop2p=true -v ~/minimadocker10001_dev:/home/minima/data -p 10001-10004:9001-9004 --restart unless-stopped --name minima10001_dev minimaglobal/minima:latest
The additional test parameters used are:
-e minima_genesis=true : Start a node from the Genesis block
-e minima_test=true : Use test parameters e.g. blocks are automined and block times are faster
-e minima_nop2p=true : Do not start the p2p system
To enable RPC, use
How to take a backup of your node
- Login to your Minima Hub
- Open the Terminal MiniDapp
- Enter the
backupcommand with a password containing lowercase letters and numbers only
To create automatic backups every 24 hours (currently NOT password protected)
Your backups will go to the minimadocker9001 folder in your home directory.
password: set a password for your backup lowercase letters and numbers only, this will be required when restoring it
file: (optional) backup name
auto: (optional) true or false. Will set the backup to repeat every 24 hours.
complete: (optional) true or false. A complete backup includes the Archive database. Please allow more time for a complete backup to finish.
How to restore your node from a backup
Your backup must be in the minimadocker9001 folder in your home directory (as specified at start up).
- Login to your Minima Hub
- Open the Terminal MiniDapp
- Enter the
restorecommand, completing the parameters
restore file: password:
file: the name of the backup to restore.
password: (optional) the password of the backup. Can be left blank if restoring an auto backup or non password protected backup.
If successful, you will need to log out/log in from your Minima hub for the restore to take effect.
How to remove a node
Removing a node without taking a backup will delete all your coins! Only remove a node if you have taken a backup or are running a test node.
To remove a Docker node:
- Open Docker
- Stop the minima9001 container
- Delete the container
This will not remove the minimadocker9001 folder from your home directory, so if you subsequently create a new container with the same name, the same folder will be reused.
To start a clean node (and lose your balance) you must provide a new name for the folder in the start up command or delete this folder from your Home directory.
Once your node running, learn about MiniDapps and start testing!
Stay up to date
Check out our MiniDapp store to stay up to date with the latest MiniDapps.
Thank you for participating and contributing to our Testnet.