{"id":15770063,"url":"https://github.com/djdefi/backup-utils-action","last_synced_at":"2026-01-12T00:40:29.249Z","repository":{"id":72117960,"uuid":"551266660","full_name":"djdefi/backup-utils-action","owner":"djdefi","description":"GitHub Enterprise Backup Utilities run via GitHub Actions","archived":false,"fork":false,"pushed_at":"2024-05-10T22:53:53.000Z","size":45,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-11T14:59:21.524Z","etag":null,"topics":["ghes","ghes-backups","github-enterprise","github-enterprise-server"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/djdefi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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-10-14T05:10:22.000Z","updated_at":"2024-06-23T22:34:50.000Z","dependencies_parsed_at":"2024-10-25T14:50:37.025Z","dependency_job_id":"9ad83299-f6aa-42bc-98c2-fbc841a7db83","html_url":"https://github.com/djdefi/backup-utils-action","commit_stats":{"total_commits":32,"total_committers":1,"mean_commits":32.0,"dds":0.0,"last_synced_commit":"7f5a2818790ac2619ffc51b10951c124fd83ccc4"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/djdefi%2Fbackup-utils-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/djdefi%2Fbackup-utils-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/djdefi%2Fbackup-utils-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/djdefi%2Fbackup-utils-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/djdefi","download_url":"https://codeload.github.com/djdefi/backup-utils-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246465216,"owners_count":20781914,"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":["ghes","ghes-backups","github-enterprise","github-enterprise-server"],"created_at":"2024-10-04T14:21:50.344Z","updated_at":"2025-03-31T11:41:49.539Z","avatar_url":"https://github.com/djdefi.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# GitHub Enterprise Server `backup-utils` Action\n\n[GitHub Enterprise Server Backup Utilities](https://github.com/github/backup-utils) running in GitHub Actions.\n\n## Example workflow\n\nSave the workflow as: [`.github/workflows/ghes-backup-utils.yml`](.github/workflows/ghes-backup-utils.yml) in your repository:\n\n```yaml\nname: 'GitHub Enterprise Server Backup and Restore Workflow'\non:\n\n  workflow_dispatch:\n    inputs:\n      ghe-hostname:\n        description: 'GitHub Enterprise Hostname'\n        required: true\n        default: 'github.example.com'\n      verbose:\n        description: 'Verbose output'\n        required: false\n        default: 'true'\n      restore:\n        description: 'Restore from backup'\n        required: false\n        default: 'false'\n\n  schedule:\n    # Hourly\n    - cron: '0 * * * *'\n  \njobs:\n\n  backup:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Backup GitHub Enterprise\n        env:\n          SCHEDULED_HOSTNAME: 'github.example.com'\n        uses: djdefi/backup-utils-action@main\n        with:\n          ghe-hostname: ${{ github.event.inputs.ghe-hostname || env.SCHEDULED_HOSTNAME }}\n          verbose: ${{ github.event.inputs.verbose }}\n          restore: ${{ github.event.inputs.restore }}\n          ssh-private-key: ${{ secrets.SSH_PRIVATE_KEY }}\n```\n\n* 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.\n\n## Running\n\nRun via workflow dispatch, providing the hostname of the appliance to backup.\n\n## Restoring\n\n1. Set `restore = true` in the workflow dispatch along with a target hostname or IP.\n2. Not fully implemented - Coming soon!\n\n## Customization of `backup-utils` configuration options \n\nComing soon!\n\n## Multiple snapshots\n\nComing soon!\n\n## Self-hosted runners\n\nComing soon!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdjdefi%2Fbackup-utils-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdjdefi%2Fbackup-utils-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdjdefi%2Fbackup-utils-action/lists"}