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:
๐ง Linux/Mac Users
Run this script from your project root:
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
- Visit the platform: http://localhost:8080
- Admin panel: http://localhost:8080/admin
๐งน Cleaning Up (Optional)
Deep Clean (Use with Caution)
If setup fails and doesn't work, you can do a full docker reset with:
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.