Skip to content

Platform Setup Guide

This guide helps you run the MIRROR platform on your local machine using preconfigured Docker scripts.


๐Ÿ–ฅ๏ธ Windows Users

Run the following script in a terminal:

./setup_nocache.bat

๐Ÿง Linux/Mac Users

Run this script from your project root:

./setup_nocache.sh

What These Scripts Do

  • They build and start all required Docker containers (app, DB, NGINX)
  • They also run preconfigured data ingestion commands. You can edit these ingestion commands inside setup_nocache.bat or setup_nocache.sh to ingest your own data before setup.
  • You can refer to data ingestion page to know more about individual commands for data ingestion.

๐ŸŒ Web Access Once setup is complete

Demo Login Credentials

Username: Admin
Password: GileandG1mbal

๐Ÿงน Cleaning Up (Optional)

Deep Clean (Use with Caution)

If setup fails and doesn't work, you can do a full docker reset with:

./deep_clean.bat         :: Windows
./deep_clean.sh          # Linux/macOS

This will remove all Docker existing MIRROR containers, volumes, images, and cache. - Only run this if you're completely stuck or want a clean slate - This will delete all data and reset everything

Want to ingest your own data during setup?

  • Open setup_nocache.sh or setup_nocache.bat
  • Replace or append your own ingestion commands near the bottom of the script.
  • Please refer to Data Ingestion page for supported file types and commands.