OpenMediaVault Plugins APT Repository

Debian packages for OpenMediaVault 7 plugins - Docker-based services made easy

Introduction

Welcome to the OpenMediaVault Plugins APT Repository! This repository hosts multiple OpenMediaVault 7 plugins for Docker-based services, all maintained as a unified monorepo with automated build and deployment pipelines.

🔧 Easy Installation

Install plugins directly via APT package manager with simple commands.

🐳 Docker Integration

All plugins leverage Docker Compose for reliable service deployment and management.

🔄 Auto Updates

Automated CI/CD pipeline ensures the latest packages are always available.

📱 Web UI Integration

Seamless integration with OpenMediaVault's web interface for easy management.

🏗️ Multi-Architecture Support

Native support for both AMD64 and ARM64 architectures for broad hardware compatibility.

Source Repository: All packages are built from ralphschuler/openmediavault-plugins and published automatically via GitHub Actions.

Getting Started

🚀 Quick Start

Get up and running in just 2 steps:

  1. Add the repository to your system
  2. Install your desired plugins

Prerequisites

System Requirements

Setup Instructions

Step 1: Add APT Repository

Add the repository to your OpenMediaVault system:

echo "deb [trusted=yes] https://ralphschuler.github.io/openmediavault-plugins stable main" | sudo tee /etc/apt/sources.list.d/openmediavault-plugins.list

Step 2: Update Package Index

Refresh your package list to include the new repository:

sudo apt update

Step 3: Install Plugins

Install any plugin using the standard APT commands:

sudo apt install openmediavault-<plugin-name>

Step 4: Deploy Web UI Changes

After installing plugins, deploy the web interface changes:

sudo omv-salt deploy run webui
Important: Packages are currently unsigned. The [trusted=yes] flag is required unless you implement a signing workflow. For production environments, consider setting up package signing.

Docker Setup

If Docker is not already installed on your system:

sudo apt update && sudo apt install -y docker.io docker-compose
sudo systemctl enable --now docker
sudo usermod -aG docker openmediavault

Verification

Verify your installation by checking available plugins:

apt list | grep openmediavault-

Available Packages

The following OpenMediaVault 7 plugins are available in this repository:

Drone
v0.1.0
Continuous integration platform
sudo apt install openmediavault-drone
Gitea
v0.1.0
Self-hosted Git service with web interface
sudo apt install openmediavault-gitea
Immich
v0.1.0
Self-hosted photo and video management solution
sudo apt install openmediavault-immich
Storecli
v0.1.0
StoreCLI monitoring and management tool
sudo apt install openmediavault-storecli

Installation Examples

Here are some common installation scenarios:

Install a Single Plugin

sudo apt install openmediavault-immich

Install Multiple Plugins

sudo apt install openmediavault-immich openmediavault-gitea openmediavault-drone

Upgrade All Installed Plugins

sudo apt update && sudo apt upgrade
Plugin Status: All plugins follow semantic versioning and are automatically built when changes are detected in the source repository.

Contributing

We welcome contributions to improve existing plugins or add new ones! Here's how you can get involved:

Development Workflow

  1. Fork the source repository
  2. Create a feature branch for your changes
  3. Make your modifications following our coding standards
  4. Test your changes thoroughly
  5. Submit a pull request with a clear description

Plugin Development

Each plugin follows a standard structure:

Code Quality Standards

Python Code

Black formatting, isort imports, flake8 linting

JavaScript Code

ESLint linting, Prettier formatting

Shell Scripts

ShellCheck validation, proper error handling

YAML Files

yamllint validation, consistent formatting

Getting Help

Base Classes: Use the common base classes in the common/ directory to reduce duplication and ensure consistency across plugins.