Restic-browser is a cross-platform graphical user interface (GUI) tool designed to simplify browsing and restoring restic backup repositories. Built using Tauri, this application provides an intuitive platform for users to interact with their existing restic backups.
Key Features:
Browsing snapshots and files from local and remote restic repositories.
Restoring or dumping selected files/folders as zip archives.
Opening files directly by moving them to the TEMP directory and using default system programs.
Keyboard navigation with shortcuts for efficient UI interaction.
Audience & Benefit:
Ideal for sysadmins, developers, and power users who need a streamlined way to manage restic backups. Restic-browser enables secure access and restoration of backup data without requiring full repository decryption or extraction, streamlining workflows for those working with sensitive information. It can be installed via winget, making it accessible for Windows users.
README
A simple, cross-platform restic backup GUI for browsing and restoring restic repositories.
Built with Tauri, based on leaanthony's Restoric PoC.
Older versions of the restic browser were built using Wails2. The latest release based on Wails is v0.2.6.
Download
Prebuilt binaries for Windows, macOS and Linux can be downloaded from the GitHub releases page.
On Windows, restic-browser can also be installed and updated via wingetwinget install restic-browser
Features
This is not a fullblown restic backup GUI - it only allows you to browse existing repositories!
Displays contents (snapshots, files) from local and remote restic repositories.
Dumps selected files or folders (as a zip archive) to a desired location.
Restores selected files or folders to a desired location.
Opens selected files by moving them to TEMP, then opens them with your operating system's default programs.
Keyboard Navigation
The UI is navigatable via keyboard shortcuts. To change the focus area, hit Tab + Shift-Tab keys.
-h, --help
Print help information
--insecure-tls
skip TLS certificate verification when connecting to the repo (insecure)
--password
password for the repository - NOT RECOMMENDED - USE password-file/command instead. (default: $RESTIC_PASSWORD)
--password-command
shell command to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)
--password-file
file to read the repository password from (default: $RESTIC_PASSWORD_FILE)
-r, --repo
repository to show or restore from (default: $RESTIC_REPOSITORY)
--rclone
ABS path to the rclone executable that should be used for rclone locations. (default: 'rclone')
--repository-file
file to read the repository location from (default: $RESTIC_REPOSITORY_FILE)
--restic
ABS path to the restic executable that should be used. (default: find in $PATH)
-V, --version
Print version information
System Requirements
All platforms
Install restic and make sure it is included in your $PATH.
On MacOS, where setting the PATH for desktop applications is a really hard thing to do, the restic executable will also be found if it's in one of the following folders: /usr/local/bin, /opt/local/bin, /opt/homebrew/bin, ~/bin.
Install restic and make sure it is included in your $PATH.
Note: installing the tauri CLI via cargo is not necessary. Tauri can be launched through npm (see below).
Front-end and App Development
To work in live development mode with automatic hot-reloading, run npm run tauri dev in the root directory.
Rust Backend Debugging
To debug the Tauri Rust application code, you can use the included startup tasks of vscode. If you press "F5" in vscode, the application will be built in debug mode and then started.
Building Production Packages
To build a redistributable package in production mode, run npm run tauri build in the root directory.