{"id":15957060,"url":"https://github.com/hadim/docker-github-backup","last_synced_at":"2026-01-03T22:53:16.851Z","repository":{"id":140826747,"uuid":"216845231","full_name":"hadim/docker-github-backup","owner":"hadim","description":"A Docker image that run github-backup periodically using cron and s6-overlay.","archived":false,"fork":false,"pushed_at":"2020-07-25T23:45:43.000Z","size":12,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-15T14:01:44.841Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hadim.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":"2019-10-22T15:17:30.000Z","updated_at":"2020-07-30T01:47:52.000Z","dependencies_parsed_at":"2024-09-08T17:16:52.483Z","dependency_job_id":null,"html_url":"https://github.com/hadim/docker-github-backup","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hadim%2Fdocker-github-backup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hadim%2Fdocker-github-backup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hadim%2Fdocker-github-backup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hadim%2Fdocker-github-backup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hadim","download_url":"https://codeload.github.com/hadim/docker-github-backup/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244173554,"owners_count":20410300,"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":[],"created_at":"2024-10-07T13:40:27.060Z","updated_at":"2026-01-03T22:53:16.813Z","avatar_url":"https://github.com/hadim.png","language":"Dockerfile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# docker-github-backup\n\n[![Docker Automated build](https://img.shields.io/docker/cloud/automated/hadim/docker-github-backup.svg)](https://hub.docker.com/r/hadim/docker-github-backup 'DockerHub')\n[![Docker Build Status](https://img.shields.io/docker/cloud/build/hadim/docker-github-backup.svg)](https://hub.docker.com/r/hadim/docker-github-backup 'DockerHub')\n[![Docker Pulls](https://img.shields.io/docker/pulls/hadim/docker-github-backup.svg)](https://hub.docker.com/r/hadim/docker-github-backup 'DockerHub')\n[![Docker Image Size](https://images.microbadger.com/badges/image/hadim/docker-github-backup.svg)](https://microbadger.com/images/hadim/docker-github-backup \"MicroBadger\")\n\nA Docker image that run [`github-backup`](https://github.com/josegonzalez/python-github-backup) periodically using `cron` and [`s6-overlay`](https://github.com/just-containers/s6-overlay).\n\n## How to use\n\n### Docker Hub\n\nUse the following `docker-compose.yml` file:\n\n```yaml\nversion: '3'\n\nservices:\n\n  github-backup:\n    container_name: github-backup\n    image: hadim/docker-github-backup\n    restart: unless-stopped\n    volumes:\n      - ../github_backup:/data\n    environment:\n      TIMEZONE: \"America/Montreal\"\n      PUID: 1000\n      PGID: 1000\n      CRONTAB_OPTIONS: \"0 0 * * *\"\n      GITHUB_USER: $GITHUB_USER\n      GITHUB_TOKEN: $GITHUB_TOKEN\n      GITHUB_MAX_BACKUPS: 5\n      GITHUB_BACKUP_OPTIONS: \"--private --gists --all\"\n```\n\n### Cloning\n\nYou need to clone this repository and build the repository:\n\n```bash\ngit clone https://github.com/hadim/docker-github-backup.git\ncd docker-github-backup/\ndocker-compose build\n```\n\nEdit `docker-compose.yml`. Then run the container:\n\n```bash\ndocker-compose up -d\ndocker-compose logs -f github-backup\n```\n\n## Configurations\n\n### Data Volumes\n\n| Directory | Description |\n| --- | --- |\n| `/data` | Backup Directory |\n\n### Environment Variables\n\n| Parameter | Function | Default |\n| --- | --- | --- |\n| `TIMEZONE` | [Timezone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) | `\"America/Montreal\"` |\n| `PUID` | User ID (use `id $USER`) | `1000` |\n| `PGID` | Group ID (use `id $USER`) | `1000` |\n| `CRONTAB_OPTIONS` | Crontab options | `\"0 0 * * *\"` |\n| `GITHUB_USER` | GitHub username | `$GITHUB_USER` |\n| `GITHUB_TOKEN` | [GitHub token](https://github.com/settings/tokens) | `$GITHUB_TOKEN` |\n| `GITHUB_MAX_BACKUPS` | Older backups will be deleted | `5` |\n| `GITHUB_BACKUP_OPTIONS` | [GitHub backup options](https://github.com/josegonzalez/python-github-backup#usage) | `\"--private --gists --all\"` |\n\n## License\n\n[MIT License](./LICENSE).\n\n## Author\n\n- [Hadrien Mary](https://github.com/hadim)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhadim%2Fdocker-github-backup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhadim%2Fdocker-github-backup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhadim%2Fdocker-github-backup/lists"}