MMPM Environment Variables

Viewing and Editing Settings

• View Current Settings: Run mmpm env
• Edit Settings: Use mmpm open --env command or the Config Editor in the GUI.

Configuration File

• The settings are stored in ~/.config/mmpm/mmpm-env.json, allowing for immediate updates in the GUI without a restart.

Environment Variables

1. MMPM_MAGICMIRROR_ROOT:

   • Purpose: Path to MagicMirror installation root.
   • Example: /home/pi/MagicMirror.

2. MMPM_MAGICMIRROR_URI:

   • Purpose: URL of the MagicMirror host (same device as MMPM).
   • Example: http://192.168.0.15:8080.
   • Note: Avoid using http://localhost:8080.

3. MMPM_MAGICMIRROR_PM2_PROCESS_NAME:

   • Purpose: Name of the MagicMirror process in pm2.
   • Default: Leave blank if not using pm2.

4. MMPM_MAGICMIRROR_DOCKER_COMPOSE_FILE:

   • Purpose: Path to docker-compose.yml for Docker-managed MagicMirror.
   • Default: Leave blank if not using Docker with docker-compose.

5. MMPM_IS_DOCKER_IMAGE:

   • Purpose: Indicates if MMPM is run as a Docker/docker-compose image.
   • Options: true for Docker, false otherwise.
   • Note: If true, set MMPM_MAGICMIRROR_PM2_PROCESS_NAME and MMPM_MAGICMIRROR_DOCKER_COMPOSE_FILE to blank.

Example Configurations

• Example Configuration Using docker-compose for Managing MagicMirror

{
  "MMPM_MAGICMIRROR_ROOT": "/home/pi/MagicMirror",
  "MMPM_MAGICMIRROR_URI": "http://192.168.0.15:8080",
  "MMPM_MAGICMIRROR_PM2_PROCESS_NAME": "",
  "MMPM_MAGICMIRROR_DOCKER_COMPOSE_FILE": "/home/pi/docker/magicmirror/docker-compose.yml",
  "MMPM_IS_DOCKER_IMAGE": false
}

• Example Configuration Using PM2 for Managing MagicMirror

{
  "MMPM_MAGICMIRROR_ROOT": "/home/pi/MagicMirror",
  "MMPM_MAGICMIRROR_URI": "http://192.168.0.15:8080",
  "MMPM_MAGICMIRROR_PM2_PROCESS_NAME": "MagicMirror",
  "MMPM_MAGICMIRROR_DOCKER_COMPOSE_FILE": "",
  "MMPM_IS_DOCKER_IMAGE": false
}

• Example Configuration Using NPM for Managing MagicMirror

{
  "MMPM_MAGICMIRROR_ROOT": "/home/pi/MagicMirror",
  "MMPM_MAGICMIRROR_URI": "http://192.168.0.15:8080",
  "MMPM_MAGICMIRROR_PM2_PROCESS_NAME": "",
  "MMPM_MAGICMIRROR_DOCKER_COMPOSE_FILE": "",
  "MMPM_IS_DOCKER_IMAGE": false
}

• Example Configuration Using the MMPM Docker Image

{
  "MMPM_MAGICMIRROR_ROOT": "/home/pi/MagicMirror",
  "MMPM_MAGICMIRROR_URI": "http://192.168.0.15:8080",
  "MMPM_MAGICMIRROR_PM2_PROCESS_NAME": "",
  "MMPM_MAGICMIRROR_DOCKER_COMPOSE_FILE": "",
  "MMPM_IS_DOCKER_IMAGE": true
}