Skip to content
motionEye - Community Hass.io Add-on for Home Assistant
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github 🚀 Updates forum links Oct 6, 2018
images 📚 Adds basic documentation files Oct 5, 2018
motioneye
.editorconfig Adds repo basics Oct 5, 2018
.gitignore
.gitlab-ci.yml ⬆️ Upgrades add-on base image to 2.3.2 Mar 7, 2019
.mdlrc
.yamllint
CODE_OF_CONDUCT.md 📚 Adds basic documentation files Oct 5, 2018
CONTRIBUTING.md
LICENSE.md 🎆 Updates maintenance year to 2019 Jan 9, 2019
README.md
renovate.json Configure Renovate (#16) Jan 9, 2019

README.md

Community Hass.io Add-ons: motionEye

GitHub Release Project Stage License

GitLab CI Project Maintenance GitHub Activity

Discord Community Forum

Buy me a coffee

Support my work on Patreon

motionEye screenshot

Simple, elegant and feature-rich CCTV/NVR for your cameras.

About

motionEye is a popular frontend to the camera software called motion. This add-on provides both, allowing you to add your camera's to your Hass.io setup.

motionEye is Open Source CCTV and NVR, that is elegant and really easy to use. It can be used as a Baby Monitor, Construction Site Montage Viewer, Store Camera DVR, Garden Security, and much more.

Some cool features of motionEye:

  • Support for a ridiculous amount of cameras, including IP cams.
  • Add multiple cameras by hooking up multiple motionEye instances together. For example, by using MotionEyeOS on a Pi Zero + Pi camera in your network.
  • Supports uploading recording into Google Drive and Dropbox.
  • motion detection, including email notification and scheduling.
  • Can record continuously, motion, or timelapse, with retention settings.

Installation

The installation of this add-on is pretty straightforward and not different in comparison to installing any other Hass.io add-on.

  1. Add our Hass.io add-ons repository to your Hass.io instance.
  2. Install the "motionEye" add-on.
  3. Start the "motionEye" add-on
  4. Check the logs of the "motionEye" add-on to see if everything went well.
  5. Click the "OPEN WEB UI" button to open the web interface
  6. Login with username "admin", without a password.
  7. Edit your admin account with a secure password!

NOTE: Do not add this repository to Hass.io, please use: https://github.com/hassio-addons/repository.

Docker status

Supports armhf Architecture Supports aarch64 Architecture Supports amd64 Architecture Supports i386 Architecture

Docker Layers Docker Pulls

Configuration

Note: Remember to restart the add-on when the configuration is changed.

Example add-on configuration:

{
  "log_level": "info",
  "port": 1234,
  "ssl": true,
  "certfile": "mycertfile.pem",
  "keyfile": "mykeyfile.pem"
}

Note: This is just an example, don't copy and paste it! Create your own!

Option: log_level

The log_level option controls the level of log output by the addon and can be changed to be more or less verbose, which might be useful when you are dealing with an unknown issue. Possible values are:

  • trace: Show every detail, like all called internal functions.
  • debug: Shows detailed debug information.
  • info: Normal (usually) interesting events.
  • warning: Exceptional occurrences that are not errors.
  • error: Runtime errors that do not require immediate action.
  • fatal: Something went terribly wrong. Add-on becomes unusable.

Please note that each level automatically includes log messages from a more severe level, e.g., debug also shows info messages. By default, the log_level is set to info, which is the recommended setting unless you are troubleshooting.

Option: motion_webcontrol

Enables the motion webcontrol endpoint running on port 7999.

⚠️ MotionEye HTTP webcontrol DOES NOT support authentication and DOES NOT support SSL! Enable this ONLY when you know what you are doing! NEVER, EVER expose this port to the outside world!

Option: port

By default motionEye runs on port 8765, this option allows you to change the port number.

Option: ssl

Enables/Disables SSL (HTTPS) on the web interface of motionEye. Set it true to enable it, false otherwise.

Option: certfile

The certificate file to use for SSL.

Note: The file MUST be stored in /ssl/, which is the default for Hass.io

Option: keyfile

The private key file to use for SSL.

Note: The file MUST be stored in /ssl/, which is the default for Hass.io

Embedding into Home Assistant

It is possible to embed the motionEye directly into Home Assistant, allowing you to access your camera's through the Home Assistant frontend.

Home Assistant provides the panel_iframe component, for these purposes.

Example configuration:

panel_iframe:
  motioneye:
    title: motionEye
    icon: mdi:cctv
    url: https://addres.to.your.hass.io:8765

Known issues and limitations

  • Local USB or Pi cameras are currently not supported yet. This is caused by a limitation of Hass.io. A request for a change has been made to make this possible in the future. motionEye(OS) allows you to use a second instance (e.g., a Pi Zero W) for those kinds of purposes.

Changelog & Releases

This repository keeps a change log using GitHub's releases functionality. The format of the log is based on Keep a Changelog.

Releases are based on Semantic Versioning, and use the format of MAJOR.MINOR.PATCH. In a nutshell, the version will be incremented based on the following:

  • MAJOR: Incompatible or major changes.
  • MINOR: Backwards-compatible new features and enhancements.
  • PATCH: Backwards-compatible bugfixes and package updates.

Support

Got questions?

You have several options to get them answered:

You could also open an issue here GitHub.

Contributing

This is an active open-source project. We are always open to people who want to use the code or contribute to it.

We have set up a separate document containing our contribution guidelines.

Thank you for being involved! 😍

Authors & contributors

The original setup of this repository is by Franck Nijhof.

For a full list of all authors and contributors, check the contributor's page.

We have got some Hass.io add-ons for you

Want some more functionality to your Hass.io Home Assistant instance?

We have created multiple add-ons for Hass.io. For a full list, check out our GitHub Repository.

License

MIT License

Copyright (c) 2018-2019 Franck Nijhof

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

You can’t perform that action at this time.