Skip to content

Commit db591ed

Browse files
committed
Add docker to readme
1 parent cb503f4 commit db591ed

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ A cli to pull all your git repositories for backup purposes. It is completely st
66

77
The latest version can be downloaded from the [releases page](https://github.com/ChappIO/git-backup/releases).
88

9-
## Configuration
9+
## Configuration File
1010

11-
Example Configuration:
11+
Example yaml Configuration:
1212
```yaml
1313
# The github section contains backup jobs for
1414
# GitHub and GitHub Enterprise
@@ -66,7 +66,7 @@ gitlab:
6666
url: https://gitlab.mydomain.com
6767
```
6868
69-
## Usage
69+
## Usage: CLI
7070
7171
```asciidoc
7272
Usage: git-backup
@@ -77,3 +77,13 @@ Options:
7777
-config.file string
7878
The path to your config file. (default "git-backup.yml")
7979
```
80+
81+
## Usage: Docker
82+
83+
First, create your [git-backup.yml file](#configuration-file) at `/path/to/your/backups`.
84+
85+
Then update your backups using the mounted volume.
86+
87+
```bash
88+
docker run --volume /path/to/backups:/backups ghcr.io/chappio/git-backup:latest
89+
```

0 commit comments

Comments
 (0)