/restic-browser

A GUI to browse and restore restic backup repositories.

Primary LanguageTypeScriptMIT LicenseMIT

drawing drawing

A simple, cross-platform restic backup GUI for browsing and restoring restic repositories.

Built with Wails2, based on leaanthony's Restoric PoC.

Download

Prebuilt binaries can be downloaded from the GitHub releases page.

Features

  • 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.

This is not a fullblown restic backup GUI - it only allows you to browse existing repositories!

Screenshot

Keyboard Navigation

The UI is navigatable via keyboard shortcuts. To change the focus area, hit Tab + Shift-Tab keys.

Global Shortcuts:

  • Control/CMD + O: Open new repository

Snapshot-List

  • Arrow keys, Page Up/Down, Home/End: Change selected snapshot

File-List

  • Arrow keys, Page Up/Down, Home/End: Change selected file
  • o or Enter or Space: Open selected file or folder
  • d: Dump selected file or folder as zip file
  • r: Restore selected file or folder

System Requirements

All platforms

  • Install restic and make sure it is included in your $PATH.

Windows:

  • Windows 10 or later with WebView2 Runtime

MacOS:

  • macOS 10.14 or later

Linux:

  • Linux with GLIBC_2.31 or later (e.g. Ubuntu 20.04 or later)
  • WebKit2 (install via apt install libwebkit2gtk-4.0 on Ubuntu)

Development

Dependencies

Front-end and App Development

To work in live development mode with automatic hot-reloading, run wails dev in the root directory.

Go Backend Debugging

To debug the Wails Go 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, use wails build -tags production,desktop or use the default build task in vscode.

License

MIT license. See LICENSE for the full text.

Contribute

Patches are welcome! Please fork the latest git repository and create a feature branch.