https://github.com/sdetweil/MagicMirror_scripts

Magic Mirror installation and setup scripts
https://github.com/sdetweil/MagicMirror_scripts

Last synced: 10 days ago
JSON representation

Magic Mirror installation and setup scripts

• Host: GitHub
• URL: https://github.com/sdetweil/MagicMirror_scripts
• Owner: sdetweil
• Created: 2020-01-05T04:41:09.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-29T17:33:17.000Z (15 days ago)
• Last Synced: 2024-10-29T18:56:41.222Z (15 days ago)
• Language: Shell
• Size: 244 KB
• Stars: 366
• Watchers: 22
• Forks: 64
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# MagicMirror² installation and setup scripts

These scripts can be used to automate installation and release upgrades.

## Install MagicMirror²

`raspberry.sh` is the installation script, upgraded from the core package.

To execute the install script, copy/paste this line into the terminal window on your device (I can't say PI, cause it works in a lot of other places too).

```bash

bash -c  "$(curl -sL https://raw.githubusercontent.com/sdetweil/MagicMirror_scripts/master/raspberry.sh)"

```

There is a log file, ~/install.log, created so we can be able to diagnose any problems.

## Upgrade to next MagicMirror version from an existing installation

A new MagicMirror version is released once every 90 days (Jan 1, Apr 1, July 1, Oct 1).

`upgrade-script.sh` will do the `git pull` and `npm install`, and refresh npm setup for any modules that might need it.

The script should handle all the work…

and give you a trial run of all that, only applying changes if you request them.

Give it a try!

This works on Mac as well, copy/paste the following line into the terminal window on your device:

```bash

bash -c  "$(curl -sL https://raw.githubusercontent.com/sdetweil/MagicMirror_scripts/master/upgrade-script.sh)"

```

No changes are made to the local repo or the working copy.

If you WANT to actually apply the changes, copy/paste this line into the terminal window on your device:

```bash

bash -c  "$(curl -sL https://raw.githubusercontent.com/sdetweil/MagicMirror_scripts/master/upgrade-script.sh)" apply

```

There is a log file (`upgrade.log`)  in the `MagicMirror/installers` folder.

## Additional scripts that may be useful

The install has two sections of additional support.

I have provided those separately here too, in case you need to run one separately, or changed your mind after install.

### Turn off screen saver 

`screensaveroff.sh`, copy/paste this line into the terminal window on your device:

```bash

bash -c "$(curl -sL https://raw.githubusercontent.com/sdetweil/MagicMirror_scripts/master/screensaveroff.sh)"

```

### Add using pm2 to autostart MagicMirror at bootup

`fixuppm2.sh`, copy/paste this line into the terminal window on your device:

```bash

bash -c "$(curl -sL https://raw.githubusercontent.com/sdetweil/MagicMirror_scripts/master/fixuppm2.sh)"

```

## Switch to the Midori or firefox or surf browser

Especially low powered devices like the Pi Zero W might struggle running MagicMirror with the Chromium browser. A simpler browser like Midori, Firefox, or Surf might be a good alternative in this case. To switch to using the Midori  browser, change the `MagicMirror/installers/mm.sh` file to include the `external_browser` variable like this:

```bash

cd ~/MagicMirror

export external_browser=midori

DISPLAY=:0 npm start

```

To switch to using the Firefox browser change the `MagicMirror/installers/mm.sh` file to include the `external_browser` like this:

```bash

cd ~/MagicMirror

export external_browser=firefox

DISPLAY=:0 npm start

```

To switch to using the Surf browser change the `MagicMirror/installers/mm.sh` file to include the `external_browser` like this:

```bash

cd ~/MagicMirror

export external_browser=surf

DISPLAY=:0 npm start

```