forgejo-release-mirror

Forgejo Release Mirror

Forgejo Release Mirror is a small (~10MB) Golang program that mirrors releases and their assets from one Forgejo instance to another one. It is useful when combined with Forgejo's built-in mirror system and tools like regclient (regsync) to create a complete mirror of a repository on Forgejo.

This was primarily created for the Continuwuity project, since we have a lot of mirrors, and already mirrored container images, but wanted to also mirror the releases and their assets. If you use Matrix and want to run your own server, you should check out that project!

[!WARNING] ONLY Forgejo (and possibly Gitea) are supported. GitHub is NOT supported.

Installing

You can install with go install:

go install codeberg.org/timedout/forgejo-release-mirror@dev

Or compile from source:

git clone https://codeberg.org/timedout/forgejo-release-mirror.git
cd forgejo-release-mirror
go build -o forgejo-release-mirror .

There is also an OCI image available:

docker build -t codeberg.org/timedout/forgejo-release-mirror:dev .

Usage

There are no command-line arguments, this program is entirely operated by environment variables:

GitHub Actions (or similar)

You can use this program in a GitHub Actions workflow (or similar CI/CD system) to automate mirroring releases from one Forgejo instance to another one. Here is an example workflow:

jobs:
  mirror-releases:
    runs-on: ubuntu-latest
    steps:
      - name: Mirror Releases
        uses: codeberg.org/timedout/forgejo-release-mirror@dev  # replace "dev" with a commit hash, ideally
        with:
          # Replace these with your actual domains and repo paths
          source_domain: "forgejo.example.com"
          source_repo: "owner/source-repo"
          target_domain: "git.example.com"
          target_repo: "owner/target-repo"

          # Authentication: store tokens in repository or organization secrets and reference them here
          target_auth: "${{ secrets.TARGET_AUTH }}"  # required: username:token
          source_auth: "${{ secrets.SOURCE_AUTH }}"  # optional: username:token (needed for private repos / user mapping)

          # Optional flags
          only_tag: ""                # optionally mirror only a specific tag
          disable_user_mapping: "false" # set to "true" to skip user mapping behavior
          max_size_mib: "100"         # maximum asset size to transfer in MiB (default 100)