Skip to content

Latest commit

 

History

History
54 lines (40 loc) · 2.95 KB

README.md

File metadata and controls

54 lines (40 loc) · 2.95 KB

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.

DockerHub Badge

Why Docker? Build Status

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 and respective Dockerfile links

  • latest - Latest MagicMirror² server (Dockerfile)
  • raspberry - ARM based version to work with a Raspberry Pi (Dockerfile)

The respective docker images are getting updated daily by a cron job from Travis CI.

Run MagicMirror² in server only mode

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

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 \
	bastilimbach/docker-magicmirror

Volumes

Volume Description
/opt/magic_mirror/config Mount this folder to insert your own config into the docker container.
/opt/magic_mirror/modules Mount this folder to add your own custom modules into the docker container.
/opt/magic_mirror/css/custom.css Mount this file to add your own custom css into the docker container.

Important: You need to create the file before you run the container. Otherwise Docker will create a custom.css folder.

Config

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

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

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

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 ❤️