GitHub Enterprise Server backup-utils Action

GitHub Enterprise Server Backup Utilities running in GitHub Actions.

Example workflow

Save the workflow as: .github/workflows/ghes-backup-utils.yml in your repository:

name: 'GitHub Enterprise Server Backup and Restore Workflow'
on:

  workflow_dispatch:
    inputs:
      ghe-hostname:
        description: 'GitHub Enterprise Hostname'
        required: true
        default: 'github.example.com'
      verbose:
        description: 'Verbose output'
        required: false
        default: 'true'
      restore:
        description: 'Restore from backup'
        required: false
        default: 'false'

  schedule:
    # Hourly
    - cron: '0 * * * *'
  
jobs:

  backup:
    runs-on: ubuntu-latest
    steps:
      - name: Backup GitHub Enterprise
        env:
          SCHEDULED_HOSTNAME: 'github.example.com'
        uses: djdefi/backup-utils-action@main
        with:
          ghe-hostname: ${{ github.event.inputs.ghe-hostname || env.SCHEDULED_HOSTNAME }}
          verbose: ${{ github.event.inputs.verbose }}
          restore: ${{ github.event.inputs.restore }}
          ssh-private-key: ${{ secrets.SSH_PRIVATE_KEY }}

• Requires adding a repository or organization level Actions secret SSH_PRIVATE_KEY containing a valid private SSH key with access to the GitHub Enterprise Server adminstrative shell. RSA and ED25519 keys are supported.

Running

Run via workflow dispatch, providing the hostname of the appliance to backup.

Restoring

1. Set restore = true in the workflow dispatch along with a target hostname or IP.
2. Not fully implemented - Coming soon!

Customization of backup-utils configuration options

Coming soon!

Multiple snapshots

Coming soon!

Self-hosted runners

Coming soon!