gitmirror

(β˜… 90)

A web UI to help mirror GitHub repos to Gitea - including releases, issues, PR, and wikis

  • .env.example
  • .gitignore
  • config.json
  • config.json.example
  • docker-compose.yml
  • Dockerfile
  • FUTURE_ENHANCEMENTS.md
  • LICENSE
  • pytest.ini
  • README.md
  • requirements.txt
  • run-tests.sh
  • setup.py
  • start.sh
  • test-docker.sh
  • test-requirements.txt

# Installation Guide

1. Get the code
git clone https://github.com/jonasrosland/gitmirror

Downloads the entire project code from GitHub to your computer.

cd gitmirror

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker-compose up -d

Runs the command against the services defined in the compose file.

docker-compose run --rm mirror

Runs the command against the services defined in the compose file.

docker-compose run --rm mirror mirror owner/repo gitea_owner gitea_repo

Runs the command against the services defined in the compose file.

docker-compose run --rm mirror mirror --mirror-metadata

Runs the command against the services defined in the compose file.

docker-compose run --rm mirror mirror --force-recreate

Runs the command against the services defined in the compose file.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install -r test-requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

python -m pytest tests/unit -v

Runs the Python script (or module).

python -m pytest tests/integration -v

Runs the Python script (or module).

python -m pytest --cov=gitmirror --cov-report=term-missing

Runs the Python script (or module).

docker-compose run --rm web python -m pytest

Runs the command against the services defined in the compose file.

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation