Install Backy

Mon, 01 Jan 0001 00:00:00 +0000

Binaries are available from the release page. Make sure to get the correct version for your system, which supports x86_64, ARM64, and i386.

Source Install

You can install from source. You will need Go installed.

Then run:

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

Once set, jump over to the config docs and start configuring your file.

Config File Definitions

Mon, 01 Jan 0001 00:00:00 +0000

Commands

The commands section is for defining commands. These can be run with or without a shell and on a host or locally.

See the commands documentation for further information.

commands:
  stop-docker-container:
    output: true # Optional and only when run in list and notifications are sent
    cmd: docker
    args:
      - compose
      - -f /some/path/to/docker-compose.yaml
      - down
    # if host is not defined, cmd will be run locally
    host: some-host 
  backup-docker-container-script:
    cmd: /path/to/script
    # The host has to be defined in the config file
    host: some-host
    environment:
      - FOO=BAR
      - APP=$VAR # defined in .env file in config directory
  shell-cmd:
    cmd: rsync
    shell: bash
    args:
      - -av
      - some-host:/path/to/data 
      - ~/Docker/Backups/docker-data
  script:
    type: scriptFile # run a local script on a remote host
    cmd: path/to/your/script.sh
    host: some-host  
  hostname:
    cmd: hostname

Lists

To execute groups of commands in sequence, use a list configuration.

Getting started on A tool for commands

Install Backy

Source Install

Config File Definitions

Commands

Lists