Skip to content

Installation

Jump to bottom
Ezequiel Holzweissig edited this page Nov 18, 2020 · 3 revisions

Installation

The installation of this module depends on how you installed the MagicMirror project. You can use the automatic installer that comes with the Remote Control, or you can also install it manually. We'll show you both in case the automatic one doesn't fill your needs.

Automatic Installation

You can use the script that we have in the repository, and running it inside your MagicMirror install folder. This will install and configure the module.

bash -c "$(curl -s https://raw.githubusercontent.com/Jopyth/MMM-Remote-Control/master/installer.sh)"

Manual Installation

Download with git

  1. Clone this repository in your modules folder, and install dependencies
cd ~/MagicMirror/modules # adapt directory if you are using a different one
git clone https://github.com/Jopyth/MMM-Remote-Control.git
cd MMM-Remote-Control
npm install
  1. Add the module to your config/config.js file. To understand how to configure your Remote Control, you can go to Configuration wiki page
{
    module: 'MMM-Remote-Control',
    position: 'bottom_left',
    config: {}
},
  1. For security reasons, the MagicMirror (and therefore the Remote Control) is not reachable externally. To change this, configure address, and ipWhitelist in your config.js (see configuration of your MM). For example you could add two allowed devices with IP-Adresses 192.168.0.42 and 192.168.0.50:
    address : '0.0.0.0',
    port: 8080,
    ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1", "::ffff:192.168.0.42", "::ffff:192.168.0.50"],"

You can also add multiple devices in an IP range (e.g. all devices with 192.168.0.X):

    ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1", "::ffff:192.168.0.1/120", "192.168.0.1/24"],

Use this link to understand how to configure your MM IP, and not allow everyone in your network to use it.

  1. Restart your Magic Mirror² (i.e. pm2 restart MagicMirror).

Download the source code

This isn't the best way to get the repository, but it's the most compatible and most reliable.

  1. Go to the latest release and download the source code.
  2. Extract the folder inside your modules folder
  3. Install the dependencies and follow the steps above to configure it inside config.js file
Clone this wiki locally