Initial README
This commit is contained in:
parent
ebde757e5b
commit
14639a92c3
31
README.md
31
README.md
|
@ -1,2 +1,31 @@
|
|||
# borgocli
|
||||
# borgocli (borgbackup golang command line interface)
|
||||
A little binary to help with borgbackup.
|
||||
|
||||
## Install
|
||||
|
||||
Install this with go get:
|
||||
|
||||
```
|
||||
go get git.jcg.re/jcgruenhage/borgocli.git
|
||||
```
|
||||
|
||||
After installing it, you need to rename the binary or use borgocli.git instead of borgocli in the commands below.
|
||||
|
||||
The .git extension is still needed, because this git host does not support go meta-tags (yet). See [this issue on github for more info](https://github.com/go-gitea/gitea/issues/1485).
|
||||
|
||||
## Commands
|
||||
### borgocli generate authorized_keys
|
||||
|
||||
This generates an authorized_keys file out of a json file describing the allowed hosts, to be used with
|
||||
[borg serve](https://borgbackup.readthedocs.io/en/stable/usage.html#borg-serve).
|
||||
|
||||
**Usage**:
|
||||
```
|
||||
borgocli generate authorized_keys path/to/hosts.json >> ~/.ssh/authorized_keys
|
||||
```
|
||||
|
||||
If you want to overwrite your existing authorized_keys file, replace >> with >. For an example of the json file, see [example.json](https://git.jcg.re/jcgruenhage/borgocli/src/master/generate/authorized_keys/example.json).
|
||||
|
||||
|
||||
|
||||
This is everything for now, but I hope to extend that later. This might get some functionality only useful to my docker images, since that is what I am writing this for.
|
||||
|
|
Loading…
Reference in a new issue