backy/README.md

# Backy - an application to manage backups

This app is in development, and is currently not stable. Expect core functionality to possiblly break.

## Installing

To install:

`go install git.andrewnw.xyz/CyberShell/backy@master`

This assumes you already have a working Go environment, if not please see [this page](https://golang.org/doc/install) first.

You can also download binaries [here](https://git.andrewnw.xyz/CyberShell/backy/releases) and [here](https://github.com/CybersShell/backy/releases).

## Features

- Allows easy configuration of executable commands

- Allows for commands to be run on many hosts over SSH

- Commands can be grouped in list to run in specific order

- Notifications on completion and failure

- Run in cron mode

- For any command, especially backup commands

To run a config:

`backy backup`

Or to use a specific file:
```backy backup -f /path/to/file```

If you leave the config path blank, the following paths will be searched in order:

- `./backy.yml`
- `./backy.yaml`
- `~/.config/backy.yml`
- `~/.config/backy.yaml`

Create a file at `~/.config/backy.yml`.

See the config file in the examples directory to configure it.
A runnable command - Added backup sub-command - Added better parsing for config file - Basis for notifications, no running after a command yet - Updated docs and added License 2023-01-17 06:55:28 +00:00			`# Backy - an application to manage backups`

			`This app is in development, and is currently not stable. Expect core functionality to possiblly break.`

doc updates 2023-01-17 08:21:55 +00:00			`## Installing`
A runnable command - Added backup sub-command - Added better parsing for config file - Basis for notifications, no running after a command yet - Updated docs and added License 2023-01-17 06:55:28 +00:00
doc updates 2023-01-17 08:21:55 +00:00			`To install:`

updated install command 2023-01-18 05:08:34 +00:00			`go install git.andrewnw.xyz/CyberShell/backy@master`
doc updates 2023-01-17 08:21:55 +00:00
			`This assumes you already have a working Go environment, if not please see [this page](https://golang.org/doc/install) first.`

Added command and list execution (#1), small touchups - Added exec command to execute individual commands - Added --lists, -l flag to backup command - Run command lists (#1) - Small touchups and documentation 2023-01-20 08:42:52 +00:00			`You can also download binaries [here](https://git.andrewnw.xyz/CyberShell/backy/releases) and [here](https://github.com/CybersShell/backy/releases).`

			`## Features`

added new features - expanding `environment` vars in cmd section - support for connecting to one proxy/bastion host - better notification text layout - better error message on private key failing to open 2023-02-12 05:50:19 +00:00			`- Allows easy configuration of executable commands`
Added command and list execution (#1), small touchups - Added exec command to execute individual commands - Added --lists, -l flag to backup command - Run command lists (#1) - Small touchups and documentation 2023-01-20 08:42:52 +00:00
added new features - expanding `environment` vars in cmd section - support for connecting to one proxy/bastion host - better notification text layout - better error message on private key failing to open 2023-02-12 05:50:19 +00:00			`- Allows for commands to be run on many hosts over SSH`
Added command and list execution (#1), small touchups - Added exec command to execute individual commands - Added --lists, -l flag to backup command - Run command lists (#1) - Small touchups and documentation 2023-01-20 08:42:52 +00:00
added new features - expanding `environment` vars in cmd section - support for connecting to one proxy/bastion host - better notification text layout - better error message on private key failing to open 2023-02-12 05:50:19 +00:00			`- Commands can be grouped in list to run in specific order`

			`- Notifications on completion and failure`

			`- Run in cron mode`

			`- For any command, especially backup commands`
Added command and list execution (#1), small touchups - Added exec command to execute individual commands - Added --lists, -l flag to backup command - Run command lists (#1) - Small touchups and documentation 2023-01-20 08:42:52 +00:00
doc updates 2023-01-17 08:21:55 +00:00			`To run a config:`

			`backy backup`

			`Or to use a specific file:`
added some features - Added `cron` command to run lists with `cron` time specifed - Changed `-c` flag to `-f` flag for passing config file - Modified some config keys - cmdArgs -> Args - Got rid of `hosts.config` - better SSH handling - respects values in config file 2023-02-02 05:45:23 +00:00			```backy backup -f /path/to/file```
doc updates 2023-01-17 08:21:55 +00:00
			`If you leave the config path blank, the following paths will be searched in order:`

added new features - expanding `environment` vars in cmd section - support for connecting to one proxy/bastion host - better notification text layout - better error message on private key failing to open 2023-02-12 05:50:19 +00:00			- `./backy.yml`
doc updates 2023-01-17 08:21:55 +00:00			- `./backy.yaml`
added new features - expanding `environment` vars in cmd section - support for connecting to one proxy/bastion host - better notification text layout - better error message on private key failing to open 2023-02-12 05:50:19 +00:00			- `~/.config/backy.yml`
doc updates 2023-01-17 08:21:55 +00:00			- `~/.config/backy.yaml`
A runnable command - Added backup sub-command - Added better parsing for config file - Basis for notifications, no running after a command yet - Updated docs and added License 2023-01-17 06:55:28 +00:00
added new features - expanding `environment` vars in cmd section - support for connecting to one proxy/bastion host - better notification text layout - better error message on private key failing to open 2023-02-12 05:50:19 +00:00			Create a file at `~/.config/backy.yml`.

			`See the config file in the examples directory to configure it.`