xbgmsharp/docker-magicmirror repository overview

⁠Docker MagicMirror²

This multi architecture Alpine Linux based Docker image allows you to run MagicMirror²: The open source modular smart mirror platform.⁠

MagicMirror² is an open source modular smart mirror platform. With a growing list of installable modules, the MagicMirror² allows you to convert your hallway or bathroom mirror into your personal assistant.

⁠Why Docker?

In some cases, you want to start the application without an actual app window. In this case, you can start MagicMirror² in server only mode by manually running node serveronly or using Docker. This will start the server, after which you can open the application in your browser of choice.

⁠Supported tags:

• latest - Latest MagicMirror² server (Dockerfile⁠)

⁠Supported architectures: (more info⁠)

amd64, arm32v6, arm32v7, arm64v8, i386

If you compiled for other architectures and know other combinations, let me know!

⁠Run MagicMirror² in server only mode

After a successful Docker installation⁠ you just need to execute the following command in the shell:

docker pull xbgmsharp/docker-magicmirror
docker run  -d \
	--publish 80:8080 \
	--restart always \
	--volume ~/magic_mirror/config:/opt/magic_mirror/config \
	--volume ~/magic_mirror/modules:/opt/magic_mirror/modules \
	--name magic_mirror \
	xbgmsharp/docker-magicmirror

⁠Parameters

Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

⁠Config

You need to configure your MagicMirror² config to listen on all interface and allow every ip address.

var config = {
    address: "0.0.0.0",
    port: 8080,
    ipWhitelist: []
}

if (typeof module !== "undefined") { module.exports = config; }

⁠Updating Info

Most of our images are static, versioned, and require an image update and container recreation to update the app inside.

Below are the instructions for updating containers:

⁠Via Docker Run/Create

• Update the image: docker pull xbgmsharp/docker-magicmirror
• Stop the running container: docker stop magicmirror
• Delete the container: docker rm magicmirror
• Recreate a new container with the same docker create parameters as instructed above (if mapped correctly to a host folder, your config and modules folder with settings will be preserved)
• Start the new container: docker start magicmirror
• You can also remove the old dangling images: docker image prune

docker pull xbgmsharp/docker-magicmirror
docker stop magic_mirror
docker rm magic_mirror
docker create \
  -e PUID=1000 \
  -e PGID=100 \
  -e TZ=Europe/Paris \
  --restart unless-stopped \
  --publish 8181:8080 \
  --volume ~/magic_mirror/config:/opt/magic_mirror/config \
  --volume ~/magic_mirror/modules:/opt/magic_mirror/modules \
  --volume ~/magic_mirror/css:/opt/magic_mirror/css \
  --name magic_mirror xbgmsharp/docker-magicmirror
docker start magic_mirror

⁠Contribution

I'm happy to accept Pull Requests! Please note that this project is released with a Contributor Code of Conduct⁠. By participating in this project you agree to abide by its terms.

⁠License

MIT⁠ ❤️