restic-browser

Java-based implementation of a browser for restic repositories. restic is a modern backup program.

Status

• Early prototype status, not fully functional.
• PoC working: a java.nio.file.FileSystem that allows browsing a restic repository with e.g. Files.walkTree.
• PoC working: simple webserver that exposes this filesystem
• PoC working: fuse mount of this filesystem

TODOs

• modularize (module-info.java)
• create jpackage versions/installers
• finish implementation:
  • support v1 and v2 repo formats and legacy layout
  • don't load the files completely into memory, use streams
  • respect locks in restic repo
  • cleanup
  • error handling
  • support all json fields (see package org.adangel.resticbrowser.model) including correct types (e.g. uint64)
• simple GUI for starting either webserver or mount
• simple CLI for starting either webserver or mount
• add symlinks for latest, shorten sha256 ids/filenames
  • layout similar to restic: https://github.com/restic/restic/blob/master/internal/fuse/root.go#L62-L65
• testing with real world repository

Implementation details

• restic repository specification: https://restic.readthedocs.io/en/stable/100_references.html
• custom nio FileSystem: see java.nio.file.spi.FileSystemProvider
• Expose this FileSystem via com.sun.net.httpserver.SimpleFileServer (see JEP 408: Simple Web Server)
• Expose this FileSystem with FUSE, e.g. winfsp / jnr-fuse.

License

MIT License