https://github.com/nikkolasg/backup
simple configurable backup tool in Go
https://github.com/nikkolasg/backup
backup golang rsync
Last synced: 3 months ago
JSON representation
simple configurable backup tool in Go
- Host: GitHub
- URL: https://github.com/nikkolasg/backup
- Owner: nikkolasg
- License: mit
- Created: 2020-01-26T23:16:03.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-06-05T18:45:41.000Z (almost 4 years ago)
- Last Synced: 2025-01-06T19:35:04.215Z (5 months ago)
- Topics: backup, golang, rsync
- Language: Go
- Size: 24.4 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.com/nikkolasg/backup)
[](https://codecov.io/gh/nikkolasg/backup)
# backup
backup is a simple and configurable wrapper of rsync to easily perform backups
and restore backups.
**Disclaimer**: this tool is not a production ready tool and you should use with
care and knowledge ! Always use `-f` flag before an operation to make a dry run.
## Installation
```
go get -u github.com/nikkolasg/backup
```
## Configuration
### Fresh Configuration
backup requires to know at least two informations:
* Local root: the absolute path from which where to backup files and folders. It
can be `/home/ubuntu` for example, or `/` if you wish to backup from your root
directory. This is required from rsync.
* Remote root: the absolute path on the destination. This must be understood as
rsync so it can be `/backup/ubuntu` or `[email protected]:/backup/ubuntu`
for a remote server destination.
```
backup init --remote --local
```
### Remote Configuration
backup can fetch the configuration already stored on a remote server (or
different path locally, whatever rsync accepts) and sets it up internally.
To do this, simply run the following:
```
backup init --from USER@HOST:PATH
```
Note the argument to `--from` can be anytihng rsync accepts.
### Config Folder
If you want to use a custom configuration folder, specify:
```
backup init --config
```
Note this flag must be specifed for all the subsequent commands.
#### Adding folders to upload
Adding folders / files is as easy as:
```
backup upload add ...
```
TODO: add `--download` to automatically add it to download.
#### Adding folders to download
You must specify all folders to download to backup.
You don't necessarily want to download all files you have backed up (for example
large files that you are fine keeping on the destination path).
```
backup download add ...
```
Note that `path1` **must** be included in the upload list to be valid. `backup`
doesn't allow to restore a file not tracked in upload yet.
TODO: make list argument
TODO: git restore