paulrm / git-sync-mirror

A simple synchronization container image for git repositories over https

git-sync-mirror

A simple synchronization container image for git repositories over HTTPS

Features:

• Authentication with https tokens
• Two way synchronization if needed
• If needed, supports also only branch / tag sync
• If needed, use a different HTTPS Proxy for source and destination
• TLS-Trust On First Use: Seamlessly run this container behind a https scanning proxy
• Skip certificate checks (don't do that)
• Configure time to sleep between synchronization attempts

Usage

$ docker run \
  --rm \
  --env SRC_REPO=source \
  --env DST_REPO=destination \
  --env SLEEP_TIME=30s \
  enteee/git-sync-mirror

Note: The container is designed for synchronization over https with supported authentication using access tokens. For example replace SRC_REPO_TOKEN with github-user:github-access-token

Environment Variables

Variable	Description	Mandatory	Example
SRC_REPO	Source repository	Yes	https://github.com/Enteee/git-sync-mirror.git
DST_REPO	Destination repository	Yes	https://github.com/Enteee/git-sync-mirror.git
SRC_REPO_TOKEN	Source repository token	No, default ``	9a91fa018231aaffbbc1231.....
DST_REPO_TOKEN	Destination repository token	No, default ``	9a91fa018231aaffbbc1231.....
SRC_REPO_TOKEN_USER	Source repository token user	No, default ``	YourGithubUser
DST_REPO_TOKEN_USER	Destination repository token user	No, default ``	YourGithubUser
DEBUG	Print debug output. WARNING: This will also print http tokens!	No, default: false	true or false
MIRROR	Mirror all refs not just tags and branches	No, default: true	true or false
TWO_WAY	Mirror both ways. First SRC to DST, then the other way around	No, default: false	true or false
HTTP_TLS_VERIFY	Enable/Disable certificate cheks	No, default: true	true or false
HTTP_SRC_PROXY	HTTP Proxy to use when connecting to SRC_REPO	No, default: ``	http://localhost:8080
HTTP_DST_PROXY	HTTP Proxy to use when connecting to DST_REPO	No, default: ``	http://localhost:8080
HTTP_ALLOW_TOKENS_INSECURE	Allow authentication tokens over HTTP. IMPORTANT: This is very dangerous. Always use HTTPS!	No, default: false	true or false
ONCE	If set to true, only mirror the repository once	No, default: false	true or false
SLEEP_TIME	Time to sleep between synchronizations	No, default: 60s	30m
IGNORE_REFS_PATTERN	Don't mirror matching refs	No, default: refs/pull	refs/pull
TLS_TOFU	Enable / Disable TLS-Trust On First Use	No, default: false	true or false

Ignoring multiple refs is possible by separating them with space, but you also need to set MIRROR to false otherwise, sync will delete your branches. For example:

docker run \
--env IGNORE_REFS_PATTERN='refs/pull refs/heads/feat/ refs/heads/feature/' \
--env MIRROR=false