{"id":17834789,"url":"https://github.com/animmouse/setup-restic","last_synced_at":"2025-03-19T13:31:29.095Z","repository":{"id":44406002,"uuid":"464962383","full_name":"AnimMouse/setup-restic","owner":"AnimMouse","description":"Setup/Install Restic for GitHub Actions","archived":false,"fork":false,"pushed_at":"2024-01-28T14:48:45.000Z","size":22,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-17T09:45:13.447Z","etag":null,"topics":["action","actions","github-actions","restic"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/setup-restic","language":"PowerShell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AnimMouse.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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}},"created_at":"2022-03-01T16:03:47.000Z","updated_at":"2024-06-03T13:44:35.000Z","dependencies_parsed_at":"2024-10-27T20:36:03.426Z","dependency_job_id":"e261b56b-1f0d-4087-8a31-2dd5f3c5ecfb","html_url":"https://github.com/AnimMouse/setup-restic","commit_stats":{"total_commits":11,"total_committers":1,"mean_commits":11.0,"dds":0.0,"last_synced_commit":"58a61a15cc853bd13e083de95b4b08e96ed3ca80"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AnimMouse%2Fsetup-restic","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AnimMouse%2Fsetup-restic/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AnimMouse%2Fsetup-restic/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AnimMouse%2Fsetup-restic/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AnimMouse","download_url":"https://codeload.github.com/AnimMouse/setup-restic/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244434833,"owners_count":20452267,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["action","actions","github-actions","restic"],"created_at":"2024-10-27T20:11:23.981Z","updated_at":"2025-03-19T13:31:28.867Z","avatar_url":"https://github.com/AnimMouse.png","language":"PowerShell","readme":"# Setup Restic for GitHub Actions\nSetup [Restic](https://restic.net) on GitHub Actions to use `restic`.\n\nThis action installs [Restic](https://restic.net) for use in actions by installing it on tool cache using [AnimMouse/tool-cache](https://github.com/AnimMouse/tool-cache).\n\nThis action is implemented as a [composite](https://docs.github.com/en/actions/creating-actions/creating-a-composite-action) action.\n\nWith this action, you can now manipulate your Restic repository like check or prune on GitHub Actions.\n\n## Usage\nTo use `restic`, run this action before `restic`.\n\n### Use secrets for repository\n1. Paste Restic repository to `RESTIC_REPOSITORY` secret.\n2. Paste Restic repository password to `RESTIC_PASSWORD` secret.\n\n```yaml\nsteps:\n  - name: Setup Restic\n    uses: AnimMouse/setup-restic@v1\n    \n  - run: restic check\n    env:\n      RESTIC_REPOSITORY: ${{ secrets.RESTIC_REPOSITORY }}\n      RESTIC_PASSWORD: ${{ secrets.RESTIC_PASSWORD }}\n```\n\n### Use workflow dispatch inputs for repository\n1. Add `restic-repository` workflow dispatch input on your workflow.\n2. Paste Restic repository password to `RESTIC_PASSWORD` secret.\n\n```yaml\non:\n  workflow_dispatch:\n    inputs:\n      restic-repository:\n        description: Restic repository\n        required: true\n        default: rest:http://host:8000\n```\n```yaml\nsteps:\n  - name: Setup Restic\n    uses: AnimMouse/setup-restic@v1\n    \n  - run: restic check\n    env:\n      RESTIC_REPOSITORY: ${{ inputs.restic-repository }}\n      RESTIC_PASSWORD: ${{ secrets.RESTIC_PASSWORD }}\n```\n\n### Use plain env input for repository\n1. Paste Restic repository to `RESTIC_REPOSITORY:` environment variable.\n2. Paste Restic repository password to `RESTIC_PASSWORD` secret.\n\n```yaml\nsteps:\n  - name: Setup Restic\n    uses: AnimMouse/setup-restic@v1\n    \n  - run: restic check\n    env:\n      RESTIC_REPOSITORY: rest:http://host:8000\n      RESTIC_PASSWORD: ${{ secrets.RESTIC_PASSWORD }}\n```\n\n### Environment variable based repositories\n#### S3 example\n1. Paste AWS access key ID to `AWS_ACCESS_KEY_ID` secret.\n2. Paste AWS secret access key to `AWS_SECRET_ACCESS_KEY` secret.\n\n```yaml\nsteps:\n  - name: Setup Restic\n    uses: AnimMouse/setup-restic@v1\n    \n  - run: restic check\n    env:\n      RESTIC_REPOSITORY: ${{ secrets.RESTIC_REPOSITORY }}\n      RESTIC_PASSWORD: ${{ secrets.RESTIC_PASSWORD }}\n      AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}\n      AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}\n```\n\n#### B2 example\n1. Paste B2 account ID to `B2_ACCOUNT_ID` secret.\n2. Paste B2 account key to `B2_ACCOUNT_KEY` secret.\n\n```yaml\nsteps:\n  - name: Setup Restic\n    uses: AnimMouse/setup-restic@v1\n    \n  - run: restic check\n    env:\n      RESTIC_REPOSITORY: ${{ secrets.RESTIC_REPOSITORY }}\n      RESTIC_PASSWORD: ${{ secrets.RESTIC_PASSWORD }}\n      B2_ACCOUNT_ID: ${{ secrets.B2_ACCOUNT_ID }}\n      B2_ACCOUNT_KEY: ${{ secrets.B2_ACCOUNT_KEY }}\n```\n\nFor other environment variable based repositories, you can use other variables, just follow the S3 and B2 examples.\n\n### Rclone\nYou can use [AnimMouse/setup-rclone](https://github.com/AnimMouse/setup-rclone) in order to use Rclone on Restic.\n\n```yaml\nsteps:\n  - name: Setup Rclone\n    uses: AnimMouse/setup-rclone@v1\n    with:\n      rclone_config: ${{ secrets.RCLONE_CONFIG }}\n      \n  - name: Setup Restic\n    uses: AnimMouse/setup-restic@v1\n    \n  - run: restic check\n    env:\n      RESTIC_REPOSITORY: ${{ secrets.RESTIC_REPOSITORY }}\n      RESTIC_PASSWORD: ${{ secrets.RESTIC_PASSWORD }}\n```\n\n### Specific version\nYou can specify the version you want. By default, this action downloads the latest version if version is not specified.\n\n```yaml\nsteps:\n  - name: Setup Restic\n    uses: AnimMouse/setup-restic@v1\n    with:\n      version: 0.14.0\n```\n\n### GitHub token\nThis action automatically uses a GitHub token in order to authenticate with GitHub API and avoid rate limiting. You can also specify your own read-only fine-grained personal access token.\n\n```yaml\nsteps:\n  - name: Setup Restic\n    uses: AnimMouse/setup-restic@v1\n    with:\n      token: ${{ secrets.GH_PAT }}\n```","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanimmouse%2Fsetup-restic","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fanimmouse%2Fsetup-restic","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanimmouse%2Fsetup-restic/lists"}