Gickup

Getting started

Gickup is a tool that allows you to clone/mirror repositories from one hoster to another. This is useful if you want to have a backup of your repositories on another hoster or to a local server.

References

• Docs
• GitHub repo

---

1. Download tarball

   wget https://github.com/stefanprodan/gickup/releases/download/v0.10.39/gickup_0.10.39_linux_amd64.tar.gz

2. Verify checksum

   echo "c3d3e647189c4379d8d70b9223bd4fe5eb293b289ece5931ff2e10064b063a67  gickup_0.10.39_linux_amd64.tar.gz" | sha256sum -c -

3. Extract and move

   tar -xzf gickup_0.10.39_linux_amd64.tar.gz && sudo mv gickup /usr/local/bin/gickup

4. Make executeable

   sudo chmod +x /usr/local/bin/gickup

5. Create backup/config directory

   mkdir -p ~/.config/gickup

6. Create config

   nano ~/.config/gickup/config.yaml

   Local
   • Replace YOUR_GITHUB_TOKEN. Token requires these permissions:
     • all:repo - Full control of public and private repositories.
     • read:gist - Read user gists.
     • read:org - (Optional) Read-only access to organization membership and repos.
   • Replace PATH_TO_LOCAL_BACKUP.

   config.yaml

   source:
     github:
       - token: "YOUR_GITHUB_TOKEN"
         wiki: false
         issues: false
         starred: false
         gists: true
   
   destination:
     local:
       - path: "PATH_TO_LOCAL_BACKUP"
         structured: true
         bare: true
         mirror: true

   Gitea
   • Replace YOUR_GITHUB_TOKEN. Token requires these permissions:
     • all:repo - Full control of public and private repositories.
     • read:gist - Read user gists.
     • read:org - (Optional) Read-only access to organization membership and repos.
   • Replace YOUR_GITEA_TOKEN. Token requires these permissions:
     • write:org - Read/write access to organization membership and repos.
     • write:repo - Full control of public and private repositories.
     • write:user - Read/write access to user.
   • Replace YOUR_GITEA_USERNAME.

   config.yaml

   source:
     github:
       - token: "YOUR_GITHUB_TOKEN"
         wiki: false
         issues: false
         starred: false
         gists: false
   
   destination:
     gitea:
       - token: "YOUR_GITEA_TOKEN"
         user: "YOUR_GITEA_USERNAME"
         url: http://localhost:3004
         lfs: false
         mirror:
           enabled: true
           mirrorinterval: 2h0m0s

   
   

7. Run

   gickup ~/.config/gickup/config.yaml