https://github.com/tulir/maumirror

A GitHub repo mirroring system using webhooks
https://github.com/tulir/maumirror

git git-mirror github github-webhooks mirror mirroring webhook

Last synced: 2 months ago
JSON representation

A GitHub repo mirroring system using webhooks

• Host: GitHub
• URL: https://github.com/tulir/maumirror
• Owner: tulir
• License: agpl-3.0
• Created: 2019-07-27T19:10:25.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-12-26T19:10:22.000Z (about 3 years ago)
• Last Synced: 2024-10-04T18:46:59.247Z (3 months ago)
• Topics: git, git-mirror, github, github-webhooks, mirror, mirroring, webhook
• Language: Go
• Homepage: https://maunium.net/go/maumirror
• Size: 53.7 KB
• Stars: 7
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# maumirror

A GitHub repo mirroring system using webhooks.

Mirrored to [mau.dev/tulir/maumirror](https://mau.dev/tulir/maumirror) (using maumirror, of course) for CI.

Support room on [Matrix](https://matrix.org): [#maunium:maunium.net](https://matrix.to/#/#maunium:maunium.net)

(bridged to Telegram: [t.me/maunium](https://t.me/maunium))

## Running

### Plain

0. Build with `go build` or download a build from [mau.dev/tulir/maumirror](https://mau.dev/tulir/maumirror/pipelines)

   ([latest build direct link](https://mau.dev/tulir/maumirror/-/jobs/artifacts/master/raw/maumirror?job=build))

1. Copy `example-config.yaml` to `config.yaml` and configure

2. Run `./maumirror`

### Docker (compose)

```yaml

version: "3.7"

services:

  maumirror:

    image: dock.mau.dev/tulir/maumirror

    restart: unless-stopped

    volumes:

    - /var/maumirror:/data

    - /etc/maumirror:/config

    - /etc/maumirror/.ssh:/home/maumirror/.ssh

```

0. Install [docker](https://docs.docker.com/install/) and [docker-compose](https://docs.docker.com/compose/install/)

1. Copy `example-config.yaml` to `/etc/maumirror/config.yaml` and configure

2. Create `docker-compose.yml` with the content above

3. Ensure the volumes have correct permissions: `sudo chown 29321.29321 -R /etc/maumirror /var/maumirror`

4. Start with `docker-compose up -d`