Skip to content

tmseidel/restic-explorer

Repository files navigation

Restic Explorer

CI Build and Push Docker Image Docker Hub License: MIT

A lightweight web dashboard for monitoring restic backup repositories. Built with Spring Boot 4, Thymeleaf, and Bootstrap 5.

Dashboard

Key Features

  • Multi-Repository Dashboard — monitor all your restic repos in one place with status badges, groups, and lock warnings
  • Automated Scanning & Integrity Checks — scheduled restic snapshots and restic check --read-data
  • Retention Policies — advisory daily/weekly/monthly/yearly rules with amber violation warnings
  • Health Endpoint/actuator/health with per-repo scan, check, and retention status for integration with external monitoring
  • Encrypted Credentials — AES-256-GCM at rest for passwords and backend keys
  • Dark Mode & Responsive UI — Bootstrap 5.3 with automatic light/dark theme

Supported Backends

Backend URL Format Details
Amazon S3 / S3-Compatible s3:https://s3.amazonaws.com/bucket/path Access Key, Secret Key, Region
Azure Blob Storage azure:container:/path Account Name, Account Key
SFTP sftp:user@host:/path Key-based auth only (tutorial)
REST Server rest:http://host:8000/ Optional HTTP basic auth (tutorial)
Rclone rclone:remote:path Any rclone-supported backend (tutorial)

Quick Start

Docker Compose (recommended)

docker compose up --build -d

Open http://localhost:8080 and create the admin account on first launch.

Docker Hub

docker pull tmseidel/restic-explorer:latest

See Configuration → Docker Hub Image for a full docker-compose.yml.

Local Development

mvn spring-boot:run       # Start with H2 file DB
mvn test                  # Run tests (H2 in-memory)
mvn clean package         # Build jar

Requires Java 21+ and restic on PATH.

Screenshots

Dashboard Snapshots Snapshot Detail
Dashboard Snapshots Detail

Documentation

Document Description
User Guide Setup, adding repositories, browsing snapshots, retention policies
Configuration Properties, Docker env vars, encryption, deployment, migration
Architecture System design, data model, extensibility, technology stack
SFTP Testing SFTP backend setup tutorial
REST Server Testing REST server backend setup tutorial
Rclone Testing Rclone backend setup tutorial
Contributing How to contribute
Code of Conduct Community guidelines

License

MIT — © 2026 Tom Seidel

About

Web dashboard for browsing and managing restic backup repositories. Built with Spring Boot & Thymeleaf.

Topics

Resources

License

Code of conduct

Contributing

Stars

13 stars

Watchers

0 watching

Forks

Contributors

Languages