{"id":13535883,"url":"https://github.com/garethgeorge/backrest","last_synced_at":"2026-10-18T23:05:12.340Z","repository":{"id":206606463,"uuid":"716967634","full_name":"garethgeorge/backrest","owner":"garethgeorge","description":"Backrest is a web UI and orchestrator for restic backup.","archived":false,"fork":false,"pushed_at":"2026-09-21T13:26:46.000Z","size":7902,"stargazers_count":7667,"open_issues_count":385,"forks_count":235,"subscribers_count":18,"default_branch":"main","last_synced_at":"2026-10-18T19:21:43.854Z","etag":null,"topics":["backups","restic","restic-backups","webui"],"latest_commit_sha":null,"homepage":"https://garethgeorge.github.io/backrest/ ","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/garethgeorge.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"claude":null,"gemini":null,"cursor":null,"copilot":null,"dco":null,"cla":null,"disclosure":null},"funding":{"buy_me_a_coffee":"garethgeorge","github":"garethgeorge"}},"created_at":"2023-11-10T09:00:40.000Z","updated_at":"2026-10-18T18:58:42.000Z","dependencies_parsed_at":"2024-01-15T23:31:35.706Z","dependency_job_id":"b0320686-3a35-4651-aa16-126694f49be3","html_url":"https://github.com/garethgeorge/backrest","commit_stats":{"total_commits":510,"total_committers":25,"mean_commits":20.4,"dds":0.07450980392156858,"last_synced_commit":"1ff69f121ae4f3455e132193dffe6c4a4fa80abd"},"previous_names":["garethgeorge/resticui","garethgeorge/resticweb","garethgeorge/restora","garethgeorge/backrest"],"tags_count":62,"template":false,"template_full_name":null,"purl":"pkg:github/garethgeorge/backrest","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/garethgeorge%2Fbackrest","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/garethgeorge%2Fbackrest/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/garethgeorge%2Fbackrest/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/garethgeorge%2Fbackrest/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/garethgeorge","download_url":"https://codeload.github.com/garethgeorge/backrest/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/garethgeorge%2Fbackrest/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":344872684,"owners_count":38343410,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-10-03T21:59:58.778Z","status":"online","status_checked_at":"2026-10-18T02:00:06.448Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["backups","restic","restic-backups","webui"],"created_at":"2024-08-01T09:00:31.164Z","updated_at":"2026-10-18T23:05:12.329Z","avatar_url":"https://github.com/garethgeorge.png","language":"TypeScript","funding_links":["https://buymeacoffee.com/garethgeorge","https://github.com/sponsors/garethgeorge"],"categories":["Go Tools","Go","TypeScript","others","Apps","Table of Contents","Software Packages"],"sub_categories":["Other Software","Backup"],"readme":"\u003cp align=\"center\"\u003e\n  \u003cpicture\u003e\n    \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"./webui/assets/logo.svg\" width=\"400px\"\u003e\n    \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"./webui/assets/logo-black.svg\" width=\"400px\"\u003e\n    \u003cimg src=\"./webui/assets/logo.svg\" width=\"400px\"\u003e\n  \u003c/picture\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/garethgeorge/backrest/actions/workflows/test.yml/badge.svg\" /\u003e\n  \u003cimg src=\"https://img.shields.io/github/downloads/garethgeorge/backrest/total\" /\u003e\n  \u003cimg src=\"https://img.shields.io/docker/pulls/garethgeorge/backrest\" /\u003e\n\u003c/p\u003e\n\n---\n\n**Overview**\n\nBackrest is a web-accessible backup solution built on top of [restic](https://restic.net/). Backrest provides a WebUI which wraps the restic CLI and makes it easy to create repos, browse snapshots, and restore files. Additionally, Backrest can run in the background and take an opinionated approach to scheduling snapshots and orchestrating repo health operations.\n\nBy building on restic, Backrest leverages its mature, fast, reliable, and secure backup capabilities while adding an intuitive interface.\n\nBuilt with Go, Backrest is distributed as a standalone, lightweight binary with restic as its sole dependency. It can securely create new repositories or manage existing ones. Once storage is configured, the WebUI handles most operations, while still allowing direct access to the powerful [restic CLI](https://restic.readthedocs.io/en/latest/manual_rest.html) for advanced operations when needed.\n\n## Key Features\n\n- **Web Interface**: Access locally or remotely (perfect for NAS deployments)\n- **Multi-Platform Support**: \n  - Linux\n  - macOS\n  - Windows\n  - FreeBSD\n  - [Docker](https://hub.docker.com/r/garethgeorge/backrest)\n- **Backup Management**:\n  - Import existing restic repositories\n  - Cron-scheduled backups and maintenance (e.g. prune, check, forget, etc)\n  - Browse and restore files from snapshots\n  - Configurable notifications (Discord, Slack, Shoutrrr, Gotify, Healthchecks)\n  - Pre/post backup command hooks to execute shell scripts\n- **Storage Options**:\n  - Compatible with rclone remotes\n  - Supports all restic storage backends (S3, B2, Azure, GCS, local, SFTP, and [all rclone remotes](https://rclone.org/))\n\n## Preview\n\n\u003cp align=\"center\"\u003e\n   \u003cimg src=\"https://f000.backblazeb2.com/file/gshare/screenshots/backrest-1.11.1-dashboard.png\" width=\"80%\" /\u003e\n   \u003cimg src=\"https://f000.backblazeb2.com/file/gshare/screenshots/backrest-1.11.1-browse-snapshot.png\" width=\"80%\" /\u003e\n   \u003cimg src=\"https://f000.backblazeb2.com/file/gshare/screenshots/backrest-1.11.1-add-plan.png\" width=\"80%\" /\u003e\n\u003c/p\u003e\n\n---\n\n# User Guide\n\n[See the Backrest docs](https://garethgeorge.github.io/backrest/introduction/getting-started).\n\n---\n\n# Installation\n\nBackrest is packaged as a single executable. It runs directly on Linux, macOS, and Windows. [restic](https://github.com/restic/restic) is downloaded automatically on first run.\n\nOnce installed, access Backrest at `http://localhost:9898` (default port). First-time setup will prompt for username and password creation.\n\n\u003e [!NOTE]\n\u003e To change the default port, set the `BACKREST_PORT` environment variable (e.g., `BACKREST_PORT=0.0.0.0:9898` to listen on all interfaces). The install script accepts `--allow-remote-access` as a shortcut for this.\n\u003e\n\u003e Backrest will use your system's installed version of restic if it's available and compatible. If not, Backrest will download and install a suitable version in its data directory, keeping it updated. To use a specific restic binary, set the `BACKREST_RESTIC_COMMAND` environment variable to the desired path.\n\n## Linux \u0026 macOS (Recommended)\n\nThe install script downloads the latest release, drops the binary into `/usr/local/bin`, and sets up the appropriate auto-start integration (systemd or OpenRC on Linux; launchd on macOS):\n\n```sh\ncurl -fsSL https://raw.githubusercontent.com/garethgeorge/backrest/main/install.sh | bash\n```\n\nFlags go after `--`:\n\n```sh\n# Bind to all interfaces (default: 127.0.0.1:9898)\ncurl -fsSL https://raw.githubusercontent.com/garethgeorge/backrest/main/install.sh | bash -s -- --allow-remote-access\n\n# Uninstall (removes service, autostart entry, and /usr/local/bin/backrest)\ncurl -fsSL https://raw.githubusercontent.com/garethgeorge/backrest/main/install.sh | bash -s -- --uninstall\n```\n\nThe service runs as your user by default (so config and data live under your `$HOME`). To install as `root` instead, pass `--root`. After install, access Backrest at `http://localhost:9898`.\n\n\u003e [!TIP]\n\u003e Review [install.sh](./install.sh) before piping it into a shell. You can also clone the repo and run `./install.sh` locally; it accepts the same flags.\n\n### macOS — Homebrew (alternative)\n\n[Homebrew tap](https://github.com/garethgeorge/homebrew-backrest-tap):\n\n```sh\nbrew tap garethgeorge/homebrew-backrest-tap\nbrew install backrest\nbrew services start backrest\n```\n\n\u003e [!NOTE]\n\u003e You may need to grant Full Disk Access to Backrest. Go to `System Preferences \u003e Security \u0026 Privacy \u003e Privacy \u003e Full Disk Access` and add `/usr/local/bin/backrest`.\n\n### Arch Linux (AUR)\n\n[Backrest on AUR](https://aur.archlinux.org/packages/backrest) is third-party (not maintained by the Backrest project) and tweaks the systemd unit; see the [AUR service file](https://aur.archlinux.org/cgit/aur.git/tree/backrest@.service?h=backrest) for details.\n\n```sh\nparu -Sy backrest  # or: yay -Sy backrest\nsudo systemctl enable --now backrest@$USER.service\n```\n\n## Docker\n\nImage: `ghcr.io/garethgeorge/backrest` (also on [Docker Hub](https://hub.docker.com/r/garethgeorge/backrest)).\n- Includes rclone and common Unix utilities\n- For a minimal image, use `ghcr.io/garethgeorge/backrest:scratch`\n\n### Docker Compose\n\n```yaml\nversion: \"3.8\"\nservices:\n  backrest:\n    image: ghcr.io/garethgeorge/backrest:latest\n    container_name: backrest\n    hostname: backrest\n    volumes:\n      - ./backrest/data:/data\n      - ./backrest/config:/config\n      - ./backrest/cache:/cache\n      - ./backrest/tmp:/tmp\n      - ./backrest/rclone:/root/.config/rclone # Mount for rclone config (needed when using rclone remotes)\n      - /path/to/backup/data:/userdata  # Mount local paths to backup\n      - /path/to/local/repos:/repos     # Mount local repos (optional for remote storage)\n    environment:\n      - BACKREST_DATA=/data\n      - BACKREST_CONFIG=/config/config.json\n      - XDG_CACHE_HOME=/cache\n      - TMPDIR=/tmp\n      - TZ=America/Los_Angeles\n    ports:\n      - \"9898:9898\"\n    restart: unless-stopped\n```\n\n## Windows\n\nDownload the Windows installer for your architecture from the [releases page](https://github.com/garethgeorge/backrest/releases). The installer, named `Backrest-setup-[arch].exe`, places Backrest and a GUI tray application in `%localappdata%\\Programs\\Backrest\\`. The tray application, set to start on login, monitors Backrest.\n\n\u003e [!TIP]\n\u003e To override the default port before installation, set a user environment variable named `BACKREST_PORT`. On Windows 10+, navigate to Settings \u003e About \u003e Advanced system settings \u003e Environment Variables. Under \"User variables\", create a new variable `BACKREST_PORT` with the value `127.0.0.1:port` (e.g. `127.0.0.1:8080`). If changing post-installation, re-run the installer to update shortcuts with the new port.\n\n---\n\n# Configuration\n\n## Environment Variables (Unix)\n\n| Variable                  | Description                 | Default                                                                                                             |\n| ------------------------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------- |\n| `BACKREST_PORT`           | Port to bind to             | 127.0.0.1:9898 (or 0.0.0.0:9898 for the docker images)                                                              |\n| `BACKREST_CONFIG`         | Path to config file         | `$HOME/.config/backrest/config.json`\u003cbr\u003e(or, if `$XDG_CONFIG_HOME` is set, `$XDG_CONFIG_HOME/backrest/config.json`) |\n| `BACKREST_DATA`           | Path to the data directory  | `$HOME/.local/share/backrest`\u003cbr\u003e(or, if `$XDG_DATA_HOME` is set, `$XDG_DATA_HOME/backrest`)                        |\n| `BACKREST_RESTIC_COMMAND` | Path to restic binary       | Defaults to a Backrest managed version of restic at `$XDG_DATA_HOME/backrest/restic-x.x.x`                          |\n| `XDG_CACHE_HOME`          | Path to the cache directory |                                                                                                                     |\n\n## Environment Variables (Windows)\n\n| Variable                  | Description                 | Default                                                                                    |\n| ------------------------- | --------------------------- | ------------------------------------------------------------------------------------------ |\n| `BACKREST_PORT`           | Port to bind to             | 127.0.0.1:9898                                                                             |\n| `BACKREST_CONFIG`         | Path to config file         | `%appdata%\\backrest\\config.json`                                                           |\n| `BACKREST_DATA`           | Path to the data directory  | `%appdata%\\backrest\\data`                                                                  |\n| `BACKREST_RESTIC_COMMAND` | Path to restic binary       | Defaults to a Backrest managed version of restic in `C:\\Program Files\\restic\\restic-x.x.x` |\n| `XDG_CACHE_HOME`          | Path to the cache directory |                                                                                            |\n\n\n# Development\n\n## Contributing\n\nContributions are welcome! See the [issues](https://github.com/garethgeorge/backrest/issues) or feel free to open a new issue to discuss a project. Beyond the core codebase, contributions to [documentation](https://garethgeorge.github.io/backrest/introduction/getting-started), [cookbooks](https://garethgeorge.github.io/backrest/cookbooks/command-hook-examples), and testing are always welcome.\n\n## Build Dependencies\n\nAll build dependencies are defined in `shell.nix` and can be activated automatically using [Nix](https://nixos.org/) and [direnv](https://direnv.net/).\n\n### Using Nix + direnv (Recommended)\n\n1. Install [Nix](https://nixos.org/download/) and [direnv](https://direnv.net/docs/installation.html)\n2. [Hook direnv into your shell](https://direnv.net/docs/hook.html) (e.g. `eval \"$(direnv hook bash)\"` in your `.bashrc`)\n3. Clone the repo and `cd` into it\n4. Run `direnv allow` to trust the `.envrc` — all dependencies (Go, Node.js, pnpm, protoc, buf, etc.) will be available in your shell automatically\n\n### Manual Setup\n\nIf you prefer not to use Nix, install the following manually:\n\n- [Go](https://go.dev/) 1.24 or greater\n- [Node.js](https://nodejs.org/en) 20.x and [pnpm](https://pnpm.io/) 9\n- [goreleaser](https://github.com/goreleaser/goreleaser) `go install github.com/goreleaser/goreleaser/v2@latest`\n\n**(Optional) To edit protobuf definitions:**\n\n```sh\napt install -y protobuf-compiler\ngo install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest\ngo install github.com/bufbuild/buf/cmd/buf@latest\ngo install google.golang.org/protobuf/cmd/protoc-gen-go@latest\ngo install connectrpc.com/connect/cmd/protoc-gen-connect-go@latest\nnpm install -g @bufbuild/protoc-gen-es\n```\n\n## Compiling\n\n```sh\n(cd webui \u0026\u0026 pnpm i \u0026\u0026 pnpm run build)\n(cd cmd/backrest \u0026\u0026 go build .)\n```\n\n## Using VSCode Dev Containers\n\nThe dev container uses Nix and direnv to provide all dependencies. When the container starts, `direnv allow` runs automatically so the Nix shell is activated in every terminal.\n\n0. Make sure Docker and VSCode with the [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension is installed\n1. Clone this repository\n2. Open this folder in VSCode\n3. When prompted, click on `Open in Container` button, or run `\u003e Dev Containers: Rebuild and Reopen in Containers` command\n4. When the container is started, go to `Run and Debug`, choose `Debug Backrest (backend+frontend)` and run it\n\n\u003e [!NOTE]\n\u003e Provided launch configuration has hot reload for the typescript frontend.\n\n## Translations\n\nTranslations are stored in [./webui/messages](./webui/messages) and are generated using [inlang](https://inlang.com/). Machine translations can be updated by running `npx @inlang/cli machine translate --project ./project.inlang`. \n\nText is translated on a best-effort basis and is not guaranteed to be accurate. If you find any translations that are incorrect, please submit a pull request to fix them. Contributions here are greatly appreciated!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgarethgeorge%2Fbackrest","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgarethgeorge%2Fbackrest","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgarethgeorge%2Fbackrest/lists"}