{"id":18717853,"url":"https://github.com/shebang-labs/dockup","last_synced_at":"2025-04-12T13:32:48.968Z","repository":{"id":38296070,"uuid":"143415796","full_name":"shebang-labs/DockUp","owner":"shebang-labs","description":"DockUp is a Ruby dockerized backup solution that supports different backends like: S3, Azure blob storage, Google cloud storage, local filesystem, etc.","archived":false,"fork":false,"pushed_at":"2022-06-07T21:18:28.000Z","size":199,"stargazers_count":9,"open_issues_count":2,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-26T08:22:10.212Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Ruby","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/shebang-labs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"docs/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-08-03T10:51:11.000Z","updated_at":"2024-10-31T01:04:19.000Z","dependencies_parsed_at":"2022-09-08T07:33:10.286Z","dependency_job_id":null,"html_url":"https://github.com/shebang-labs/DockUp","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shebang-labs%2FDockUp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shebang-labs%2FDockUp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shebang-labs%2FDockUp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shebang-labs%2FDockUp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shebang-labs","download_url":"https://codeload.github.com/shebang-labs/DockUp/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248573554,"owners_count":21126857,"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-11-07T13:18:15.758Z","updated_at":"2025-04-12T13:32:48.657Z","avatar_url":"https://github.com/shebang-labs.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"![DockUp](https://github.com/shebang-labs/DockUp/raw/master/assets/logo.png \"DockUp\")\n\n[![CircleCI](https://circleci.com/gh/shebang-labs/DockUp/tree/master.svg?style=svg)](https://circleci.com/gh/shebang-labs/DockUp/tree/master) \n[![Docker Pulls](https://img.shields.io/docker/pulls/tareksamni/dockup.svg)](https://hub.docker.com/r/tareksamni/dockup/)\n[![Docker Stars](https://img.shields.io/docker/stars/tareksamni/dockup.svg)](https://hub.docker.com/r/tareksamni/dockup/)\n[![Docker Layers](https://images.microbadger.com/badges/image/tareksamni/dockup.svg)](https://hub.docker.com/r/tareksamni/dockup/)\n[![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/shebang-labs/DockUp)\n[![GitHub top language](https://img.shields.io/github/languages/top/shebang-labs/dockup.svg)](https://github.com/shebang-labs/DockUp)\n\n# Welcome to DockUp\n\n## What's DockUp\n\nDockUp is a Ruby dockerized backup solution that supports different backends like: S3, Azure blob storage, Google cloud storage, local filesystem, etc.\n\n## Supported Backends\n\nCurrently DockUp is supporting backups to:\n- [Amazon S3](https://aws.amazon.com/s3/)\n- [Microsoft Azure Blob Storage](https://azure.microsoft.com/en-us/services/storage/blobs/)\n\nSoon and incrementally we will be adding other backends like Azure blob storage, Google cloud storage and other backends. Feel free to [contribute to DockUp](https://github.com/shebang-labs/DockUp/blob/master/docs/CONTRIBUTING.md) and add more backends.\n\n## Getting Started\n\nExamples here are for AWS S3 backend, other examples for different backends could be found in these links:\n\n- [Run using Docker](https://github.com/shebang-labs/DockUp/blob/master/docs/DOCKER.md)\n- [Run using Docker-compose](https://github.com/shebang-labs/DockUp/blob/master/docs/DOCKER-COMPOSE.md)\n- [Run on Kubernetes](https://github.com/shebang-labs/DockUp/blob/master/docs/KUBERNETES.md)\n\n### Docker example\n\n```bash\ndocker run \\\n  -e \"AWS_ACCESS_KEY_ID=your_aws_key_id\" \\\n  -e \"AWS_SECRET_ACCESS_KEY=your_aws_secret_key\" \\\n  -e \"AWS_REGION=eu-west-1\" \\\n  -e \"AWS_BUCKET=some-bucket-name\" \\ # this should be unique and valid (https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html)\n  -e \"DockUpBackend=s3\" \\\n  -e \"DockUpSrc=/backup\" \\\n  -v some_local_path_to_backup:/backup \\ # some_local_path_to_backup could be a folder or file\n  tareksamni/dockup:latest\n```\n\n### docker-compose example\n\n```yml\nversion: '3'\nservices:\n  backup:\n    image: tareksamni/dockup:latest\n    environment:\n      - AWS_ACCESS_KEY_ID=your_aws_key_id\n      - AWS_SECRET_ACCESS_KEY=your_aws_secret_key\n      - AWS_REGION=eu-west-1\n      - AWS_BUCKET=some-bucket-name # this should be unique and valid (https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.ht\n      - DockUpBackend=s3\n      - DockUpSrc=/backup\n    volumes:\n      - some_local_path_to_backup:/backup # some_local_path_to_backup could be a folder or file\n```\n\n### Kubernetes example (Cron Job)\n\n```yml\napiVersion: batch/v1beta1\nkind: CronJob\nmetadata:\n  name: backup\nspec:\n  schedule: \"*/1 * * * *\"\n  jobTemplate:\n    spec:\n      template:\n        spec:\n          volumes:\n            - name: shared-data\n              emptyDir: {}\n          containers:\n          - name: backup\n            image: tareksamni/dockup:tareksamni\n            volumeMounts:\n              - name: shared-data\n                mountPath: /backup\n            env:\n              - name: AWS_ACCESS_KEY_ID\n                value: \"your_aws_key_id\"\n              - name: AWS_SECRET_ACCESS_KEY\n                value: \"your_aws_secret_key\"\n              - name: AWS_REGION\n                value: \"eu-west-1\"\n              - name: AWS_BUCKET\n                value: \"some-bucket-name\" # this should be unique and valid(https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.ht\n              - name: DockUpBackend\n                value: \"s3\"\n              - name: DockUpSrc\n                value: \"/backup\"\n          restartPolicy: OnFailure\n```\n\n## Contributing\n\n[![Open Source Helpers](https://www.codetriage.com/tareksamni/dockup/badges/users.svg)](https://www.codetriage.com/tareksamni/dockup)\n\nWe encourage you to contribute to DockUp! Below you can find our guideline on how to contribute to DockUp. Join us!\n\nTrying to report a possible security vulnerability in DockUp? Please reach out to [tarek.samni](https://twitter.com/tareksamni) before you submit the vulnerability publicly. At DockUp we are committed to do the same with any security vulnerabilities detected in other open source projects during the development of DockUp.\n\n### Ground Rules\n\n- Make sure you are not breaking current test suite!\n- Each contribution should include its tests, no code is merged without tests to cover it.\n- Keep contributions as small as possible in terms of code change. Open multiple contributions for different parts of DockUp.\n- Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback. \n- Check [issues](https://github.com/shebang-labs/DockUp/issues) before you start working on a new feature or a bug to make sure you are not wasting your time/effort on a duplicate contribution.\n- Make sure that you contribution works out of the box in a docker environment. Contribute to the docker setup if needed to accommodate your change/contribution.\n\n### First Contribution\n\nFollow the dev environment setup and contribution guidelines [here](https://github.com/shebang-labs/DockUp/blob/master/docs/CONTRIBUTING.md).\n\n### Code of Conduct\n\nYou can find DockUp's code of conduct [here](https://github.com/shebang-labs/DockUp/blob/master/docs/CODE_OF_CONDUCT.md).\n\n## Code Status\n\n[![CircleCI](https://circleci.com/gh/shebang-labs/DockUp/tree/master.svg?style=svg)](https://circleci.com/gh/shebang-labs/DockUp/tree/master)\n\n## License\n\nDockUp is released under the [MIT License](https://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshebang-labs%2Fdockup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshebang-labs%2Fdockup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshebang-labs%2Fdockup/lists"}