https://github.com/muhlba91/homelab-ring-mqtt-configuration

Homelab: Configuration for Ring MQTT
https://github.com/muhlba91/homelab-ring-mqtt-configuration

configuration homelab mqtt ring

Last synced: about 1 month ago
JSON representation

Homelab: Configuration for Ring MQTT

• Host: GitHub
• URL: https://github.com/muhlba91/homelab-ring-mqtt-configuration
• Owner: muhlba91
• License: mit
• Created: 2023-06-21T13:15:02.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-18T21:32:48.000Z (about 2 months ago)
• Last Synced: 2024-11-18T22:39:21.275Z (about 2 months ago)
• Topics: configuration, homelab, mqtt, ring
• Language: Shell
• Homepage:
• Size: 19.5 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Homelab: Ring MQTT - Configuration

[![](https://img.shields.io/github/license/muhlba91/homelab-ring-mqtt-configuration?style=for-the-badge)](LICENSE.md)

[![](https://img.shields.io/github/actions/workflow/status/muhlba91/homelab-ring-mqtt-configuration/verify.yml?style=for-the-badge)](https://github.com/muhlba91/homelab-ring-mqtt-configuration/actions/workflows/verify.yml)

[![](https://api.scorecard.dev/projects/github.com/muhlba91/homelab-ring-mqtt-configuration/badge?style=for-the-badge)](https://scorecard.dev/viewer/?uri=github.com/muhlba91/homelab-ring-mqtt-configuration)

This repository contains [Ring MQTT](https://github.com/tsightler/ring-mqtt) configuration, and lifecycle scripts.

---

## Configuration

The main configuration is located in [`configuration/config.json`](configuration/config.json), and encrypted with [sops](https://github.com/mozilla/sops) and [Google Cloud KMS](https://cloud.google.com/security-key-management).

## Lifecycle Scripts

The directory [`lifecycle`](lifecycle/) contains all lifecycle scripts:

- `prepare.sh`: installs all custom and www components defined in [`components/custom_components.txt`](components/custom_components.txt) and [`components/www_components.txt`](components/www_components.txt)

- `sops.sh`: encrypts or decrypts all necessary files (pass `e` for encryption, and `d` for decryption)

- `backup_restore.sh`: checks if data exists and either backups or restores the configuration