Getting Started
Getting started with Miru
Introduction
Miru is a free, open-source and fully customisable status page and monitoring service built with Rust and Next.js. It was built to provide a simple and easy way to monitor your services like websites, APIs, dependency sites, and more.
Miru is designed to be local-first, meaning it can be run entirely on your own server in just a few minutes.
Installation
There are multiple ways you can install and setup your own Miru instance. The cards below rank the installation methods from easiest to hardest.
Configuration
Please find a list of all the environment variables that can be set in the .env file to configure your Miru instance.
Warning
If any values inside the .env file do not match their type, you may
experience errors or even crashes.
| Prop | Type | Default |
|---|---|---|
DATABASE_URL | string | - |
DATABASE_SSL? | 'true' | 'false' | 'false' |
BETTER_AUTH_SECRET | string | - |
APP_DOMAIN | string | 'localhost' |
MONITOR_URL | string | 'http://localhost:8080' |
EMAIL_VERIFICATION? | 'true' | 'false' | 'true' |
ENABLE_EMAIL? | 'true' | 'false' | 'true' |
SMTP_HOST? | string | - |
SMTP_PORT? | '465' | '587' | - |
SMTP_SECURE? | 'true' | 'false' | - |
SMTP_USER? | string | - |
SMTP_PASSWORD? | string | - |
SMTP_FROM? | string | - |
Support us
Miru is an open-source project and is maintained by a small team of developers at Nord Studio. If you like Miru and want to support us, please consider the actions below:
Star us!
Give the repo a star to show your support!
Sponsor us!
Sponsor us on GitHub to help us keep the lights on.
Need Help?
If you have any questions or need help with Miru, feel free to reach out to us on Discord or via GitHub Discussions.