# MagicMirror

MagicMirror is an open source modular smart mirror platform. It is open source and self-hosted, installable on Docker Hub, Proxmox and Unraid.

Canonical page: https://ourlocalhost.com/app/757/magicmirror

## Description

MagicMirror² is an open source modular smart mirror platform. It turns a display behind a two-way mirror, a wall tablet or simply a browser tab into a personal dashboard showing clock, calendar, weather, news and hundreds of community modules. For homelab users, it runs in server-only mode where the interface is served over HTTP and rendered in any browser or on a separate client device such as a Raspberry Pi, the correct fit for a headless Unraid server where the Electron scenario for a locally attached display cannot run.

## Platform availability

Available on 3 of 10 platforms: Unraid, Proxmox, Helm.

## Health score

74/100 (Good), based on 5 of 5 factors.
- Maintained: 73 (last commit 51 days ago)
- Popular: 88 (24,162 GitHub stars)
- Easy to install: 55 (3 install platforms, install notes, Docker image)
- Light to run: 60 (2 GB minimum RAM, runs on ARM)
- Security check: 88 (no serious findings, 2 minor, CI, tests)

## Links

- Docker Hub: https://hub.docker.com/r/karsten13/magicmirror
- Documentation: https://docs.magicmirror.builders
- Proxmox: https://community-scripts.github.io/ProxmoxVE/scripts?id=magicmirror
- GitHub: https://github.com/MagicMirrorOrg/MagicMirror
- Unraid: https://ca.unraid.net/apps/magicmirror-1gtyx690vej7fx?q=MagicMirror
- Official website: https://khassel.gitlab.io/magicmirror/

## Common questions

### How can I run MagicMirror so I can view it in a browser on another device?

Use the server scenario; it starts the server and lets you open the application in your browser of choice.

### How can I avoid losing my module setup if the config file is overwritten?

Keep a copy of the JavaScript config file, or use the MM_CONFIG_FILE setting to point at another file.

### What should I run before the first launch if MagicMirror fails to start because required software is missing?

Run node --run install-mm inside your MagicMirror folder before the first launch; this downloads the required software and can take a long time.

### Which start command should I use on a Linux system that uses X11 instead of Wayland?

Use node --run start:x11 so the window appears on the right screen.

### How can I display MagicMirror on a Raspberry Pi screen when another instance is already running?

Use the client scenario, which starts MagicMirror on the Raspberry Pi screen using another running MagicMirror instance.

---
Source: Our Local Host (https://ourlocalhost.com/app/757/magicmirror), the self-hosted and open-source app directory.
