Skip to content

viseron addition #699

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Jul 14, 2025
Merged

Conversation

jetonr
Copy link
Contributor

@jetonr jetonr commented Jul 10, 2025

πŸ›‘ New scripts must first be submitted to ProxmoxVED for testing.
PRs for new scripts that skip this process will be closed.


✍️ Description

πŸ”— Related PR / Issue

Link: #

βœ… Prerequisites (X in brackets)

  • Self-review completed – Code follows project standards.
  • Tested thoroughly – Changes work as expected.
  • No breaking changes – Existing functionality remains intact.
  • No security risks – No hardcoded secrets, unnecessary privilege escalations, or permission issues.

πŸ› οΈ Type of Change (X in brackets)

  • 🐞 Bug fix – Resolves an issue without breaking functionality.
  • ✨ New feature – Adds new, non-breaking functionality.
  • πŸ’₯ Breaking change – Alters existing functionality in a way that may require updates.
  • πŸ†• New script – A fully functional and tested script or script set.
  • 🌍 Website update – Changes to website-related JSON files or metadata.
  • πŸ”§ Refactoring / Code Cleanup – Improves readability or maintainability without changing functionality.
  • πŸ“ Documentation update – Changes to README, AppName.md, CONTRIBUTING.md, or other docs.

πŸ” Code & Security Review (X in brackets)

  • Follows Code_Audit.md & CONTRIBUTING.md guidelines
  • Uses correct script structure (AppName.sh, AppName-install.sh, AppName.json)
  • No hardcoded credentials

πŸ“‹ Additional Information (optional)

@jetonr jetonr requested review from a team as code owners July 10, 2025 23:08
@jetonr
Copy link
Contributor Author

jetonr commented Jul 10, 2025

Add Viseron NVR Application

Overview:

This pull request adds the Viseron NVR (Network Video Recorder) application to the ProxmoxVE repository. The Viseron scripts automate the installation and setup process for a comprehensive video surveillance system with object detection capabilities. This implementation simplifies the installation by handling dependencies, setting up a Python virtual environment, and configuring a systemd service for easy management.

Key Features:

  • Object Detection: Built-in support for detecting people, vehicles, and other objects
  • Motion Detection: Configurable motion detection with customizable sensitivity
  • Video Recording: Automatic recording of events with configurable retention
  • Web Interface: Accessible via web browser for live monitoring and configuration
  • Hardware Acceleration: Support for GPU acceleration when available
  • Python Virtual Environment: Isolated Python environment using venv
  • Systemd Service: Managed as a background service for reliability
  • Configuration Management: YAML-based configuration with sensible defaults

Technical Implementation:

  • Container Template: ct/viseron.sh - Handles container creation and updates
  • Installation Script: install/viseron-install.sh - Manages dependencies and setup
  • Frontend Integration: frontend/public/json/viseron.json - Website integration
  • Header Art: ct/headers/viseron - ASCII art for terminal display
  • Repository Tracking: Added to .github/workflows/scripts/repos.txt

Source:

This implementation is based on the original work found in the roflcoopter/viseron repository.

Usage:

Once the script is executed, users can access the Viseron application via the web interface at http://<IP>:8888. The system provides comprehensive NVR functionality including live video monitoring, object detection, motion alerts, and recorded event playback.

Contributor:

  • @jetonr - Implementation and testing

Compliance:

βœ… Follows Code_Audit.md & CONTRIBUTING.md guidelines
βœ… Uses correct script structure (viseron.sh, viseron-install.sh, viseron.json)
βœ… No hardcoded credentials
βœ… Proper error handling and security practices
βœ… Complete documentation and metadata

Copy link
Member

@CrazyWolf13 CrazyWolf13 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some small things, otherwise looks already pretty good.

Comment on lines +137 to +141
if [[ "$CTTYPE" == "0" ]]; then
chgrp video /dev/dri
chmod 755 /dev/dri
chmod 660 /dev/dri/*
fi
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we have some sort of setup /func for this @MickLesk ?

@approve-pr-in-main approve-pr-in-main bot merged commit e6013b5 into community-scripts:main Jul 14, 2025
1 check failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants