aboutsummaryrefslogtreecommitdiffsponsor
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md64
1 files changed, 23 insertions, 41 deletions
diff --git a/README.md b/README.md
index a2ae660..d29bf78 100644
--- a/README.md
+++ b/README.md
@@ -27,7 +27,7 @@ gpg --import GPG-KEY
git commit verify-commit HEAD
```
-To verify the projects vendored depnendencies:
+To verify the projects vendored dependencies:
```
go mod verify
@@ -54,49 +54,31 @@ sudo GOBIN=/usr/local/sbin go build ./cmd/...
## Configuration
-Configuration is provided via json file format.
-
- - `min-interval` is the minimum time to wait before mirroring a project.
- - `max-interval` is the maximum time to wait before mirroring a project.
- - `mirrors` is the list of projects you want mirrored and how.
- - `rsync` for mirroring files.
- - `git` for mirroring project source code.
- - `github-assets` for mirroring Github project assets.
+Configuration is provided via [TOML](https://toml.io) file format.
Refer to the following example. Mirror will mirror each project at a random
interval between 1 and 24 hours.
```
-{
- "min-interval": "1h",
- "max-interval": "24h",
- "mirrors": [
- {
- "method": "rsync",
- "from": "rsync://mirrors.kernel.org/slackware/slackware64-15.0",
- "to": "/mirror/slackware/slackware64-15.0"
- },
- {
- "method": "rsync",
- "from": "rsync://mirrors.kernel.org/slackware/slackware-iso/slackware64-15.0-iso",
- "to": "/mirror/slackware/slackware64-15.0-iso"
- },
- {
- "method": "rsync",
- "from": "rsync://mirrors.kernel.org/slackware/slackware64-current",
- "to": "/mirror/slackware/slackware64-current"
- },
- {
- "method": "git",
- "from": "https://github.com/ytdl-org/youtube-dl",
- "to": "/srv/git/slackcoder/youtube-dl",
- "description": "Command-line program to download videos from YouTube.com and other video sites"
- },
- {
- "method": "github-assets",
- "from": "https://github.com/ytdl-org/youtube-dl",
- "to": "/mirror/youtube-dl"
- }
- ]
-}
+[global]
+# The minimum time to wait before mirroring.
+min_interval = "1h"
+# The maximum time to wait before mirroring.
+max_interval = "24h"
+
+[[mirrors]]
+method = "rsync"
+from = "rsync://mirrors.kernel.org/slackware/slackware64-current"
+to = "/mirror/slackware/slackware64-current"
+
+[[mirrors]]
+method = "git"
+from = "https://github.com/ytdl-org/youtube-dl"
+to = "/srv/git/slackcoder/youtube-dl"
+description = "Command-line program to download videos from YouTube.com and other video sites"
+
+[[mirrors]]
+method = "github-assets"
+from = "https://github.com/ytdl-org/youtube-dl"
+to = "/mirror/youtube-dl"
```