149 lines
4.2 KiB
Markdown
149 lines
4.2 KiB
Markdown
[](https://zoneminder.com/)
|
|
|
|
# Ansible Role - ZoneMinder
|
|
Ansible Role to deploy a ZoneMinder IP-CAM server.
|
|
|
|
Read into the [official documentation](https://zoneminder.readthedocs.io/en/stable/userguide/gettingstarted.html) on how to add ip-cams and so on.
|
|
|
|
[](https://github.com/ansibleguy/sw_zoneminder/actions/workflows/lint.yml)
|
|
[](https://galaxy.ansible.com/ui/standalone/roles/ansibleguy/sw_zoneminder)
|
|
|
|
**Molecule Integration-Tests**:
|
|
|
|
* Status: [](https://github.com/ansibleguy/_meta_cicd/blob/latest/templates/usr/local/bin/cicd/molecule.sh.j2) |
|
|
[](https://github.com/ansibleguy/sw_zoneminder/actions/workflows/integration_test_result.yml)
|
|
* Logs: [API](https://ci.ansibleguy.net/api/job/ansible-test-molecule-sw_zoneminder/logs?token=2b7bba30-9a37-4b57-be8a-99e23016ce70&lines=1000) | [Short](https://badges.ansibleguy.net/log/molecule_sw_zoneminder_test_short.log) | [Full](https://badges.ansibleguy.net/log/molecule_sw_zoneminder_test.log)
|
|
|
|
Internal CI: [Tester Role](https://github.com/ansibleguy/_meta_cicd) | [Jobs API](https://github.com/O-X-L/github-self-hosted-jobs-systemd)
|
|
|
|
**Tested:**
|
|
* Debian 11
|
|
* Debian 12
|
|
|
|
----
|
|
|
|
## Install
|
|
|
|
```bash
|
|
# latest
|
|
ansible-galaxy role install git+https://github.com/ansibleguy/sw_zoneminder
|
|
|
|
# from galaxy
|
|
ansible-galaxy install ansibleguy.sw_zoneminder
|
|
|
|
# or to custom role-path
|
|
ansible-galaxy install ansibleguy.sw_zoneminder --roles-path ./roles
|
|
|
|
# install dependencies
|
|
ansible-galaxy install -r requirements.yml
|
|
```
|
|
|
|
----
|
|
|
|
## Advertisement
|
|
|
|
* Need **professional support** using Ansible or ZoneMinder? Contact us:
|
|
|
|
E-Mail: [contact@oxl.at](mailto:contact@oxl.at)
|
|
|
|
Tel: [+43 3115 40 900 0](tel:+433115409000)
|
|
|
|
Web: [EN](https://www.o-x-l.com) | [DE](https://www.oxl.at)
|
|
|
|
Language: German or English
|
|
|
|
* You want a simple **Ansible GUI**?
|
|
|
|
Check-out this [Ansible WebUI](https://github.com/ansibleguy/webui)
|
|
|
|
----
|
|
|
|
## Usage
|
|
|
|
### Config
|
|
|
|
Define the zoneminder dictionary as needed.
|
|
|
|
Example for a zoneminder server:
|
|
```yaml
|
|
zoneminder:
|
|
timezone: 'Europe/Vienna'
|
|
tools: true # install useful admin-tools
|
|
|
|
apache:
|
|
domain: 'zoneminder.template.ansibleguy.net'
|
|
aliases: ['zm.template.ansibleguy.net']
|
|
|
|
ssl:
|
|
mode: 'letsencrypt' # or selfsigned/ca/snakeoil
|
|
# if you use 'selfsigned' or 'ca':
|
|
# cert:
|
|
# cn: 'ZoneMinder Server'
|
|
# org: 'AnsibleGuy'
|
|
# email: 'zoneminder@template.ansibleguy.net'
|
|
letsencrypt:
|
|
email: 'zoneminder@template.ansibleguy.net'
|
|
|
|
|
|
```
|
|
|
|
Bare minimum example:
|
|
```yaml
|
|
zoneminder:
|
|
apache:
|
|
domain: 'zoneminder.template.ansibleguy.net'
|
|
```
|
|
|
|
You might want to use 'ansible-vault' to encrypt your passwords:
|
|
```bash
|
|
ansible-vault encrypt_string
|
|
```
|
|
|
|
### Execution
|
|
|
|
Run the playbook:
|
|
```bash
|
|
ansible-playbook -K -D -i inventory/hosts.yml playbook.yml --ask-vault-pass
|
|
```
|
|
|
|
There are also some useful **tags** available:
|
|
* config
|
|
|
|
----
|
|
|
|
## Functionality
|
|
|
|
* **Package installation**
|
|
* ZoneMinder Server
|
|
* Base package and dependencies
|
|
* Apache2 => using [THIS Role](https://github.com/ansibleguy/infra_apache)
|
|
* MariaDB => using [THIS Role](https://github.com/ansibleguy/infra_mariadb)
|
|
|
|
|
|
* **Configuration**
|
|
* Default opt-ins:
|
|
* Database setup
|
|
* Webserver setup
|
|
|
|
* Default opt-outs:
|
|
* Admin-tools
|
|
|
|
* Default config:
|
|
* Logging to syslog
|
|
* Self-Signed certificate
|
|
|
|
----
|
|
|
|
## Info
|
|
|
|
* **Note:** this role currently only supports debian-based systems
|
|
|
|
|
|
* **Note:** Most of the role's functionality can be opted in or out.
|
|
|
|
For all available options - see the default-config located in [the main defaults-file](https://github.com/ansibleguy/sw_zoneminder/blob/latest/defaults/main/1_main.yml)!
|
|
|
|
|
|
* **Warning:** You should AT LEAST [set a login password after the installation finished](https://zoneminder.readthedocs.io/en/stable/userguide/gettingstarted.html#enabling-authentication).
|
|
|