mirror of
https://github.com/alexbelgium/hassio-addons.git
synced 2026-01-09 17:31:03 +01:00
105 lines
5.3 KiB
Markdown
105 lines
5.3 KiB
Markdown
# Home assistant add-on: Zoneminder
|
|
|
|
|
|
I maintain this and other Home Assistant add-ons in my free time: keeping up with upstream changes, HA changes, and testing on real hardware takes a lot of time (and some money). I use around 5-10 of my >110 addons so regularly I install test machines (and purchase some test services such as vpn) that I don't use myself to troubleshoot and improve the addons
|
|
|
|
If this add-on saves you time or makes your setup easier, I would be very grateful for your support!
|
|
|
|
[![Buy me a coffee][donation-badge]](https://www.buymeacoffee.com/alexbelgium)
|
|
[![Donate via PayPal][paypal-badge]](https://www.paypal.com/donate/?hosted_button_id=DZFULJZTP3UQA)
|
|
|
|
## Addon informations
|
|
|
|
|
|
|
|
|
|
|
|
[](https://www.codacy.com/gh/alexbelgium/hassio-addons/dashboard?utm_source=github.com&utm_medium=referral&utm_content=alexbelgium/hassio-addons&utm_campaign=Badge_Grade)
|
|
[](https://github.com/alexbelgium/hassio-addons/actions/workflows/weekly-supelinter.yaml)
|
|
[](https://github.com/alexbelgium/hassio-addons/actions/workflows/onpush_builder.yaml)
|
|
|
|
[donation-badge]: https://img.shields.io/badge/Buy%20me%20a%20coffee-%23d32f2f?logo=buy-me-a-coffee&style=flat&logoColor=white
|
|
[paypal-badge]: https://img.shields.io/badge/Donate%20via%20PayPal-0070BA?logo=paypal&style=flat&logoColor=white
|
|
|
|
_Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!_
|
|
|
|
[](https://github.com/alexbelgium/hassio-addons/stargazers)
|
|
|
|
|
|
|
|
## About
|
|
|
|
["Zoneminder"](https://zoneminder.com/) is a full-featured, open source, state-of-the-art video surveillance software system.
|
|
|
|
This addon is based on the docker image https://github.com/ZoneMinder/zmdockerfiles/blob/master/utils/entrypoint.sh
|
|
|
|
## Configuration
|
|
|
|
Use the add-on `env_vars` option to pass extra environment variables (uppercase or lowercase names). See https://github.com/alexbelgium/hassio-addons/wiki/Add-Environment-variables-to-your-Addon-2 for details.
|
|
|
|
Webui can be found at <http://homeassistant:3778/zm>.
|
|
|
|
### Setup Steps
|
|
|
|
1. Access the web interface after starting the addon
|
|
2. Configure cameras through the web interface
|
|
3. Set up motion detection zones and alerts
|
|
4. Configure storage locations for recordings
|
|
5. Requires MariaDB addon for database storage
|
|
|
|
### Options
|
|
|
|
| Option | Type | Default | Description |
|
|
|--------|------|---------|-------------|
|
|
| `Images_location` | str | `/config/addons_config/zoneminder/images` | Path for storing camera images |
|
|
|
|
### Example Configuration
|
|
|
|
```yaml
|
|
Images_location: "/share/zoneminder/images"
|
|
```
|
|
|
|
### Database Requirements
|
|
|
|
ZoneMinder requires a MySQL/MariaDB database. Install the MariaDB addon and configure Zoneminder to use it.
|
|
|
|
### Storage Paths
|
|
|
|
- Images: Configured via `Images_location` option
|
|
- Events: `/var/cache/zoneminder/events2`
|
|
- Sounds: `/var/cache/zoneminder/sounds2`
|
|
- Config: `/config/addons_config/zoneminder`
|
|
|
|
### Additional Resources
|
|
|
|
For detailed configuration: https://github.com/ZoneMinder/zmdockerfiles/blob/master/utils/entrypoint.sh
|
|
|
|
## Installation
|
|
|
|
The installation of this add-on is pretty straightforward and not different in comparison to installing any other add-on.
|
|
|
|
1. Add my add-ons repository to your home assistant instance (in supervisor addons store at top right, or click button below if you have configured my HA)
|
|
[](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Falexbelgium%2Fhassio-addons)
|
|
1. Install this add-on.
|
|
1. Click the `Save` button to store your configuration.
|
|
1. Set the add-on options to your preferences
|
|
1. Start the add-on.
|
|
1. Check the logs of the add-on to see if everything went well.
|
|
1. Open the webUI and adapt the software options
|
|
|
|
## Integration in home assistant
|
|
|
|
https://www.home-assistant.io/integrations/zoneminder/
|
|
|
|
## Support
|
|
|
|
Create an issue on github
|
|
|
|
## Illustration
|
|
|
|
|
|
|
|
[repository]: https://github.com/alexbelgium/hassio-addons
|
|
|
|
|