mirror-to-gitea/README.md

# Mirror your github repositories to your gitea server

## Badges

[![image pulls](https://img.shields.io/docker/pulls/jaedle/mirror-to-gitea.svg)](https://cloud.docker.com/repository/docker/jaedle/mirror-to-gitea)
[![microbadger analysis](https://images.microbadger.com/badges/image/jaedle/mirror-to-gitea.svg)](https://microbadger.com/images/jaedle/mirror-to-gitea "Get your own image badge on microbadger.com")

## Description

This script mirrors automatically the public repositories from a github-user or github-organization to your gitea server.
It will - once started - create a mirrored repository under a given token for a gitea user fully automatically.

Example:
A github user `github-user` has public repositories `dotfiles` and `zsh-config`.
Starting the script with a gitea token for the account `gitea-user` will create the following mirror repositories:

- github.com/github-user/dotfiles &larr; some-gitea.url/gitea-user/dotfiles
- github.com/github-user/zsh-config &larr; some-gitea.url/zsh-config/dotfiles

The mirror settings are default by your gitea instance.

## Prerequisites

- Something to mirror (a github user or organization with public repos)
- Gitea instance up and running
- User for Gitea with generated token
- Docker

## Run it

```sh
docker container run \
 -d \
 --restart always \
 -e GITHUB_USERNAME=github-user \
 -e GITEA_URL=https://some-gitea.url \
 -e GITEA_TOKEN=please-exchange-with-token \
 jaedle/mirror-to-gitea:latest
```

This will a spin up a docker container running infinite which will try to mirror all your repositories once every hour to your gitea server.

### Parameters

- `GITHUB_USERNAME` name of user or organization which public repos should be mirrored
- `GITHUB_TOKEN` [GitHub personal access token](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token) (optional)
- `GITEA_URL` url of your gitea server
- `GITEA_TOKEN` token for your gitea user

## Things to do

- refactoring
- think about how to test
- configurable interval
- better logging
- use github token to solve problems with rate limits
- add gitlab support
- and so on..
initial commit 2019-03-09 12:47:07 +00:00			`# Mirror your github repositories to your gitea server`

fix markdown errors 2019-03-09 13:09:05 +00:00			`## Badges`

add badges 2019-03-09 13:05:29 +00:00			`[![image pulls](https://img.shields.io/docker/pulls/jaedle/mirror-to-gitea.svg)](https://cloud.docker.com/repository/docker/jaedle/mirror-to-gitea)`
			`[![microbadger analysis](https://images.microbadger.com/badges/image/jaedle/mirror-to-gitea.svg)](https://microbadger.com/images/jaedle/mirror-to-gitea "Get your own image badge on microbadger.com")`
Add token 2019-03-09 13:01:04 +00:00
fix markdown errors 2019-03-09 13:09:05 +00:00			`## Description`
Add token 2019-03-09 13:01:04 +00:00
add description on interval 2019-03-09 13:27:21 +00:00			`This script mirrors automatically the public repositories from a github-user or github-organization to your gitea server.`
initial commit 2019-03-09 12:47:07 +00:00			`It will - once started - create a mirrored repository under a given token for a gitea user fully automatically.`

			`Example:`
			A github user `github-user` has public repositories `dotfiles` and `zsh-config`.
			Starting the script with a gitea token for the account `gitea-user` will create the following mirror repositories:

			`- github.com/github-user/dotfiles ← some-gitea.url/gitea-user/dotfiles`
			`- github.com/github-user/zsh-config ← some-gitea.url/zsh-config/dotfiles`

			`The mirror settings are default by your gitea instance.`

			`## Prerequisites`

			`- Something to mirror (a github user or organization with public repos)`
			`- Gitea instance up and running`
			`- User for Gitea with generated token`
			`- Docker`

			`## Run it`

			```sh
			`docker container run \`
			`-d \`
			`--restart always \`
fix documentation flaws 2019-03-09 12:49:37 +00:00			`-e GITHUB_USERNAME=github-user \`
initial commit 2019-03-09 12:47:07 +00:00			`-e GITEA_URL=https://some-gitea.url \`
			`-e GITEA_TOKEN=please-exchange-with-token \`
			`jaedle/mirror-to-gitea:latest`
			```

add description on interval 2019-03-09 13:27:21 +00:00			`This will a spin up a docker container running infinite which will try to mirror all your repositories once every hour to your gitea server.`

initial commit 2019-03-09 12:47:07 +00:00			`### Parameters`

fix documentation flaws 2019-03-09 12:49:37 +00:00			- `GITHUB_USERNAME` name of user or organization which public repos should be mirrored
optionally use GitHub access token to prevent rate limiting 2020-10-25 20:10:59 +00:00			- `GITHUB_TOKEN` [GitHub personal access token](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token) (optional)
initial commit 2019-03-09 12:47:07 +00:00			- `GITEA_URL` url of your gitea server
			- `GITEA_TOKEN` token for your gitea user

			`## Things to do`

add more things to do 2019-03-09 13:18:37 +00:00			`- refactoring`
			`- think about how to test`
initial commit 2019-03-09 12:47:07 +00:00			`- configurable interval`
			`- better logging`
			`- use github token to solve problems with rate limits`
			`- add gitlab support`
			`- and so on..`