https://github.com/animmouse/setup-restic

Setup/Install Restic for GitHub Actions
https://github.com/animmouse/setup-restic

action actions github-actions restic

Last synced: 19 days ago
JSON representation

Setup/Install Restic for GitHub Actions

• Host: GitHub
• URL: https://github.com/animmouse/setup-restic
• Owner: AnimMouse
• License: mpl-2.0
• Created: 2022-03-01T16:03:47.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-01-28T14:48:45.000Z (10 months ago)
• Last Synced: 2024-10-19T20:14:47.517Z (27 days ago)
• Topics: action, actions, github-actions, restic
• Language: PowerShell
• Homepage: https://github.com/marketplace/actions/setup-restic
• Size: 21.5 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Setup Restic for GitHub Actions

Setup [Restic](https://restic.net) on GitHub Actions to use `restic`.

This 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).

This action is implemented as a [composite](https://docs.github.com/en/actions/creating-actions/creating-a-composite-action) action.

With this action, you can now manipulate your Restic repository like check or prune on GitHub Actions.

## Usage

To use `restic`, run this action before `restic`.

### Use secrets for repository

1. Paste Restic repository to `RESTIC_REPOSITORY` secret.

2. Paste Restic repository password to `RESTIC_PASSWORD` secret.

```yaml

steps:

  - name: Setup Restic

    uses: AnimMouse/setup-restic@v1

    

  - run: restic check

    env:

      RESTIC_REPOSITORY: ${{ secrets.RESTIC_REPOSITORY }}

      RESTIC_PASSWORD: ${{ secrets.RESTIC_PASSWORD }}

```

### Use workflow dispatch inputs for repository

1. Add `restic-repository` workflow dispatch input on your workflow.

2. Paste Restic repository password to `RESTIC_PASSWORD` secret.

```yaml

on:

  workflow_dispatch:

    inputs:

      restic-repository:

        description: Restic repository

        required: true

        default: rest:http://host:8000

```

```yaml

steps:

  - name: Setup Restic

    uses: AnimMouse/setup-restic@v1

    

  - run: restic check

    env:

      RESTIC_REPOSITORY: ${{ inputs.restic-repository }}

      RESTIC_PASSWORD: ${{ secrets.RESTIC_PASSWORD }}

```

### Use plain env input for repository

1. Paste Restic repository to `RESTIC_REPOSITORY:` environment variable.

2. Paste Restic repository password to `RESTIC_PASSWORD` secret.

```yaml

steps:

  - name: Setup Restic

    uses: AnimMouse/setup-restic@v1

    

  - run: restic check

    env:

      RESTIC_REPOSITORY: rest:http://host:8000

      RESTIC_PASSWORD: ${{ secrets.RESTIC_PASSWORD }}

```

### Environment variable based repositories

#### S3 example

1. Paste AWS access key ID to `AWS_ACCESS_KEY_ID` secret.

2. Paste AWS secret access key to `AWS_SECRET_ACCESS_KEY` secret.

```yaml

steps:

  - name: Setup Restic

    uses: AnimMouse/setup-restic@v1

    

  - run: restic check

    env:

      RESTIC_REPOSITORY: ${{ secrets.RESTIC_REPOSITORY }}

      RESTIC_PASSWORD: ${{ secrets.RESTIC_PASSWORD }}

      AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}

      AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}

```

#### B2 example

1. Paste B2 account ID to `B2_ACCOUNT_ID` secret.

2. Paste B2 account key to `B2_ACCOUNT_KEY` secret.

```yaml

steps:

  - name: Setup Restic

    uses: AnimMouse/setup-restic@v1

    

  - run: restic check

    env:

      RESTIC_REPOSITORY: ${{ secrets.RESTIC_REPOSITORY }}

      RESTIC_PASSWORD: ${{ secrets.RESTIC_PASSWORD }}

      B2_ACCOUNT_ID: ${{ secrets.B2_ACCOUNT_ID }}

      B2_ACCOUNT_KEY: ${{ secrets.B2_ACCOUNT_KEY }}

```

For other environment variable based repositories, you can use other variables, just follow the S3 and B2 examples.

### Rclone

You can use [AnimMouse/setup-rclone](https://github.com/AnimMouse/setup-rclone) in order to use Rclone on Restic.

```yaml

steps:

  - name: Setup Rclone

    uses: AnimMouse/setup-rclone@v1

    with:

      rclone_config: ${{ secrets.RCLONE_CONFIG }}

      

  - name: Setup Restic

    uses: AnimMouse/setup-restic@v1

    

  - run: restic check

    env:

      RESTIC_REPOSITORY: ${{ secrets.RESTIC_REPOSITORY }}

      RESTIC_PASSWORD: ${{ secrets.RESTIC_PASSWORD }}

```

### Specific version

You can specify the version you want. By default, this action downloads the latest version if version is not specified.

```yaml

steps:

  - name: Setup Restic

    uses: AnimMouse/setup-restic@v1

    with:

      version: 0.14.0

```

### GitHub token

This 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.

```yaml

steps:

  - name: Setup Restic

    uses: AnimMouse/setup-restic@v1

    with:

      token: ${{ secrets.GH_PAT }}

```