powerful but friendly backup program that runs in your tray, powered by restic
devins.page/restray
go
restic
system-tray
docs: more installation info
to match website
+11
-7
+11
-7
README.md
+11
-7
README.md
···
1
1
# Restray
2
2
3
-
Restray is a simple, handy GUI/CLI/daemon to manage and schedule restic backups with ease. Supports multiple profiles and quite a bit of configuration, along with other features (see feature list below).
4
-
5
-
Restray is intended for desktops. Runs on MacOS, Windows, and Linux. If you're on GNOME, you will need to install [this extension](https://extensions.gnome.org/extension/615/appindicator-support) to interact with and use the app since GNOME doesn't natively support the system tray.
3
+
Restray is a simple, handy GUI/CLI/daemon to manage and schedule restic backups with ease. Supports multiple profiles and quite a bit of configuration, along with other features (see feature list below). Runs on MacOS, Windows, and Linux.
6
4
7
5
I needed a replacement for Time Machine, since it's painfully slow, only exclusive to Macs, and only supports SMB now. I quite like it's simplicity and ease-of-use though. Looking for other solutions, restic appeared to be a great fit, and I already use it for my server. However, I didn't find any option for scheduling restic backups that I actually liked. I did see [resticprofile](https://github.com/creativeprojects/resticprofile) which looks cool, and may be a better solution for some, please do check it out! But I'd still prefer a simple GUI personally. So... here's Restray which should hopefully solve that :)
8
6
9
-
This is new and somewhat work-in-progress/beta software. You might possibly encounter a bug or two that I haven't fixed yet, and if so, please make an issue. I don't really intend on adding many new features, but I will fix bugs and refine the codebase more over time.
7
+
This is new and somewhat work-in-progress/beta software. You might possibly encounter a bug or two that I haven't fixed yet, and if so, please make an issue. I don't intend on adding many new features now, but I will fix bugs and work to refine the UX over time.
10
8
11
9
| MacOS | Linux | Windows |
12
10
| --------------------------------------------------------- | --------------------------------------------------------- | ------------------------------------------------------------- |
···
28
26
- I'd recommend something like [restic-browser](https://github.com/emuell/restic-browser) to browse on Windows, or just open the Shell and use the CLI
29
27
- Full Disk Access detection and prompt on macOS
30
28
- Config file hot-reloading
31
-
- Can runs headless as CLI or daemon, not just the tray GUI
29
+
- Can run headless as CLI or daemon, not just the tray GUI
32
30
33
31
## Installation
34
32
35
-
Grab a build from this repository's [tags](https://tangled.org/devins.page/restray/tags) (MacOS/Windows packaged, Linux as a binary). On MacOS you'll need to [disable Gatekeeper/remove quarantine](https://disable-gatekeeper.github.io) from the `.app`, since I can't pay Apple $100/year to sign it. Sorry.
33
+
**Please keep in mind that Restray is currently beta software**. I work on it in my free time. It's new, and there may be a bug or two that I haven't caught yet. If you find any, please create an [issue](https://tangled.org/devins.page/restray/issues) so that I can keep track of it.
36
34
37
-
Restray needs [restic](https://restic.net) installed to your PATH on MacOS/Linux (on MacOS, self-managed copy gets killed by code-signing requriment), so install it with your package manager (e.g. `brew install restic` or `apt install restic`). Package managers should also just pull it in as a dependency. On Windows, Restray can download and manage it's own restic binary itself if it isn't already in PATH.
35
+
To install, grab a build artifact for your OS and architecture from the [repository's tags](https://tangled.org/devins.page/restray/tags). On MacOS you'll need to [remove quarantine](https://disable-gatekeeper.github.io#disabling-gatekeeper-for-one-application-only) from the `.app`, since I can't pay Apple $100/year to sign it. Sorry.
36
+
37
+
Restray requires [restic](https://restic.net) installed to your PATH on MacOS/Linux, so install it with your package manager. On Windows, Restray can download and manage it's own restic binary itself if it isn't already in PATH.
38
+
39
+
_If you're a Nix/NixOS/Nix-darwin user, I also provide package/module in the project's [flake](https://tangled.org/devins.page/restray) for Linux and MacOS._
40
+
41
+
_If you're on GNOME, you will need the [system tray support extension](https://extensions.gnome.org/extension/615/appindicator-support) to see and interact with Restray._
38
42
39
43
### Building from source
40
44