Official plugins for backup, databases, file sync, storage, containers, and system tools.
Export a Bitwarden organisation vault to a password-protected ZIP file. Authenticates via the Bitwarden API key (client ID + client secret) and unlocks the vault with the master password. The exported file is zipped and encrypted before being written to the agent host. Requires the Bitwarden CLI (bw) to be installed on the agent.
Run BorgBackup (borg) operations — create, prune, check, list, info, or compact — against local or remote repositories. Supports SSH remotes, passphrase authentication, deduplication, and compression.
Run common Docker operations from an Orchelium workflow node — start, stop, restart, exec, run, pull, rm, logs, ps, inspect, and prune. The Orchelium agent must have access to the Docker socket on the target host.
Delete files in a directory that match a wildcard pattern and are older than a specified number of days. Uses find -mtime to locate and remove matching files. Useful for pruning backup archives, log files, and any other time-based file retention policies.
Manage Proxmox LXC containers using the pct (Proxmox Container Toolkit) command. The Orchelium agent must run on the Proxmox node that hosts the containers. Supports start, stop, restart, exec, status, snapshot, rollback, destroy-snapshot, clone, and list operations.
Mount or unmount filesystems on the agent — NFS, CIFS/SMB, ext4/xfs/btrfs block devices, LUKS encrypted volumes, loop files, bind mounts, and tmpfs. Can also check whether a path is currently mounted.
Backup, restore and manage MySQL / MariaDB databases. Uses mysqldump for exports and mysql / mysqlcheck for other operations. Passwords are passed via an options file so they never appear on the command line.
Query and manage OPNsense firewall configurations and diagnostics. Access backups, firmware status, firewall rules/aliases/NAT, and system diagnostics. Uses OPNsense REST API with API key authentication.
Backup and export Paperless-ngx document library via Docker. Manage maintenance mode, export documents to timestamped directories, and compress backups. The Orchelium agent must have Docker access to the Paperless-ngx container host.
Backup, restore and manage PostgreSQL databases. Uses pg_dump / pg_dumpall for exports, pg_restore / psql for imports, and standard psql / createdb / dropdb / vacuumdb utilities. Passwords are managed via a PGPASSFILE (.pgpass) so they never appear on the command line.
Run vzdump on a Proxmox host to back up one or more VMs or LXC containers. The Orchelium agent must be running on (or have SSH access configured as) the Proxmox node. Supports all vzdump modes and storage targets.
Sync, copy, move, or check files between any rclone-supported storage backend — local disk, S3, Google Drive, Dropbox, OneDrive, SFTP, WebDAV, B2, Azure, GCS, and many more. Remotes must be pre-configured in the rclone config file on the agent.
Run a Restic backup, forget, or check operation against any supported repository (local, SFTP, REST server, S3, B2, Azure, GCS, etc.). Supports password file or environment-variable authentication.
Synchronise or verify files between directories or hosts using rsync. Supports local-to-local, local-to-remote (SSH), and remote-to-local transfers.
Interact with Amazon S3 or any S3-compatible object store (MinIO, Wasabi, Backblaze B2, Cloudflare R2, etc.) using the AWS CLI. Supports sync, upload, download, list, delete, bucket creation, and pre-signed URL generation. Credentials are read from a standard AWS credentials file or the agent's environment variables — never passed on the command line.
Backup, restore and manage SQLite database files. Uses the sqlite3 CLI for all operations — no server or authentication required. Supports online hot-backup (.backup command), SQL dump/restore, queries, VACUUM, integrity checks, and table listing.
Manage systemd services on the agent host. Start, stop, restart, reload, enable, disable, or query the status of any systemd unit. Supports both system-wide units and per-user units via the --user flag.
Create, extract, or list tar archives on the agent host. Supports gzip, bzip2, xz, and zstd compression. No external dependencies beyond the standard tar command available on every Linux and macOS system.
Manage TrueNAS CORE and SCALE via the REST API v2.0. Supports ZFS snapshots, triggering replication and cloud sync tasks, listing datasets, and starting pool scrubs — all without needing SSH access to the NAS. Authentication uses a TrueNAS API key stored in a file on the agent.
Send a Wake-on-LAN (WoL) magic packet to wake a sleeping or powered-off machine on the local network. Uses Python 3 to craft and broadcast the magic packet via UDP — no external tools required.
Replicate ZFS datasets via zfs send | zfs receive. Supports full and incremental replication, recursive replication of dataset trees, remote targets via SSH, raw encrypted streams, and resume tokens for interrupted transfers.
Create, destroy, list, send/receive, rollback, or clone ZFS snapshots. Supports recursive operations, incremental sends, and remote replication via SSH piped zfs receive.
A minimal example plugin that outputs a greeting message with the current date. Use this as a starting point and reference template when building your own Orchelium community plugins.