git-sync-service

Git Sync Service

A service for synchronizing Git repositories across different platforms (GitHub / GitLab / Gitea / Gitee / GitCode / AtomGit / Tencent CodeHub / custom).

Features

• Multi-platform Git synchronization
• Scheduled sync with cron support
• Webhook-based real-time sync
• RESTful API (Hertz + Thrift IDL-driven via hz)
• Operation log (audit) for all mutating actions
• SQLite and MySQL database support
• Shared X-API-Key authentication

Installation

From Release

Download the latest binary from Releases.

From Source

git clone https://github.com/yi-nology/git-sync-service.git
cd git-sync-service
go build -o git-sync-service .

Quick Start

# 1. Required: encryption key for credential storage
export ENCRYPTION_KEY="$(openssl rand -base64 32)"

# 2. Configure conf/config.yaml (see Configuration below)

# 3. Run
./git-sync-service
# or: make run

The HTTP server listens on http://0.0.0.0:8890 by default. The dashboard frontend talks to /api/v1/*.

Configuration

Environment Variable

openssl rand -base64 32     # generate a secure key
export ENCRYPTION_KEY="..." # set it before starting the service

Config File (conf/config.yaml)

server:
  host: 0.0.0.0
  port: 8890
  mode: debug              # debug | release
  api_key: "your-api-key"  # clients must send this as X-API-Key for /api/v1/*

database:
  driver: sqlite           # sqlite | mysql
  dsn: data/git_sync.db    # sqlite path; or mysql: "user:pass@tcp(127.0.0.1:3306)/git_sync?charset=utf8mb4&parseTime=True"
  max_idle_conns: 10
  max_open_conns: 100

redis:
  addr: 127.0.0.1:6379
  password: ""
  db: 0

git:
  backend: gogit           # gogit | go-git
  temp_dir: /tmp/git-sync

sync:
  max_concurrent: 5
  default_timeout: 300     # seconds
  retry_count: 3

webhook:
  rate_limit: 100          # requests/min per source
  max_body_size: 10485760  # 10 MiB

log:
  level: info              # debug | info | warn | error
  format: json             # json | console

API

All /api/v1/* endpoints require the X-API-Key header (value = server.api_key). /ping and /health are public. Responses use the envelope:

{ "code": 200, "message": "success", "data": { ... }, "timestamp": 1786530762 }

Endpoints

Examples

# operation logs (with today/week/total stats)
curl -H "X-API-Key: your-api-key" \
  "http://localhost:8890/api/v1/logs/operations?page=1&page_size=10"

# list platforms
curl -H "X-API-Key: your-api-key" http://localhost:8890/api/v1/platforms

# create a platform
curl -X POST -H "X-API-Key: your-api-key" -H "Content-Type: application/json" \
  http://localhost:8890/api/v1/platform/create \
  -d '{"name":"GitHub","type":"github","access_token":"ghp_xxx","is_default":true}'

# system status
curl -H "X-API-Key: your-api-key" http://localhost:8890/api/v1/system/status

Development

go mod tidy
make test              # run tests
make build             # build
golangci-lint run      # lint (config in .golangci.yml)

Code Generation (Hertz / hz)

Routing, models, and handler scaffolds are generated from the Thrift IDL under idl/. After editing the IDL, regenerate with the exact toolchain so output matches the committed code:

hz update -idl idl/git_sync.thrift --snake_tag

Requires thriftgo v0.4.3 and the --snake_tag flag. Newer thriftgo versions change struct-tag style (camelCase instead of snake_case) and would alter the JSON contract — pin to 0.4.3 + --snake_tag.

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Project Stats