MiroFish GitHub

The MiroFish GitHub repository is the source to inspect before self-hosting.

The public repository is github.com/666ghj/MiroFish. Current public GitHub metadata shows roughly 59k+ stars, 9.2k+ forks, Python as the primary language, and an AGPL-3.0 license. Use those source signals to verify the project before installation.

Open GitHub repository Read self-hosting guide

What to check on GitHub

README: confirm the intended workflow, prerequisites, and supported deployment paths.
LICENSE: MiroFish uses AGPL-3.0, which matters for hosted or modified deployments.
docker-compose.yml: inspect services, ports, volumes, and model dependencies before running locally.
.env.example: review required provider keys, database settings, model endpoints, and runtime flags.
Open issues: scan installation, Docker, model-provider, and frontend/backend mismatch reports.
Recent commits: check whether setup guidance matches the current source tree.

Common setup questions

Can I run MiroFish with Docker Compose?

The repository includes Docker-related files, but you should read the current README and docker-compose.yml together. Confirm model-provider configuration and any backend service requirements before assuming a one-command production install.

Where is .env.example?

The repository includes `.env.example`. Use it as a checklist, not as a secret store. Put real API keys only in your local environment or deployment secret manager.

Is GitHub the official source?

For source code, yes: the public source reference is github.com/666ghj/MiroFish. For a hosted browser workflow, use the MiroFish online workspace on mirofish.best.

Online vs self-hosted

Use the online workspace when you want managed prediction runs and demo-style onboarding. Use GitHub when you need source review, private deployment planning, model-provider control, or license due diligence. The two paths serve different needs, and both should point back to the same MiroFish concept: multi-agent scenario simulation.