Skip to content

Commit 90b53c2

Browse files
author
ronen
committed
updating README
1 parent 1a97d78 commit 90b53c2

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

README.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,21 @@ Backup your Github repos (pushing code online isn't a backup [Gitlab](https://ab
44

55
# Usage
66

7+
* First make sure to have an octo.edn file (see [configuration](#Confguration).
8+
* For private repos make sure to have an ssh key access from the current user account.
9+
710
```bash
8-
$ octo octo.edn
11+
$ octo backup octo.edn
12+
...
13+
# Once done the git bundles are under (per user/org)
14+
$ ls ~/workspace/narkisr/bundles
15+
aptly-docker.bundle
16+
basebox-packer.bundle
917
```
1018

1119
## Configuration
12-
octo.edn describes the users/orgs to backup and options for each:
20+
21+
The format of octo.edn is:
1322

1423
```clojure
1524
{
@@ -38,7 +47,7 @@ octo.edn describes the users/orgs to backup and options for each:
3847
}
3948
```
4049

41-
Where:
50+
Glossary:
4251

4352
* workspace: backup destination folder.
4453
* user: github user.
@@ -48,12 +57,12 @@ Where:
4857
* exclude: which repos not to back up.
4958
* layouts: mapping of the folder structure of backups.
5059

51-
## Backup Lifecycle
60+
## Backup lifecycle
5261

5362
Each repo:
5463

5564
1. Cloned into a bare repo using 'git clone --mirror'.
56-
2. Exported to a single file using 'git bundle create'.
65+
2. Exported to a single file using 'git bundle create'.
5766
3. Incremented using 'git remote update --prune' if it already clone.
5867

5968
# Install
@@ -62,10 +71,10 @@ Perquisites:
6271

6372
* JRE 1.8
6473
* Git binary
65-
* Ubuntu (Should work on any possix system but not tested)
74+
* Ubuntu (Should work on any posix system but not tested)
6675

6776
```bash
68-
$ wget ~/bin/
77+
$ wget
6978
```
7079

7180
# Copyright and license

0 commit comments

Comments
 (0)