{"id":15318415,"url":"https://github.com/appleboy/database-backup-action","last_synced_at":"2025-10-04T09:10:08.302Z","repository":{"id":66187339,"uuid":"318713639","full_name":"appleboy/database-backup-action","owner":"appleboy","description":"GitHub Actions for periodically backup your database (MySQL, Postgres, or MongoDB) to S3 or local disk.","archived":false,"fork":false,"pushed_at":"2021-02-13T03:03:16.000Z","size":27,"stargazers_count":18,"open_issues_count":1,"forks_count":5,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-09-13T13:22:04.023Z","etag":null,"topics":["database","github-actions","mongodb","mysql","postgresql"],"latest_commit_sha":null,"homepage":"","language":"Roff","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/appleboy.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}},"created_at":"2020-12-05T05:54:44.000Z","updated_at":"2024-08-20T20:51:32.000Z","dependencies_parsed_at":"2023-02-22T17:30:55.584Z","dependency_job_id":null,"html_url":"https://github.com/appleboy/database-backup-action","commit_stats":{"total_commits":31,"total_committers":1,"mean_commits":31.0,"dds":0.0,"last_synced_commit":"31394ccb1e1d9472c34b5679bdc31dd625e5b49a"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/appleboy/database-backup-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appleboy%2Fdatabase-backup-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appleboy%2Fdatabase-backup-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appleboy%2Fdatabase-backup-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appleboy%2Fdatabase-backup-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/appleboy","download_url":"https://codeload.github.com/appleboy/database-backup-action/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appleboy%2Fdatabase-backup-action/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278290232,"owners_count":25962506,"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","status":"online","status_checked_at":"2025-10-04T02:00:05.491Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["database","github-actions","mongodb","mysql","postgresql"],"created_at":"2024-10-01T09:00:00.394Z","updated_at":"2025-10-04T09:10:08.265Z","avatar_url":"https://github.com/appleboy.png","language":"Roff","funding_links":[],"categories":[],"sub_categories":[],"readme":"# database-backup-actions\n\n![backup mongo database](https://github.com/appleboy/database-backup-action/workflows/backup%20mongo%20database/badge.svg?branch=master)\n![backup mysql database](https://github.com/appleboy/database-backup-action/workflows/backup%20mysql%20database/badge.svg?branch=master)\n![backup postgres database](https://github.com/appleboy/database-backup-action/workflows/backup%20postgres%20database/badge.svg?branch=master)\n\n[GitHub Action](https://github.com/features/actions) for periodically backup a your database (MySQL,  Postgres or MongoDB) to Local Disk or S3 ([AWS S3](https://aws.amazon.com/free/storage/s3) or [Minio](https://min.io/)).\n\n## Usage\n\n### Postgres\n\n```yaml\n    - name: backup postgres\n      uses: ./\n      with:\n        database_driver: postgres\n        database_username: db\n        database_password: db\n        database_name: db\n        database_host: postgres:5432\n\n        storage_driver: s3\n        access_key_id: 1234567890\n        secret_access_key: 1234567890\n        storage_endpoint: minio:9000\n        storage_bucket: test\n        storage_region: ap-northeast-1\n        storage_path: backup\n```\n\n### MySQL\n\n```yaml\n    - name: backup mysql\n      uses: ./\n      with:\n        database_driver: mysql\n        database_username: db\n        database_password: db\n        database_name: db\n        database_host: mysql:3306\n\n        storage_driver: s3\n        access_key_id: 1234567890\n        secret_access_key: 1234567890\n        storage_endpoint: minio:9000\n        storage_bucket: test\n        storage_region: ap-northeast-1\n        storage_path: backup\n```\n\n### MongoDB\n\n```yaml\n    - name: backup mongo\n      uses: ./\n      with:\n        database_driver: mongo\n        database_username: db\n        database_password: db\n        database_name: db\n        database_host: mongo:27017\n        database_opts: \"--authenticationDatabase admin\"\n\n        storage_driver: s3\n        access_key_id: 1234567890\n        secret_access_key: 1234567890\n        storage_endpoint: minio:9000\n        storage_bucket: test\n        storage_region: ap-northeast-1\n        storage_path: backup\n```\n\n## Input variables\n\nSee [action.yml](./action.yml) for more detailed information.\n\n### Database Section\n\n* database_driver - support `postgres`, `mysql` or `mongo`. default is `postgres`\n* database_username - database username\n* database_password - database password\n* database_name - database name\n* database_host - database host\n* database_opts - see the `pg_dump`, `mysqldump` or `mongodump` command\n\n### Storage Section\n\n* storage_driver - support `s3` or `disk`. default is `s3`\n* access_key_id - minio or aws s3 access key id\n* secret_access_key - minio or aws s3 secret access key\n* storage_endpoint - s3 endpoint. default is `s3.amazonaws.com`\n* storage_bucket - s3 bucket name\n* storage_region - s3 region. default is `ap-northeast-1`\n* storage_path - backup folder path in bucket. default is `backup` and all dump file will save in `bucket/backup` directory\n* storage_ssl - default is `false`\n* storage_insecure_skip_verify - default is `false`\n\n### Schedule Section\n\n* time_schedule - you may use one of several pre-defined schedules in place of a cron expression.\n* time_location - by default, all interpretation and scheduling is done in the machine's local time zone. you can specify a different time zone on construction.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappleboy%2Fdatabase-backup-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fappleboy%2Fdatabase-backup-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappleboy%2Fdatabase-backup-action/lists"}