A GTK3 system-tray applet for restic backups to SSH storage boxes, local repositories, and rclone remotes.
- Tray icon with backup progress ring
- Scheduled backups (interval or daily)
- Automatic restic repository checks on a rolling subset schedule
- Per-directory backup sources with per-source excludes
- Backends: SFTP, local path, or rclone remotes
- Retention / forget policy
- Sleep inhibition during active backups
- Log window with live output
yay -S restic-boxDownload the latest release from the Releases page:
| Variant | Description |
|---|---|
restic-box-vX.Y.Z-x86_64.AppImage |
Requires restic on your $PATH |
restic-box-bundled-restic-vX.Y.Z-x86_64.AppImage |
Includes restic binary |
restic-box-bundled-restic-rclone-vX.Y.Z-x86_64.AppImage |
Includes restic and rclone binaries |
chmod +x restic-box-*.AppImage
./restic-box-*.AppImageTo install system-wide, copy to ~/.local/bin/ and register the desktop entry:
cp restic-box-*.AppImage ~/.local/bin/restic-box
# Extract and install the .desktop + icon (optional):
~/.local/bin/restic-box --appimage-extract-and-run \
sh -c 'cp $APPDIR/restic-box.desktop ~/.local/share/applications/ && \
cp $APPDIR/restic-box.png ~/.local/share/icons/'Or run the program and right click the tray icon and check Run on Startup. Checkmark supports both AppImage and running from source.
sudo pacman -S restic rclone python-gobject python-cairo
# AUR: libayatana-appindicator (or libappindicator-gtk3 from extra)
sudo apt install restic rclone python3-gi python3-gi-cairo python3-cairo \
gir1.2-gtk-3.0 gir1.2-appindicator3-0.1
pip install PyGObject pycairo
git clone https://github.com/Shikaku2/restic-box
cd restic-box
python main.pyOr install via pip:
pip install .
restic-boxOn first run, open Settings from the tray menu to configure:
- SFTP host, port, user, and key path; a local path; or an rclone remote and path
- Restic repository path on the selected backend
- Backup directories and schedules
Configuration is saved to ~/.config/restic-box/config.json.
You can drop pure-Python packages into ~/.local/share/restic-box/vendor/ and they will be loaded automatically at startup. This works whether you're running from source or an AppImage.
Requires appimage-builder and wget/bzip2.
cd packaging
# Without bundled restic (expects restic on $PATH):
VERSION=0.1.0 BUNDLE_RESTIC=0 appimage-builder --recipe AppImageBuilder.yml --skip-tests
# With bundled restic:
VERSION=0.1.0 BUNDLE_RESTIC=1 BUNDLE_SUFFIX=-bundled-restic appimage-builder --recipe AppImageBuilder.yml --skip-tests
# With bundled restic and rclone:
VERSION=0.1.0 BUNDLE_RESTIC=1 BUNDLE_RCLONE=1 BUNDLE_SUFFIX=-bundled-restic-rclone \
appimage-builder --recipe AppImageBuilder.yml --skip-testsSee LICENSE.txt.
The -bundled AppImage variant includes restic, copyright 2014 Alexander Neumann and contributors, used under the BSD 2-Clause License:
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
The -bundled-rclone AppImage variant also includes rclone, copyright Nick Craig-Wood and contributors, used under the MIT License:
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.