D4v3

Dockkeep runs the backups you would otherwise write cron jobs and shell scripts for. You describe what to back up, where to, and when in a web UI. Dockkeep stores that as one plain TOML file you can still read, review and edit by hand, and then takes care of running the jobs, pruning old snapshots, copying repositories off-site, logging everything, telling you when something breaks, and getting your files back when you need them. Backups run on Restic, off-site copies on Rclone. Dockkeep does not invent a backup format and does not hide the tools underneath: your repositories stay ordinary Restic repositories that any restic binary can read, with or without Dockkeep. That is deliberate — the day you need your data back is the worst possible day to depend on a tool that is also broken. It is built for local, trusted environments: home servers, homelabs, NAS boxes. --- What you can do with it - Back up mounted directories to local repositories or to cloud storage through Restic's Rclone backend, with excludes, tags and per-backup arguments. - Keep several copies per job — one to the array, one to a NAS, one to object storage — each with its own schedule, retention and credentials. - Prune snapshots automatically with the usual keep rules keep_daily, keep_weekly, keep_within, …) and run a cleanup afterwards so the space actually comes back. - Mirror repositories off-site with Rclone tasks. A deleting sync refuses to start when the source is missing or empty, so an unmounted volume cannot wipe the remote copy. - Chain steps into workflows: stop containers, back up, sync off-site, start them again. - Browse snapshots in the UI and restore single files or whole trees into a dedicated restore directory — restores never write anywhere else. - Run hooks before and after a job, including stopping and starting other containers over the Docker socket. - Get notified by e-mail, Pushover, ntfy, Gotify or webhook. - Everything runs on a built-in cron scheduler; runs, logs and history are visible in the UI. Screenshots Dashboard: Runs: Restore browser: Config editor: --- Please read before installing - The web UI has no built-in authentication. It is an administrative interface with full access to your configuration and your repository passwords. Keep the port on your LAN, or put it behind a VPN or an authenticating reverse proxy. Do not port-forward it. - amd64 only. There is no arm64 image yet. - Set TZ — it decides what "02:00" means for your schedules. Getting started 1. Install from Community Applications and keep the default paths. /backups is where local repositories live, /restore is where restores are written, /data is the example read-only source mount — add one path entry per directory you want to back up. 2. Set a repository password, either in the configuration or via the masked DK_RESTIC_PASSWORD variable (referenced from the config as password_env). 3. Open the WebUI, create a job with one backup, point it at your source and a repository under /backups, and give it a schedule. 4. Run it once manually from the UI and check the log. Two things cannot be regenerated if you lose them: your repositories and the credentials to read them /config plus wherever the passwords live). Keep a copy of those somewhere Dockkeep is not the only way to reach them. Everything in /appdata is convenience state and can be rebuilt. Dockkeep follows semantic versioning: the configuration format and the container contract stay compatible within a major version, and any change to them is listed in that release's notes. Your repositories are never touched by an update — they are plain Restic repositories and no release rewrites them. --- Links - Project and documentation: https://github.com/DavidKrGH/Dockkeep - Image: ghcr.io/davidkrgh/dockkeep - Issues: https://github.com/DavidKrGH/Dockkeep/issues - License: MIT This is the first public release, so feedback from Unraid users is very welcome — especially on defaults that feel wrong for an Unraid box, and on anything in the setup that was harder than it should have been. Bug reports are best on GitHub so they do not get lost, but ask here whenever that is easier.

Hello @redbeard28, thank you for the kind words. I am pleased when the scripts are helpful for other users and the work is appreciated.

Hello @Revan335. Sorry didn't have time to reply earlier. Updates work by re-downloading the directory from GitHub. Just copy the content of the "Config" and "FilterFiles" directory from the old version to the new one. As for the backup jobs, the easiest way is to recreate them with the new job template. You can be notified about updates by following the GitHub project. You can find out whether an update is worthwhile for you from the commits in GitHub. If I make major changes or integrate new functions, it will be posted there. I have the Restic repositories under a different path than the "BackupScripts" directory. I have created a job for "BackupScripts" with the job template. If the repositories are in there, you can exclude them from your backup job with a filter. Please remember that Restic and Rclone each need their own filter files. I don't understand this question. What exactly do you mean by that?

In the default setting, read and write access to the source is given. Since version 1.0.2, however, support for Docker volume propagation has been implemented. This makes it possible to use the "slave" mode if the source or the target is located on a hard disk that is mounted with "unassigned devices". This can also be used to restrict access to read-only. e.g. source="/PATH/TO/DATA:ro".

Hello nitrosont, Correct. The scripts are written in shell. Only restic and rclone are executed as docker, as they are not installed natively on linux. Correct. Resitc needs the password with which the repository was encrypted to automate backups. If you already have an existing repository, replace the text in the file with it and remove the .txt extension. If you need to create a new one. Follow the instructions in the manual -> First create the password file and then use it to create and encrypt the repository. Yes, after the setup is complete, only the BaseJob needs to be adjusted. Simply copy the template and adapt it to the desired backup job. All other files should not be changed, except for the "restic-repo.password.txt" and the "Notifier.sh" if you want to activate the notifications under unraid. What to do here is also described in the instructions. In principle, you can use any storage location to which your Docker containers have access. I use the appdata share. Just download the zip from Github and extract it. Git automatically names the directory "BackupScripts-main". You then have to rename it to "BackupScripts" or change the "home_path" in your backup jobs. The directory can then be moved to a location of your choice. Please remember to make the executor files executable according to the instructions. 5. Yes, the containers are visible as long as they are executed. The name of the container is composed of the job_name and the process. When no job is running, only the unused images are visible. Here is a example: All answers correspond to version 1.0.2. I hope I was able to answer all your questions in an understandable way 🙂

Hello Revan336, you can find the instructions in the GutHub readme under "Installation". There everything is described in detail. If you still have questions, please start a discussion there or directly here. The Docker containers used are the official containers from Restic and Rclone. This ensures optimal compatibility and the current state for the future. The script takes care of the installation and execution itself. The containers are removed after each execution. So you only need an installed Docker Deamon. This is already the case with Unraid by default. I use the appdata share as the storage location for the scripts. In principle, however, any location works. Best regards

Hi guys, I am a new user of Unraid (still in the 30 day trial period) but already very enthusiastic about the system. However, I had problems at the beginning to implement my backup according to my ideas. I wanted to have my backups backed up both locally and remotely. A decent versioning was also important to me. Therefore, I quickly came across the tools Restic https://restic.net/ and Rclone https://rclone.org/. Both are excellent solutions. Both are excellent solutions that, in combination, leave little to be desired. If you want to know more about the tools, you can read more in my manual or go directly to the source and read the documentation of the tools. Now that I knew which tools I wanted to use, I was faced with the problem of implementation. In true unraid fashion, I am not a fan of installing things bare metal. Therefore, docker is the only true way for me. Restic and Rclone both offer an official container. However, it was very difficult for me to use them at the beginning. It took many hours of searching here and in other forums and some trial and error until I had the information I needed. Since I didn't find any solution or instructions suitable for my idea on the way to implementation, I decided to offer it myself now. Hopefully others will be able to reach their backup goal quickly. Features: Simple setup Automation with cron jobs possible Creates local and remote backups Fast and flexible creation of backup jobs with templates Automatically uses and installs official Docker containers from Restic and Rclone. No additional installations required Automatically stops and starts Docker containers during backups Separate schedule for running Forget, Prune and the Rclone transfer Blocks execution of the same job while it is still running. The scripts, including instructions on how to set them up and use them, can be found in the corresponding Github repository: https://github.com/DavidKrGH/BackupScripts Maybe some of you will like my solution and enjoy it. Then the many hours of work will have been worth it. With this in mind, I wish you happy backups.

Hi guys, I am a very new unRaid user and would like to use restic for my backups. Unfortunately, I am not getting anywhere here on my own. About my setup: - Unraid in version 6.11.5 - Array with 2 HDD in xfs forma - Cash with one SSD in brfs - Another SSD with unassigned devices in btrfs format on which the repository of restic is. - I installed restic 0.15.1 via NerdTools. Creating the backups by adding snapshots works as desired, at least manually. Automating the backups is a job for another day. What doesn't work is mounting my repository. I use the command: "restic -r /mnt/user/repository mount /mnt/disks/backup/rmount". As a result, I get the following error: Various research in forums, also on the subject of rclone with similar errors on mounting, have brought me to the point that I now suspect that the restic does not get along with the fusermount3 version of unraid. If someone could help me to get restic to mount, I would be very grateful.