Giter VIP home page Giter VIP logo

github-backup's Introduction

Github Backup

Small utility which will concurrently backup many GitHub repositories across multiple organizations to S3 bucket.

Notes

  • If running in container make sure that container is not read-only.
  • Make sure that bucket exists on S3.
  • Make sure that git auth keys are configured and that they have access to repositories.

Setup

  1. Copy .env-example to .env (make sure it is in the same directory as the binary) cp .env-example .env
  2. Put all necessary secrets to .env file
  3. Put all organisations name into config.yml file

Usage

  1. Build the binary with make build
  2. Execute the binary ./ghbackup or run it with go runtime make run

TODO

  • Add more tests
    • Mock S3 upload

Troubleshooting

  • I'm getting panic: AccessDenied: Access Denied while trying to push file to S3, what should I do? This backup utility does not do bucket management at the moment. Default behaviour of S3 is to enlist the contents of the bucket in case if it cannot find key it is searching. Most likely this means that bucket does not exists. Create the S3 bucket you have specified in .env file and try again.

  • Git is giving me exit status 128, what should I do? Scream & Run. (Most likely there are deleted repositories which we are trying to download. Copy paste the command from output and check.)

github-backup's People

Contributors

jsam avatar

Stargazers

avatar avatar avatar avatar

Watchers

avatar avatar avatar avatar avatar avatar

Forkers

classdojo isabella232

github-backup's Issues

Add support for OAuth token authentication

Since Password authentication was outlawed by GitHub, using OAuth tokens seems to be the way to go.

The underlying GitHub client supports this, but github-backup lacks the high level configuration variables.

  • add support for a GITHUB_TOKEN environment variable
  • (optional) add support for a GITHUB_APP_KEY environment variable

Change folder name format to yyyy-mm-dd

This would allow a more intuitive ordering by default.

As fas as I am concerned this change can be implemented in a breaking fashion, manual cleanup is not so hard.

Backup of issues and milestones

Motivation: For Cawemo we currently manage our tasks and open problems via Github Issues and Milestones and it would be great to backup them alongside our code, maybe even more important than the code since nearly every developer has a local checkout of the code. (We don't use Github's Pull Requests for now.)

I care about both, open and closed issues (for different reasons) and their metadata like labels, assignees, milestones and comments. Some of our issues have attachments/embedded pictures (e.g. https://github.com/camunda/cawemo/issues/1123), they are not critical but would be a nice addon.

Persistence: Since this about backups only, in contrast to git repositories the restore of issues is way harder and does not need to be solved now. Facing that, some kind of barely human readable format (YAML > JSON) would be nice, having each issue in a separate file and the whole bunch then compressed afterwards and stored alongside in the S3 bucket. We have around 200 open and 1000 closed issues now. I have no preference for the directory structure, for file browsing experience it maybe should not be all in one directory.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.