aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 72f0dc19a612a478703bbe0470eeef1feb5fa46b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# git-mirror

![Rust][github-actions-badge]

**git-mirror** is a command-line program to keep local git mirrors up to date with their origin.

## Configuration

### Example configuration file
```toml
default_path = "/srv/git"

[[projects]]
url = "https://github.com/Bond-009/git-mirror.git"

[[projects]]
url = "https://git.zx2c4.com/cgit"
description = "A hyperfast web frontend for git repositories written in C."
```

### Example crontab entry
Execute git-mirror every 15 with the given config.
`*/15 * * * * git-mirror -c /srv/git/config.toml`

[github-actions-badge]: https://github.com/Bond-009/git-mirror/workflows/Rust/badge.svg