docker-svn2git-mirror

KO | EN

gitlite — search

#javascript #hacktoberfest #go #golang #machine-learning #rust #linux #docker #macos #java #cli #vue #openai #open-source

docker-svn2git-mirror

(★ 15)

🐳 Docker image to mirror SVN repositories to Git periodically

docker-svn2git-mirror Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

## :warning: Abandoned project

This project is not maintained anymore and is abandoned. Feel free to fork and make your own changes if needed.

## About

🐳 Docker image to mirror SVN repositories to Git periodically based on Alpine and [svn2git](https://github.com/nirvdrum/svn2git). 
If you are interested, [check out](https://hub.docker.com/r/crazymax/) my other 🐳 Docker images!

💡 Want to be notified of new releases? Check out 🔔 [Diun (Docker Image Update Notifier)](https://github.com/crazy-max/diun) project!

## Infos

You can mirror multi SVN repositories through a configuration file (see below). When a repository is initialized, a SSH key is created. You will then only have to add the public key `id_rsa.pub` on the remote Git server to make the synchronization work. The volume `/data` is mounted to persist SSH keys and repositories.

## Docker

### Multi-platform image

Following platforms for this image are available:

```
$ docker run --rm mplatform/mquery crazymax/svn2git-mirror:latest
Image: crazymax/svn2git-mirror:latest
 * Manifest List: Yes
 * Supported platforms:
   - linux/amd64
   - linux/arm/v6
   - linux/arm/v7
   - linux/arm64
   - linux/386
   - linux/ppc64le
   - linux/s390x
```

### Environment variables

* `TZ` : Timezone assigned to the container (default `UTC`)
* `PUID` : svn2git-mirror user id (default `1000`)
* `PGID` : svn2git-mirror group id (default `1000`)

### Volumes

* `/data` : Contains SSH keys and repositories

## Configuration

This docker image works through a simple [config.json](.res/config.json) file :

* **id** : The name of the repository for example without special chars and spaces. **MUST BE UNIQUE**.
* **cron** : [Cron expression](https://crontab.guru/).
* **svn2git.repo** : SVN repo uri.
* **svn2git.username** : SVN repo username.
* **svn2git.password** : SVN repo password.
* **svn2git.options** : Options you can pass to [svn2git](https://github.com/nirvdrum/svn2git#options-reference) on init.
* **git.user** : Git server user (git).
* **git.repo** : Git repo to mirror with.
* **git.hostname** : Git server hostname.
* **git.port** : Git server SSH port.
* **authors** : List of authors to convert from SVN to Git format. More info [here](https://github.com/nirvdrum/svn2git#authors).

In the following example, trunk, branches and tags of SVN repository `https://svn.code.sf.net/p/ant-contrib/code/` will be synchronize with Git repository `github.com/crazy-max/ant-contrib` every **15 minutes** and some authors will be converted.

```json
[
 {
 "id": "ant-contrib",
 "cron": "*/15 * * * *",
 "svn2git": {
 "repo": "https://svn.code.sf.net/p/ant-contrib/code/",
 "username": "",
 "password": "",
 "options": "--trunk ant-contrib/trunk --branches ant-contrib/branches --tags ant-contrib/tags"
 },
 "git": {
 "user": "git",
 "hostname": "github.com",
 "port": 22,
 "repo": "crazy-max/ant-contrib"
 },
 "authors": [
 {
 "svn": "bodewig",
 "git": "Stefan Bodewig <stefan.bodewig@freenet.de>"
 },
 {
 "svn": "carnold",
 "git": "carnold <carnold@apache.org>"
 }
 ]
 }
]
```

## Usage

> :warning: You have to create the configuration file `config.json` before running the container. See below.

### Docker Compose

Docker compose is the recommended way to run this image. You can use the following [docker compose template](examples/compose/docker-compose.yml), then run the container :

```bash
$ docker-compose up -d
$ docker-compose logs -f
```

### Command line

You can also use the following minimal command :

```bash
$ docker run -d --name svn2git-mirror \
  -e TZ="Europe/Paris" \
  -v "$(pwd)/data:/data" \
  -v "$(pwd)/config.json:/etc/svn2git-mirror/config.json" \
  crazymax/svn2git-mirror:latest
```

## Notes

### Retrieve SVN authors

If you need a jump start on figuring out what users made changes in your svn repositories, you can use the following command based on the example below :

```
$ docker-compose exec svn2git_mirror svn_authors <id>
bodewig
carnold
darius42
deanhiller
jonkri
mattinger
peterkittreilly
slip_stream
```

> Replace `<id>` to match an existing one in `config.json`.

### Retrieve the SSH public key

To retrieve the SSH public key `id_rsa.pub` to make the synchronization work on your Git server, enter the following command :

```
$ docker-compose exec svn2git_mirror git_pubkey <id>
ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDf5hIKe5v0TNdciiVBQRImyE3NtOuOw/q0arJOWT8OrVw9w/kYWIT02QGRDHNxczY5np512/zGXfIbXG/oo4sRdN38Q69sGVkpI6sBAXYNfBPFHYDgShu/pOGAg+jVOwJnKvq94HiXNL6CbCsyEwxWScG1FcK5VPNv0njqxmMq9lqgEAZvrbuBzGT4MrOMdTBuOdAqzDDALzCDngKV4O0Rr7q/9SUSUOvgOgRoULH+Dgt4KJObtit3xhsPWMvqN0OvxziGdwJW1H2wmsmIvxaQbSZfgwR/qAnicXBvHovLrgfXJnf1WFxDjJsnP+ORQ4XbdYieWxz70JMzphLnKhkT root@a7d42ca39fc2
```

> Replace `<id>` to match an existing one in `config.json`.

### Mirroring with Github

To mirror with a [Github](https://github.com) repository, you have to use a [deploy key](https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys) on the target Github repository :

![](https://raw.githubusercontent.com/crazy-max/docker-svn2git-mirror/master/.res/github.png)

> Do not forget to check **Allow write access**.

## How can I help ?

All kinds of contributions are welcome :raised_hands:! The most basic way to show your support is to star :star2: the project, or to raise issues :speech_balloon: You can also support this project by [**becoming a sponsor on GitHub**](https://github.com/sponsors/crazy-max) :clap: or by making a [Paypal donation](https://www.paypal.me/crazyws) to ensure this journey continues indefinitely! :rocket:

Thanks again for your support, it is much appreciated! :pray:

## License

MIT. See `LICENSE` for more details.

docker-svn2git-mirror

docker-svn2git-mirror Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

docker-svn2git-mirror

docker-svn2git-mirror Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README