https://github.com/djdefi/backup-utils-action

GitHub Enterprise Backup Utilities run via GitHub Actions
https://github.com/djdefi/backup-utils-action

ghes ghes-backups github-enterprise github-enterprise-server

Last synced: 15 days ago
JSON representation

GitHub Enterprise Backup Utilities run via GitHub Actions

• Host: GitHub
• URL: https://github.com/djdefi/backup-utils-action
• Owner: djdefi
• Created: 2022-10-14T05:10:22.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-10T22:53:53.000Z (8 months ago)
• Last Synced: 2024-10-11T14:59:21.524Z (3 months ago)
• Topics: ghes, ghes-backups, github-enterprise, github-enterprise-server
• Homepage:
• Size: 43.9 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# GitHub Enterprise Server `backup-utils` Action

[GitHub Enterprise Server Backup Utilities](https://github.com/github/backup-utils) running in GitHub Actions.

## Example workflow

Save the workflow as: [`.github/workflows/ghes-backup-utils.yml`](.github/workflows/ghes-backup-utils.yml) in your repository:

```yaml

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](https://docs.github.com/enterprise-server/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh). 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!