Installation & Usage

The MagicMirror² can be installed manually or using automatic installers. At the start of 2020 the decision was made to remove the automatic installer from the MagicMirror² core repository and move it to a community maintained separate repository. For more information about this decision, please check issue #1860 on GitHub.

Therefore the only officially supported way of installation is by using a manual installation. Using external installation scripts is at your own risk but can make the process a lot easier. Available automatic installers can be found under: alternative installation methods.

Manual Installation

These instructions deploy a standalone version of MagicMirror², for Server Only and Client Only installs please read the install specific instructions below

1. Download and install a required Node.js version, see the official documentation:
   • Linux based distributions
   • Others
2. Check if git is installed on your machine by executing git (should show usage), otherwise install it
3. Clone the repository: git clone https://github.com/MagicMirrorOrg/MagicMirror
4. Enter the repository: cd MagicMirror
5. Install the application: node --run install-mm
6. Make a copy of the config sample file: cp config/config.js.sample config/config.js
7. Start the application: node --run start

Alternative Installation Methods

The following installation methods are not maintained by the MagicMirror² core team. Use these scripts and methods at your own risk.

Automatic Installation Scripts

• Sam (@sdetweil, long time contributor of the MagicMirror² framework) maintains an easy-to-use installation and update script: https://github.com/sdetweil/MagicMirror_scripts
• The MagicMirror Package Manager is a command line interface designed to simplify the installation, removal, and maintenance of MagicMirror modules.

Docker Image

• MagicMirror² can be deployed using Docker. Head over to this repository for more information.

Kubernetes Helm Chart

• If you want to run MagicMirror² (in server only mode) in a kubernetes cluster then take a look at this MagicMirror Helm Chart.

MagicMirrorOS

• This is a full OS based on Raspberry Pi OS. So instead of downloading Raspberry Pi OS and putting this on your sd card, you can use MagicMirrorOS instead. It runs out of the box with a default setup of MagicMirror, under the hood it uses the docker setup.

NPM

• We also publish the latest version of MagicMirror to the npm-registry.

Usage

Note the following:

• If you want to debug on your Raspberry Pi you can use node --run start:dev which will start MM with Dev Tools enabled.
• To access the toolbar menu when in mirror mode, hit ALT key.
• To toggle the (web) Developer Tools from mirror mode, use CTRL-SHIFT-I or ALT and select View.

Server Only

In some cases, you want to start the application without an actual app window. To do so after installation you can start MagicMirror² in server only mode by manually running the following command within the MagicMirror directory node --run server

In order to run MagicMirror² in server mode you need to:

• Allow Remote Connections to MagicMirror²
• Start MagicMirror² in Server mode on boot

Allow Remote Connections to MagicMirror²

By default MagicMirror² does not allow other remote devices to connect, this is controlled by settings inside the config/config.js file by interface and ip:

• Change address to 0.0.0.0 this will allow MagicMirror² to listen on all network interfaces
• Change ipWhitelist to the list of IP's you want to allow to connect

Sample Configuration below and link to full configuration options

let config = {
	address: "0.0.0.0",	// default is "localhost"
	port: 8080,		// default
	ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1", "::ffff:172.17.0.1"], // default -- need to add your IP here
	...
};

Client Only

This is when you already have a server running remotely and want your RPi to connect as a standalone client to this instance, to show the MagicMirror² from the server.

You can start MagicMirror² in client mode by manually running the following command with the MagicMirror directory: node clientonly --address 192.168.1.5 --port 8080

Wayland

If you use Wayland. Run node --run start:wayland instead of node --run start to start.

Windows

In Windows you must use node --run start:windows instead of node --run start.