CLI: added exec hosts subcommand list

This reverts commit b7d1be495ee8a67e658f19cc0f8473b2abaeee33.

.changes/unreleased/.gitkeep

@@ -0,0 +1 @@
+*.yaml

.changes/unreleased/Added-20250409-174528.yaml

@@ -0,0 +1,3 @@
+kind: Added
+body: 'feat: Package operation `versionCheck` supports regular expressions (see [regexp](https://pkg.go.dev/regexp) package for docs)'
+time: 2025-04-09T17:45:28.836497149-05:00

.changes/unreleased/Added-20250501-110745.yaml

@@ -0,0 +1,3 @@
+kind: Added
+body: 'Command lists: added `cmdLists.[name].notify` object'
+time: 2025-05-01T11:07:45.96164753-05:00

.changes/unreleased/Added-20250704-085917.yaml

@@ -0,0 +1,3 @@
+kind: Added
+body: Testing setup with Docker
+time: 2025-07-04T08:59:17.430373451-05:00

.changes/unreleased/Added-20250704-102126.yaml

@@ -0,0 +1,3 @@
+kind: Added
+body: 'CLI: add global flag --hostsConfig that allows hosts to be dynamic in relation to the main config'
+time: 2025-07-04T10:21:26.864635558-05:00

.changes/unreleased/Added-20250715-202303.yaml

@@ -0,0 +1,3 @@
+kind: Added
+body: 'CLI: Exec subcommand `hosts`. See documentation for more details.'
+time: 2025-07-15T20:23:03.647128713-05:00

.changes/unreleased/Added-20250723-220340.yaml

@@ -0,0 +1,3 @@
+kind: Added
+body: 'CLI: added `exec hosts` subcommand `list`'
+time: 2025-07-23T22:03:40.24191927-05:00

.changes/unreleased/Changed-20250321-090849.yaml

@@ -0,0 +1,3 @@
+kind: Changed
+body: 'Commands: `host` can now be `localhost` or `127.0.0.1` to run commands locally'
+time: 2025-03-21T09:08:49.871021144-05:00

.changes/unreleased/Changed-20250325-003357.yaml

@@ -0,0 +1,3 @@
+kind: Changed
+body: lists loaded from external files only if no list config present in current file
+time: 2025-03-25T00:33:57.039431409-05:00

.changes/unreleased/Changed-20250407-223020.yaml

@@ -0,0 +1,3 @@
+kind: Changed
+body: "`PackageManager.Parse` renamed to `ParseRemotePackageManagerVersionOutput`. This now returns arrays of PackageManagerCommon.Package and errors."
+time: 2025-04-07T22:30:20.342177323-05:00

.changes/unreleased/Changed-20250418-133440.yaml

@@ -0,0 +1,3 @@
+kind: Changed
+body: 'Internal: refactoring and renaming functions'
+time: 2025-04-18T13:34:40.842541658-05:00

.changes/unreleased/Changed-20250501-110534.yaml

@@ -0,0 +1,3 @@
+kind: Changed
+body: 'Commands: moved output-prefixed keys to the `commands.[name].output` object'
+time: 2025-05-01T11:05:34.90130087-05:00

.changes/unreleased/Changed-20250609-072601.yaml

@@ -0,0 +1,3 @@
+kind: Changed
+body: Change internal method name for better understanding
+time: 2025-06-09T07:26:01.819927627-05:00

.changes/unreleased/Changed-20250709-231919.yaml

@@ -0,0 +1,3 @@
+kind: Changed
+body: Improved error message for remote version package output
+time: 2025-07-09T23:19:19.431960446-05:00

.changes/unreleased/Fixed-20250418-095747.yaml

@@ -0,0 +1,3 @@
+kind: Fixed
+body: 'Command Lists: hooks now run correctly when commands finish'
+time: 2025-04-18T09:57:47.39035092-05:00

.changes/unreleased/Fixed-20250424-225711.yaml

@@ -0,0 +1,3 @@
+kind: Fixed
+body: Log file passed using `--log-file` correctly used
+time: 2025-04-24T22:57:11.592829277-05:00

.changes/v0.10.0.md

@@ -0,0 +1,16 @@
+## v0.10.0 - 2025-03-08
+### Added
+* Hooks: improved logging when executing
+* User commands: adding SSH keys using config key `userSshPubKeys`
+* directives: added support for fetching values using directive `%{externalSource:key}%`
+### Changed
+* Commands: if dir is not specified, run in config dir
+* FileDirective: use the config directory if path is not absolute
+* Host: changes to case of some keys
+* Notifications: added external directive to sensitive keys
+### Fixed
+* LocalFetcher: return fetch error
+* Lists: load file key before attempting to load from current file
+* fix: host not in config file, but in ssh config, properly added to hosts struct
+* SSH: password authentication bugs
+* User commands: change user password works

.changes/v0.10.1.md

@@ -0,0 +1,8 @@
+## v0.10.1 - 2025-03-11
+### Added
+* UserCommands: add ssh public keys when running locally
+* UserCommands: add field CreateUserHome
+### Changed
+* UserCommands: create temp file when modifing password over SSH
+* UserCommands: change field name
+* Vault: keys are now referenced by `name`, and the actual data by `data`

.changes/v0.10.2.md

@@ -0,0 +1,6 @@
+## v0.10.2 - 2025-03-19
+### Added
+* Notifications: http service added
+* Variable support. Can be referenced with `%{var:nameOfVar}%` in select string fields.
+### Changed
+* vault: initialize vault before validating config

.changes/v0.3.0.md

@@ -0,0 +1,8 @@
+## v0.3.0 - 2023-01-07
+### Added
+* Getting environment variables and passwords from Vault (not tested yet)
+* Vault configuration to config (not tested yet)
+* Ability to run scripts from file on local machine on the remote host
+* Ability to get ouput in the notification of a list for individual commands or all commands
+### Changed
+* Make SSH connections close after all commands have been run; reuse previous connections if needed

.changes/v0.3.1.md

@@ -0,0 +1,3 @@
+## v0.3.1 - 2023-07-20
+### Changed
+* If an SSH session failed to be created, the command would fail. This would be caused when restarting the SSH host. The SSH connection is attempted to be created again. If successful, the command is executed normally.

.changes/v0.4.0.md

@@ -0,0 +1,13 @@
+## v0.4.0 - 2023-09-08
+
+### Added
+
+* Added `scriptEnvFile` to command object that allows one to specify an environment file (or any file really) when a `scriptFile` is run. Inspired by the practice of keeping environment variables and scripts or commands seperate.
+* Basis for listing commands
+
+### Changed
+
+* BREAKING: Notifications object now takes the form of service.id, where service can be "mail" or "matrix" and id is a unique id for the service.
+* BREAKING: Since the change to the notifications object, cmd-lists' inner map key 'notifications' must be of the form service.id. id must be defined for that service. See notifications docs for aviliable services.
+* Config parser is now the simpler Koanf - Keys are now case-sensitive
+* Log size limited to 50 Mb

.changes/v0.5.0.md

@@ -0,0 +1,9 @@
+## v0.5.0 - 2024-11-19
+### Added
+* Lists can now go in a file. See docs for more information.
+* commands.[name].type: script now opens `scriptEnvFile`.
+* Hooks for Commands.[name]. Error, success, and final. [#12]
+### Changed
+* GetKnownHosts is now a method of Host
+### Fixed
+* make command logger be used for errors, not just when running the command

.changes/v0.6.0.md

@@ -0,0 +1,4 @@
+## v0.6.0 - 2025-01-04
+### Added
+* Command Type Package - allows one to perform package operations [docs](https://backy.cybershell.xyz/config/packages/)
+* Exec subcommand `host` allows for parallel execution of commands on hosts. [See docs](https://backy.cybershell.xyz/cli/exec)

.changes/v0.6.1.md

@@ -0,0 +1,3 @@
+## v0.6.1 - 2025-01-04
+### Fixed
+* When running a list, hooks now run explicitly after the command executes. Fixed panic due to improper logic.

.changes/v0.7.0.md

@@ -0,0 +1,16 @@
+## v0.7.0 - 2025-02-11
+### Added
+* [feat]: package `packageOperation` option `checkVersion` implemented
+* user management added - see docs
+* Support for remote config sources. Only config file and list can be used for now.
+* Cache functionality - still a WIP
+* Flag `--s3-endpoint` for config file fetching from S3
+### Changed
+* Internal refactoring of config setup
+* Formatting and sending for notifications
+* name of `configfetcher` to `remotefetcher`
+* Flags that took comma-separated lists now have to be passed multiple times for each argument.
+* Hosts passed to `exec host` now checked against default SSH config files
+### Fixed
+* Parsing of remote URLs when determining list config file path
+* Incorrect error notification template value

.changes/v0.7.1.md

@@ -0,0 +1,3 @@
+## v0.7.1 - 2025-02-14
+### Fixed
+* Incorrect local config file loading logic caused files to not be detected

.changes/v0.7.2.md

@@ -0,0 +1,3 @@
+## v0.7.2 - 2025-02-14
+### Fixed
+* CI configs

.changes/v0.7.3.md

@@ -0,0 +1,3 @@
+## v0.7.3 - 2025-02-14
+### Changed
+* GoReleaser configs

.changes/v0.7.4.md

@@ -0,0 +1,5 @@
+## v0.7.4 - 2025-02-14
+### Changed
+* CI configs
+### Fixed
+* v0.7.1: Incorrect local config file loading logic caused files to not be detected

.changes/v0.7.5.md

@@ -0,0 +1,5 @@
+## v0.7.5 - 2025-02-14
+### Changed
+* CI configs
+### Fixed
+* v0.7.1: Incorrect local config file loading logic caused files to not be detected

.changes/v0.7.6.md

@@ -0,0 +1,4 @@
+## v0.7.6 - 2025-02-14
+### Fixed
+* v0.7.1: Incorrect local config file loading logic caused files to not be detected
+* CI configs

.changes/v0.7.7.md

@@ -0,0 +1,4 @@
+## v0.7.7 - 2025-02-14
+### Fixed
+* v0.7.1: Incorrect local config file loading logic caused files to not be detected
+* CI configs

.changes/v0.7.8.md

@@ -0,0 +1,4 @@
+## v0.7.8 - 2025-02-14
+### Fixed
+* Github CI config
+* v0.7.1: Incorrect local config file loading logic caused files to not be detected

.changes/v0.8.0.md

@@ -0,0 +1,6 @@
+## v0.8.0 - 2025-02-15
+### Changed
+* Breaking: `cmd-lists` key changed to `cmdLists`
+* Properly load list config
+* Config file loading properly errors
+* CI Configs

.changes/v0.9.0.md

@@ -0,0 +1,12 @@
+## v0.9.0 - 2025-02-28
+### Added
+* `list` command with subcommands `cmds` and `lists`
+* Deprecation and unsupported warnings for old config keys
+* CLI flag `--cmdStdOut` to output command's stdout/stderr to stdout
+* Command type `remoteScript`. See docs for more info.
+### Changed
+* change to enums for Command type
+* Cache now stores resources by URL hash for ease-of-lookup
+* Changed PackageOperation to enums
+### Fixed
+* Local command's `dir` full path is now found with home directory

.changes/v0.9.1.md

@@ -0,0 +1,3 @@
+## v0.9.1 - 2025-03-01
+### Changed
+* Use EnvVar AWS_PROFILE to get S3 profile

.frontmatter/database/mediaDb.json

@@ -0,0 +1 @@
+{}

.frontmatter/database/taxonomyDb.json

@@ -0,0 +1 @@
+{}

.github/workflows/release.yml

@@ -2,8 +2,9 @@ name: goreleaser
 
 on:
   push:
-    branches: [ master ] # your default branch if different
-    paths: [ CHANGELOG.md ] # your changelog file if different
+    # run only against tags
+    tags:
+      - '*'
 
 permissions:
   contents: write
@@ -14,24 +15,26 @@ jobs:
   goreleaser:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - run: git fetch --force --tags
-      - uses: actions/setup-go@v3
+      - uses: actions/setup-go@v5
         with:
-          go-version: '==1.19.5'
+          go-version: '1.23'
           cache: true
       # More assembly might be required: Docker logins, GPG, etc. It all depends
       # on your needs.
-      - uses: goreleaser/goreleaser-action@v4
+      - uses: olegtarasov/get-tag@v2.1.4
+        id: tagName
+        with:
+          # tagRegex: "foobar-(.*)"  # Optional. Returns specified group text as tag name. Full tag string is returned if regex is not defined.
+          tagRegexGroup: 1 # Optional. Default is 1.
+      - uses: goreleaser/goreleaser-action@v6
         with:
-          # either 'goreleaser' (default) or 'goreleaser-pro':
           distribution: goreleaser
-          version: latest
-          args: release --release-notes=".changes/$(go run backy.go version).md" -f .goreleaser/github.yml --clean
+          version: 2.7.0
+          args: release --release-notes=".changes/${{ env.GIT_TAG_NAME }}.md" -f .goreleaser/github.yml --clean
         env:
           GITHUB_TOKEN: ${{ secrets.GORELEASER_TOKEN }}
-          # Your GoReleaser Pro key, if you are using the 'goreleaser-pro'
-          # distribution:
-          # GORELEASER_KEY: ${{ secrets.GORELEASER_KEY }}
+          GIT_TAG_NAME: ${{ steps.tagName.outputs.tag }}

.gitignore

@@ -1,2 +1,10 @@
+!.changie.yaml
+!.changes/**
 
 dist/
+.codegpt
+
+*.log
+/*.sh
+/*.yaml
+/*.yml

.gitmodules

@@ -0,0 +1,7 @@
+[submodule "docs/themes/hugo-theme-relearn"]
+	path = docs/themes/hugo-theme-relearn
+	url = https://github.com/McShelby/hugo-theme-relearn.git
+
+[submodule "docs/themes/plausible-hugo"]
+	path = docs/themes/plausible-hugo
+	url = https://github.com/divinerites/plausible-hugo.git

.goreleaser/gitea.yml

@@ -1,3 +1,4 @@
+version: 2
 before:
   hooks:
     # You may remove this if you don't use go modules.
@@ -14,7 +15,7 @@ builds:
       - arm64
 
 archives:
-  - format: tar.gz
+  - formats: tar.gz
     # this name template makes the OS and Arch compatible with the results of uname.
     name_template: >-
       {{ .ProjectName }}_{{ .Version }}_
@@ -26,13 +27,13 @@ archives:
     # use zip for windows archives
     format_overrides:
     - goos: windows
-      format: zip
+      formats: [zip]
 checksum:
   name_template: 'checksums.txt'
 snapshot:
-  name_template: "{{ incpatch .Version }}-next"
+  version_template: "{{ incpatch .Version }}-next"
 changelog:
-  skip: false
+  disable: false
 
 gitea_urls:
   api: https://git.andrewnw.xyz/api/v1

.goreleaser/github.yml

@@ -1,5 +1,5 @@
-# This is an example .goreleaser.yml file with some sensible defaults.
 # Make sure to check the documentation at https://goreleaser.com
+version: 2
 before:
   hooks:
     # You may remove this if you don't use go modules.
@@ -16,7 +16,7 @@ builds:
       - arm64
 
 archives:
-  - format: tar.gz
+  - formats: tar.gz
     # this name template makes the OS and Arch compatible with the results of uname.
     name_template: >-
       {{ .ProjectName }}_{{ .Version }}_
@@ -28,11 +28,11 @@ archives:
     # use zip for windows archives
     format_overrides:
     - goos: windows
-      format: zip
+      formats: [zip]
 checksum:
   name_template: 'checksums.txt'
 snapshot:
-  name_template: "{{ incpatch .Version }}-next"
+  version_template: "{{ incpatch .Version }}-next"
 changelog:
   sort: asc
   filters:

.vscode/settings.json

@@ -1,5 +1,14 @@
 {
     "cSpell.words": [
-        "Cmds"
-    ]
+        "Cmds",
+        "remotefetcher",
+        "knadh",
+        "koanf",
+        "mattn",
+        "maunium",
+        "mautrix",
+        "nikoksr",
+        "Strs"
+    ],
+    "CodeGPT.apiKey": "CodeGPT Plus Beta"
 }

.woodpecker/gitea.yml

@@ -0,0 +1,19 @@
+steps:
+  golang:
+    image: golang:1.23
+    commands:
+      - go install github.com/goreleaser/goreleaser/v2@v2.7.0
+      - goreleaser release -f .goreleaser/gitea.yml --release-notes=".changes/$(go run backy.go version -V).md"
+    environment:
+      GITEA_TOKEN:
+        from_secret: gitea_token
+        
+    when:
+      event: tag
+  # release:
+  #   image: goreleaser/goreleaser
+  #   commands:
+
+when:
+  - event: tag
+    branch: master

.woodpecker/go-lint.yml

@@ -0,0 +1,14 @@
+steps:
+  build:
+    image: golang
+    commands:
+      - go build
+      - go test
+  release:
+    image: golangci/golangci-lint:v1.64.7
+    commands:
+      - golangci-lint run -v --timeout 5m
+
+when:
+  - event: push
+    branch: develop

.woodpecker/publish-docs.yml

@@ -0,0 +1,36 @@
+steps:
+  build:
+    image: hugomods/hugo:ci
+    commands:
+      - git submodule foreach 'git fetch origin; git checkout $(git describe --tags `git rev-list --tags --max-count=1`);'
+      - cd docs
+      - hugo mod get -u github.com/divinerites/plausible-hugo
+      - hugo mod get -u github.com/McShelby/hugo-theme-relearn@7.3.1
+      - hugo
+
+  deploy:
+    image: codingkoopa/git-rsync-openssh
+    commands:
+      - cd docs
+      - echo "nameserver 1.1.1.1" > /etc/resolv.conf
+      - mkdir ~/.ssh && chmod -R 700 ~/.ssh
+      # - apt update -y && apt install openssh-client rsync -y
+      - echo "$SSH_HOST_KEY" > ~/.ssh/known_hosts
+      - echo -e '#!/bin/sh\necho "$SSH_PASSPHRASE"' | tr -d '\r' > ~/.ssh/.print_ssh_password
+      # - cat ~/.ssh/.print_ssh_password
+      - chmod 700 ~/.ssh/.print_ssh_password
+      - eval $(ssh-agent -s)
+      - echo "$SSH_DEPLOY_KEY" | tr -d '\r' | DISPLAY=":0.0" SSH_ASKPASS=~/.ssh/.print_ssh_password setsid ssh-add -
+      - rsync -atv --delete --progress public/ backy@backy.cybershell.xyz:docs
+      - rsync -atv --delete --progress vangen/ backy@backy.cybershell.xyz:vangen-go
+    environment:
+      SSH_HOST_KEY:
+        from_secret: ssh_host_key
+      SSH_DEPLOY_KEY:
+        from_secret: ssh_deploy_key
+      SSH_PASSPHRASE:
+        from_secret: ssh_passphrase
+
+when:
+  - branch: master
+  - path: 'docs/**'

.woodpecker/vern.yml

@@ -1,10 +0,0 @@
-pipeline:
-  release:
-    image: goreleaser/goreleaser
-    commands:
-      - goreleaser release -f .goreleaser/vern.yml --release-notes=".changes/$(go run backy.go version).md"
-    secrets: [ gitea_token ]
-    when:
-      event: tag
-
-branches: master

CHANGELOG.md

@@ -6,6 +6,164 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html),
 and is generated by [Changie](https://github.com/miniscruff/changie).
 
 
+## v0.10.2 - 2025-03-19
+### Added
+* Notifications: http service added
+* Variable support. Can be referenced with `%{var:nameOfVar}%` in select string fields.
+### Changed
+* vault: initialize vault before validating config
+
+## v0.10.1 - 2025-03-11
+### Added
+* UserCommands: add ssh public keys when running locally
+* UserCommands: add field CreateUserHome
+### Changed
+* UserCommands: create temp file when modifing password over SSH
+* UserCommands: change field name
+* Vault: keys are now referenced by `name`, and the actual data by `data`
+
+## v0.10.0 - 2025-03-08
+### Added
+* Hooks: improved logging when executing
+* User commands: adding SSH keys using config key `userSshPubKeys`
+* directives: added support for fetching values using directive `%{externalSource:key}%`
+### Changed
+* Commands: if dir is not specified, run in config dir
+* FileDirective: use the config directory if path is not absolute
+* Host: changes to case of some keys
+* Notifications: added external directive to sensitive keys
+### Fixed
+* LocalFetcher: return fetch error
+* Lists: load file key before attempting to load from current file
+* fix: host not in config file, but in ssh config, properly added to hosts struct
+* SSH: password authentication bugs
+* User commands: change user password works
+
+## v0.9.1 - 2025-03-01
+### Changed
+* Use EnvVar AWS_PROFILE to get S3 profile
+
+## v0.9.0 - 2025-02-28
+### Added
+* `list` command with subcommands `cmds` and `lists`
+* Deprecation and unsupported warnings for old config keys
+* CLI flag `--cmdStdOut` to output command's stdout/stderr to stdout
+* Command type `remoteScript`. See docs for more info.
+### Changed
+* change to enums for Command type
+* Cache now stores resources by URL hash for ease-of-lookup
+* Changed PackageOperation to enums
+### Fixed
+* Local command's `dir` full path is now found with home directory
+
+## v0.8.0 - 2025-02-15
+### Changed
+* Breaking: `cmd-lists` key changed to `cmdLists`
+* Properly load list config
+* Config file loading properly errors
+* CI Configs
+
+## v0.7.8 - 2025-02-14
+### Fixed
+* Github CI config
+* v0.7.1: Incorrect local config file loading logic caused files to not be detected
+
+## v0.7.7 - 2025-02-14
+### Fixed
+* v0.7.1: Incorrect local config file loading logic caused files to not be detected
+* CI configs
+
+## v0.7.6 - 2025-02-14
+### Fixed
+* v0.7.1: Incorrect local config file loading logic caused files to not be detected
+* CI configs
+
+## v0.7.5 - 2025-02-14
+### Changed
+* CI configs
+### Fixed
+* v0.7.1: Incorrect local config file loading logic caused files to not be detected
+
+## v0.7.4 - 2025-02-14
+### Changed
+* CI configs
+### Fixed
+* v0.7.1: Incorrect local config file loading logic caused files to not be detected
+
+## v0.7.3 - 2025-02-14
+### Changed
+* GoReleaser configs
+
+## v0.7.2 - 2025-02-14
+### Fixed
+* CI configs
+
+## v0.7.1 - 2025-02-14
+### Fixed
+* Incorrect local config file loading logic caused files to not be detected
+
+## v0.7.0 - 2025-02-11
+### Added
+* [feat]: package `packageOperation` option `checkVersion` implemented
+* user management added - see docs
+* Support for remote config sources. Only config file and list can be used for now.
+* Cache functionality - still a WIP
+* Flag `--s3-endpoint` for config file fetching from S3
+### Changed
+* Internal refactoring of config setup
+* Formatting and sending for notifications
+* name of `configfetcher` to `remotefetcher`
+* Flags that took comma-separated lists now have to be passed multiple times for each argument.
+* Hosts passed to `exec host` now checked against default SSH config files
+### Fixed
+* Parsing of remote URLs when determining list config file path
+* Incorrect error notification template value
+
+## v0.6.1 - 2025-01-04
+### Fixed
+* When running a list, hooks now run explicitly after the command executes. Fixed panic due to improper logic.
+## v0.6.0 - 2025-01-04
+### Added
+* Command Type Package - allows one to perform package operations [docs](https://backy.cybershell.xyz/config/packages/)
+* Exec subcommand `host` allows for parallel execution of commands on hosts. [See docs](https://backy.cybershell.xyz/cli/exec)
+
+## v0.5.0 - 2024-11-19
+### Added
+* Lists can now go in a file. See docs for more information.
+* commands.[name].type: script now opens `scriptEnvFile`.
+* Hooks for Commands.[name]. Error, success, and final. [#12]
+### Changed
+* GetKnownHosts is now a method of Host
+### Fixed
+* make command logger be used for errors, not just when running the command
+
+## v0.4.0 - 2023-09-08
+
+### Added
+
+* Added `scriptEnvFile` to command object that allows one to specify an environment file (or any file really) when a `scriptFile` is run. Inspired by the practice of keeping environment variables and scripts or commands seperate.
+* Basis for listing commands
+
+### Changed
+
+* BREAKING: Notifications object now takes the form of service.id, where service can be "mail" or "matrix" and id is a unique id for the service.
+* BREAKING: Since the change to the notifications object, cmd-lists' inner map key 'notifications' must be of the form service.id. id must be defined for that service. See notifications docs for aviliable services.
+* Config parser is now the simpler Koanf - Keys are now case-sensitive
+* Log size limited to 50 Mb
+
+## v0.3.1 - 2023-07-20
+### Changed
+* If an SSH session failed to be created, the command would fail. This would be caused when restarting the SSH host. The SSH connection is attempted to be created again. If successful, the command is executed normally.
+
+## v0.3.0 - 2023-01-07
+### Added
+* Getting environment variables and passwords from Vault (not tested yet)
+* Vault configuration to config (not tested yet)
+* Ability to run scripts from file on local machine on the remote host
+* Ability to get ouput in the notification of a list for individual commands or all commands
+### Changed
+* Make SSH connections close after all commands have been run; reuse previous connections if needed
+
 ## 0.2.4 - 2023-02-18
 ### Added
 * Notifications now display errors and the output of the failed command.

Makefile

@@ -1,8 +0,0 @@
-build:
-	go build
-
-install:
-	go install .
-
-goreleaser-snapshot:
-	goreleaser -f .goreleaser/gitea.yml release --snapshot --clean

PLAN.md

@@ -1,3 +0,0 @@
-# Plan
-
-Find auth method, possibly using another package

README.md

@@ -1,16 +1,11 @@
+
 # Backy - an application to manage backups
 
-This app is in development, and is currently not stable. Expect core functionality to possiblly break.
+See the [install documentation](https://backy.cybershell.xyz/getting-started/install/index.html)
 
-## Installing
+## Security
 
-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).
+The latest version is currently the only supported version.
 
 ## Features
 
@@ -25,21 +20,3 @@ You can also download binaries [here](https://git.andrewnw.xyz/CyberShell/backy/
 - 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.  

backy.code-workspace

@@ -0,0 +1,27 @@
+{
+	"folders": [
+		{
+			"name": "backy",
+			"path": "."
+		}
+	],
+	"settings": {
+		"cSpell.words": [
+			"Autorestic",
+			"changie",
+			"Cmds",
+			"CMDSTDOUT",
+			"goreleaser",
+			"knadh",
+			"koanf",
+			"mattn",
+			"maunium",
+			"mautrix",
+			"nikoksr",
+			"packagemanagercommon",
+			"rawbytes",
+			"remotefetcher",
+			"Strs"
+		]
+	}
+}

cmd/.gitignore

@@ -1 +1,2 @@
-*.yaml
+*.yaml
+*.yml

cmd/backup.go

@@ -12,9 +12,9 @@ import (
 
 var (
 	backupCmd = &cobra.Command{
-		Use:   "backup [--lists=list1,list2]",
-		Short: "Runs commands defined in config file.",
-		Long:  "Backup executes commands defined in config file.\nUse the --lists flag to execute the specified commands. If not specified, all lists will be executed.",
+		Use:   "backup [--lists=list1 --lists list2 ... | -l list1 -l list2 ...]",
+		Short: "Runs commands defined in config file. Use -l flag multiple times to run multiple lists.",
+		Long:  "Backup executes commands defined in config file.\nUse the --lists or -l flag to execute the specified lists. If not flag is not given, all lists will be executed.",
 		Run:   Backup,
 	}
 )
@@ -23,14 +23,26 @@ var (
 var cmdLists []string
 
 func init() {
+	parseS3Config()
 
-	backupCmd.Flags().StringSliceVarP(&cmdLists, "lists", "l", nil, "Accepts comma-separated names of command lists to execute.")
+	backupCmd.Flags().StringArrayVarP(&cmdLists, "lists", "l", nil, "Accepts comma-separated names of command lists to execute.")
 
 }
 
 func Backup(cmd *cobra.Command, args []string) {
-	backyConfOpts := backy.NewOpts(cfgFile, backy.AddCommandLists(cmdLists))
+	backyConfOpts := backy.NewConfigOptions(configFile,
+		backy.AddCommandLists(cmdLists),
+		backy.SetLogFile(logFile),
+		backy.EnableCommandStdOut(cmdStdOut),
+		backy.SetHostsConfigFile(hostsConfigFile))
+
 	backyConfOpts.InitConfig()
-	config := backy.ReadConfig(backyConfOpts)
-	config.RunBackyConfig("")
+	backyConfOpts.ParseConfigurationFile()
+
+	backyConfOpts.RunListConfig("")
+	for _, host := range backyConfOpts.Hosts {
+		if host.SshClient != nil {
+			host.SshClient.Close()
+		}
+	}
 }

cmd/backup_test.go

@@ -0,0 +1,54 @@
+package cmd
+
+// import (
+// 	"bufio"
+// 	"encoding/json"
+// 	"os"
+// 	"os/exec"
+// 	"strings"
+// 	"testing"
+
+// 	"github.com/stretchr/testify/assert"
+// )
+
+// // TestConfigOptions tests the configuration options for the backy package.
+// func Test_ErrorHook(t *testing.T) {
+// 	configFile := "-f ../../tests/ErrorHook.yml"
+// 	logFile := "--log-file=ErrorHook.log"
+// 	backyCommand := exec.Command("go", "run", "../../backy.go", configFile, logFile, "backup")
+// 	backyCommand.Stderr = os.Stdout
+// 	backyCommand.Stdout = os.Stdout
+// 	err := backyCommand.Run()
+// 	assert.Nil(t, err)
+// 	os.Remove("ErrorHook.log")
+// 	logFileData, logFileErr := os.ReadFile("ErrorHook.log")
+// 	if logFileErr != nil {
+// 		assert.FailNow(t, logFileErr.Error())
+
+// 	}
+// 	var JsonData []map[string]interface{}
+// 	jsonScanner := bufio.NewScanner(strings.NewReader(string(logFileData)))
+
+// 	for jsonScanner.Scan() {
+// 		var jsonDataLine map[string]interface{}
+// 		err = json.Unmarshal(jsonScanner.Bytes(), &jsonDataLine)
+// 		assert.Nil(t, err)
+// 		JsonData = append(JsonData, jsonDataLine)
+// 	}
+// 	for _, v := range JsonData {
+// 		_, ok := v["error"]
+// 		if !ok {
+// 			assert.FailNow(t, "error does not exist\n")
+// 			// return
+// 		}
+// 	}
+// 	// t.Logf("%s", logFileData)
+// 	// t.Logf("%v", JsonData)
+// }
+
+// func TestBackupErrorHook(t *testing.T) {
+// 	logFile = "ErrorHook.log"
+
+// 	configFile = "../tests/ErrorHook.yml"
+
+// }

cmd/config.go

@@ -20,7 +20,7 @@ package cmd
 
 // func config(cmd *cobra.Command, args []string) {
 
-// 	opts := backy.NewOpts(cfgFile, backy.UseCron())
+// 	opts := backy.NewConfigOptions(configFile, backy.cronEnabled())
 // 	opts.InitConfig()
 
 // }

cmd/cron.go

@@ -9,16 +9,23 @@ import (
 var (
 	cronCmd = &cobra.Command{
 		Use:   "cron [flags]",
-		Short: "Runs command lists defined in config file.",
+		Short: "Starts a scheduler that runs lists defined in config file.",
 		Long:  `Cron starts a scheduler that executes command lists at the time defined in config file.`,
 		Run:   cron,
 	}
 )
 
 func cron(cmd *cobra.Command, args []string) {
+	parseS3Config()
+
+	opts := backy.NewConfigOptions(configFile,
+		backy.EnableCron(),
+		backy.SetLogFile(logFile),
+		backy.EnableCommandStdOut(cmdStdOut),
+		backy.SetHostsConfigFile(hostsConfigFile))
 
-	opts := backy.NewOpts(cfgFile, backy.UseCron())
 	opts.InitConfig()
+	opts.ParseConfigurationFile()
 
-	backy.ReadConfig(opts).Cron()
+	opts.Cron()
 }

cmd/exec.go

@@ -14,20 +14,30 @@ import (
 var (
 	execCmd = &cobra.Command{
 		Use:   "exec command ...",
-		Short: "Runs commands defined in config file.",
-		Long:  `Exec executes commands defined in config file.`,
+		Short: "Runs commands defined in config file in order given.",
+		Long:  `Exec executes commands defined in config file in order given.`,
 		Run:   execute,
 	}
 )
 
+func init() {
+	execCmd.AddCommand(hostExecCommand, hostsExecCommand)
+
+}
+
 func execute(cmd *cobra.Command, args []string) {
+	parseS3Config()
 
 	if len(args) < 1 {
-		logging.ExitWithMSG("Please provide a command to run. Pass --help to see options.", 0, nil)
+		logging.ExitWithMSG("Please provide a command to run. Pass --help to see options.", 1, nil)
 	}
 
-	opts := backy.NewOpts(cfgFile, backy.AddCommands(args))
+	opts := backy.NewConfigOptions(configFile,
+		backy.AddCommands(args),
+		backy.SetLogFile(logFile),
+		backy.EnableCommandStdOut(cmdStdOut),
+		backy.SetHostsConfigFile(hostsConfigFile))
 	opts.InitConfig()
-	// opts.InitMongo()
-	backy.ReadConfig(opts).ExecuteCmds(opts)
+	opts.ParseConfigurationFile()
+	opts.ExecuteCmds()
 }

cmd/host.go

@@ -0,0 +1,81 @@
+package cmd
+
+import (
+	"git.andrewnw.xyz/CyberShell/backy/pkg/backy"
+	"git.andrewnw.xyz/CyberShell/backy/pkg/logging"
+	"github.com/spf13/cobra"
+)
+
+var (
+	hostExecCommand = &cobra.Command{
+		Use:   "host [--command=command1 --command=command2 ... | -c command1 -c command2 ...] [--hosts=host1 --hosts=hosts2 ... | -m host1 -m host2 ...] ",
+		Short: "Runs command defined in config file on the hosts in order specified.",
+		Long:  "Host executes specified commands on the hosts defined in config file.\nUse the --commands or -c flag to choose the commands.",
+		Run:   Host,
+	}
+)
+
+// Holds list of hosts to run commands on
+var hostsList []string
+
+// Holds command list to run
+var cmdList []string
+
+func init() {
+
+	hostExecCommand.Flags().StringArrayVarP(&hostsList, "hosts", "m", nil, "Accepts space-separated names of hosts. Specify multiple times for multiple hosts.")
+	hostExecCommand.Flags().StringArrayVarP(&cmdList, "command", "c", nil, "Accepts space-separated names of commands. Specify multiple times for multiple commands.")
+	parseS3Config()
+
+}
+
+// cli input should be hosts and commands. Hosts are defined in config files.
+// commands can be passed by the following mutually exclusive options:
+//    1. as a list of commands defined in the config file
+//    2. stdin (on command line) (TODO)
+
+func Host(cmd *cobra.Command, args []string) {
+	backyConfOpts := backy.NewConfigOptions(configFile,
+		backy.SetLogFile(logFile),
+		backy.EnableCommandStdOut(cmdStdOut),
+		backy.SetHostsConfigFile(hostsConfigFile))
+	backyConfOpts.InitConfig()
+
+	backyConfOpts.ParseConfigurationFile()
+
+	// check CLI input
+	if hostsList == nil {
+		logging.ExitWithMSG("error: hosts must be specified", 1, &backyConfOpts.Logger)
+	}
+
+	for _, h := range hostsList {
+		if backy.IsHostLocal(h) {
+			continue
+		}
+		// check if h exists in the config file
+		_, hostFound := backyConfOpts.Hosts[h]
+		if !hostFound {
+			// check if h exists in the SSH config file
+			hostFoundInConfig, s := backy.DoesHostHaveHostName(h)
+			if !hostFoundInConfig {
+				logging.ExitWithMSG("host "+h+" not found", 1, &backyConfOpts.Logger)
+			}
+			if backyConfOpts.Hosts == nil {
+				backyConfOpts.Hosts = make(map[string]*backy.Host)
+			}
+			// create host with hostname and host
+			backyConfOpts.Hosts[h] = &backy.Host{Host: h, HostName: s}
+		}
+	}
+	if cmdList == nil {
+		logging.ExitWithMSG("error: commands must be specified", 1, &backyConfOpts.Logger)
+	}
+	for _, c := range cmdList {
+		_, cmdFound := backyConfOpts.Cmds[c]
+		if !cmdFound {
+			logging.ExitWithMSG("cmd "+c+" not found", 1, &backyConfOpts.Logger)
+		}
+	}
+
+	backyConfOpts.ExecCmdsOnHosts(cmdList, hostsList)
+}

cmd/hosts.go

@@ -0,0 +1,91 @@
+package cmd
+
+import (
+	"maps"
+	"slices"
+
+	"git.andrewnw.xyz/CyberShell/backy/pkg/backy"
+	"git.andrewnw.xyz/CyberShell/backy/pkg/logging"
+	"github.com/spf13/cobra"
+)
+
+var (
+	hostsExecCommand = &cobra.Command{
+		Use:   "hosts [--command=command1 --command=command2 ... | -c command1 -c command2 ...]",
+		Short: "Runs command defined in config file on the hosts in order specified.",
+		Long:  "Hosts executes specified commands on all the hosts defined in config file.\nUse the --commands or -c flag to choose the commands.",
+		Run:   Hosts,
+	}
+
+	hostsListExecCommand = &cobra.Command{
+		Use:   "list list1 list2 ...",
+		Short: "Runs lists in order specified defined in config file on all hosts.",
+		Long:  "Lists executes specified lists on all the hosts defined in hosts config.\nPass the names of lists as arguments after command.",
+		Run:   HostsList,
+	}
+)
+
+func init() {
+	hostsExecCommand.AddCommand(hostsListExecCommand)
+	parseS3Config()
+
+}
+
+// cli input should be hosts and commands. Hosts are defined in config files.
+// commands can be passed by the following mutually exclusive options:
+//    1. as a list of commands defined in the config file
+//    2. stdin (on command line) (TODO)
+
+func Hosts(cmd *cobra.Command, args []string) {
+	backyConfOpts := backy.NewConfigOptions(configFile,
+		backy.SetLogFile(logFile),
+		backy.EnableCommandStdOut(cmdStdOut),
+		backy.SetHostsConfigFile(hostsConfigFile))
+	backyConfOpts.InitConfig()
+
+	backyConfOpts.ParseConfigurationFile()
+
+	for _, h := range backyConfOpts.Hosts {
+
+		hostsList = append(hostsList, h.Host)
+	}
+
+	if cmdList == nil {
+		logging.ExitWithMSG("error: commands must be specified", 1, &backyConfOpts.Logger)
+	}
+	for _, c := range cmdList {
+		_, cmdFound := backyConfOpts.Cmds[c]
+		if !cmdFound {
+			logging.ExitWithMSG("cmd "+c+" not found", 1, &backyConfOpts.Logger)
+		}
+	}
+
+	backyConfOpts.ExecCmdsOnHosts(cmdList, hostsList)
+}
+
+func HostsList(cmd *cobra.Command, args []string) {
+	backyConfOpts := backy.NewConfigOptions(configFile,
+		backy.SetLogFile(logFile),
+		backy.EnableCommandStdOut(cmdStdOut),
+		backy.SetHostsConfigFile(hostsConfigFile))
+	backyConfOpts.InitConfig()
+
+	backyConfOpts.ParseConfigurationFile()
+
+	if len(args) == 0 {
+		logging.ExitWithMSG("error: no lists specified", 1, &backyConfOpts.Logger)
+	}
+
+	for _, l := range args {
+		_, listFound := backyConfOpts.CmdConfigLists[l]
+		if !listFound {
+			logging.ExitWithMSG("list "+l+" not found", 1, &backyConfOpts.Logger)
+		}
+	}
+
+	maps.DeleteFunc(backyConfOpts.CmdConfigLists, func(k string, v *backy.CmdList) bool {
+		return !slices.Contains(args, k)
+	})
+
+	backyConfOpts.ExecuteListOnHosts(args)
+}

cmd/list.go

@@ -0,0 +1,90 @@
+// backup.go
+// Copyright (C) Andrew Woodlee 2023
+// License: Apache-2.0
+
+package cmd
+
+import (
+	"git.andrewnw.xyz/CyberShell/backy/pkg/backy"
+	"git.andrewnw.xyz/CyberShell/backy/pkg/logging"
+
+	"github.com/spf13/cobra"
+)
+
+var (
+	listCmd = &cobra.Command{
+		Use:   "list [command]",
+		Short: "List commands, lists, or hosts defined in config file.",
+		Long:  "List commands, lists, or hosts defined in config file",
+	}
+
+	listCmds = &cobra.Command{
+		Use:   "cmds [cmd1 cmd2 cmd3...]",
+		Short: "List commands defined in config file.",
+		Long:  "List commands defined in config file",
+		Run:   ListCommands,
+	}
+	listCmdLists = &cobra.Command{
+		Use:   "lists [list1 list2 ...]",
+		Short: "List lists defined in config file.",
+		Long:  "List lists defined in config file",
+		Run:   ListCommandLists,
+	}
+)
+
+var listsToList []string
+var cmdsToList []string
+
+func init() {
+	listCmd.AddCommand(listCmds, listCmdLists)
+
+}
+
+func ListCommands(cmd *cobra.Command, args []string) {
+
+	// setup based on whats passed in:
+	//   - cmds
+	//   - lists
+	//   - if none, list all commands
+	if len(args) > 0 {
+		cmdsToList = args
+	} else {
+		logging.ExitWithMSG("Error: list cmds subcommand needs commands to list", 1, nil)
+	}
+
+	parseS3Config()
+
+	opts := backy.NewConfigOptions(configFile,
+		backy.SetLogFile(logFile),
+		backy.SetHostsConfigFile(hostsConfigFile))
+
+	opts.InitConfig()
+	opts.ParseConfigurationFile()
+
+	for _, v := range cmdsToList {
+		opts.ListCommand(v)
+	}
+}
+
+func ListCommandLists(cmd *cobra.Command, args []string) {
+
+	parseS3Config()
+
+	if len(args) > 0 {
+		listsToList = args
+	} else {
+		logging.ExitWithMSG("Error: lists subcommand needs lists", 1, nil)
+	}
+
+	opts := backy.NewConfigOptions(configFile,
+		backy.SetLogFile(logFile),
+		backy.SetHostsConfigFile(hostsConfigFile))
+
+	opts.InitConfig()
+	opts.ParseConfigurationFile()
+
+	for _, v := range listsToList {
+		opts.ListCommandList(v)
+	}
+
+}

cmd/root.go

@@ -13,8 +13,12 @@ import (
 
 var (
 	// Used for flags.
-	cfgFile string
-	verbose bool
+	configFile      string
+	hostsConfigFile string
+	verbose         bool
+	cmdStdOut       bool
+	logFile         string
+	s3Endpoint      string
 
 	rootCmd = &cobra.Command{
 		Use:   "backy",
@@ -32,9 +36,18 @@ func Execute() {
 }
 
 func init() {
+	rootCmd.PersistentFlags().StringVar(&logFile, "logFile", "", "log file to write to")
+	rootCmd.PersistentFlags().BoolVar(&cmdStdOut, "cmdStdOut", false, "Pass to print command output to stdout")
 
-	rootCmd.PersistentFlags().StringVarP(&cfgFile, "config", "f", "", "config file to read from")
+	rootCmd.PersistentFlags().StringVarP(&configFile, "config", "f", "", "config file to read from")
+	rootCmd.PersistentFlags().StringVar(&hostsConfigFile, "hostsConfig", "", "yaml hosts file to read from")
 	rootCmd.PersistentFlags().BoolVarP(&verbose, "verbose", "v", false, "Sets verbose level")
-
-	rootCmd.AddCommand(backupCmd, execCmd, cronCmd, versionCmd)
+	rootCmd.PersistentFlags().StringVar(&s3Endpoint, "s3Endpoint", "", "Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.")
+	rootCmd.AddCommand(backupCmd, execCmd, cronCmd, versionCmd, listCmd)
+}
+
+func parseS3Config() {
+	if s3Endpoint != "" {
+		os.Setenv("S3_ENDPOINT", s3Endpoint)
+	}
 }

cmd/version.go

@@ -7,19 +7,33 @@ import (
 	"github.com/spf13/cobra"
 )
 
-const versionStr = "0.2.4"
+const versionStr = "0.10.2"
 
 var (
 	versionCmd = &cobra.Command{
-		Use:   "version",
-		Short: "Prints the version and exits.",
+		Use:   "version [flags]",
+		Short: "Prints the version and exits",
+		Long:  "Prints the version and exits. No arguments just prints the version number only.",
 		Run:   version,
 	}
+	numOnly bool
+	vPre    bool
 )
 
+func init() {
+	versionCmd.PersistentFlags().BoolVarP(&numOnly, "num", "n", false, "Output the version number only.")
+	versionCmd.PersistentFlags().BoolVarP(&vPre, "vpre", "V", false, "Output the version with v prefixed.")
+}
+
 func version(cmd *cobra.Command, args []string) {
 
-	fmt.Printf("%s\n", versionStr)
+	if numOnly && !vPre {
+		fmt.Printf("%s\n", versionStr)
+	} else if vPre && !numOnly {
+		fmt.Printf("v%s\n", versionStr)
+	} else {
+		fmt.Printf("Backy version: %s\n", versionStr)
+	}
 
 	os.Exit(0)
 }

docs/.gitignore

@@ -0,0 +1,2 @@
+public/
+resources/_gen

docs/archetypes/default.md

@@ -0,0 +1,6 @@
+---
+title: "{{ replace .Name "-" " " | title }}"
+date: {{ .Date }}
+draft: true
+---
+

docs/config.yaml

@@ -0,0 +1,78 @@
+baseURL: https://backy.cybershell.xyz/
+languageCode: en-us
+title: A tool for commands
+theme:
+  - hugo-theme-relearn
+  - plausible-hugo
+outputs:
+  home:
+    - HTML
+    - RSS
+    - PRINT
+module:
+  imports:
+    - path: github.com/divinerites/plausible-hugo
+    - path: github.com/McShelby/hugo-theme-relearn
+params:
+  themeVariant:
+    - auto: []
+      identifier: relearn-auto
+      name: Relearn Light/Dark
+    - identifier: relearn-light
+    - identifier: relearn-dark
+    - identifier: relearn-bright
+    - auto:
+        - zen-light
+        - zen-dark
+      identifier: zen-auto
+      name: Zen Light/Dark
+    - identifier: zen-light
+    - identifier: zen-dark
+    - auto:
+        - learn
+        - neon
+      identifier: retro-auto
+      name: Retro Learn/Neon
+    - identifier: neon
+    - identifier: learn
+  plausible:
+    enable: true
+    domain: backy.cybershell.xyz
+    outbound_link: true
+    gitstar: false
+    selfhosted_domain: stats.andrewnw.com
+  author:
+    name: Andrew Woodlee
+    alwaysopen: false
+    editURL: ""
+    description: ""
+    showVisitedLinks: false
+    disableSearch: false
+    disableSearchHiddenPages: false
+    disableSeoHiddenPages: false
+    disableTagHiddenPages: false
+    disableAssetsBusting: false
+    disableGeneratorVersion: false
+    disableInlineCopyToClipBoard: false
+    disableShortcutsTitle: false
+    disableLandingPageButton: true
+    disableLanguageSwitchingButton: false
+    disableBreadcrumb: true
+    disableToc: false
+    math: true
+    customMathJaxURL: https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
+    mathJaxInitialize: "{}"
+    mermaid: true
+    customMermaidURL: https://unpkg.com/mermaid/dist/mermaid.min.js
+    mermaidInitialize: '{ "theme": "default" }'
+    disableSwagger: false
+    customSwaggerURL: https://unpkg.com/rapidoc/dist/rapidoc-min.js
+    swaggerInitialize: '{ "theme": "light" }'
+    disableNextPrev: true
+    ordersectionsby: weight
+    titleSeparator: "-"
+    collapsibleMenu: true
+    additionalContentLanguage:
+      - en
+    disableExplicitIndexURLs: false
+    externalLinkTarget: _blank

docs/content/_index.md

@@ -0,0 +1,32 @@
++++
+archetype = "home"
+title = "Backy"
++++
+
+Backy is a tool for automating data backup and remote command execution. It can work over SSH, and provides completion and failure notifications, error reporting, and more.
+
+Why the name Backy? Because I wanted an app for backups.
+
+View the [changelog here](https://git.andrewnw.xyz/CyberShell/backy/src/branch/master/CHANGELOG.md).
+
+{{% notice tip %}}
+Feel free to open a [PR](https://git.andrewnw.xyz/CyberShell/backy/pulls), raise an [issue](https://git.andrewnw.xyz/CyberShell/backy/issues "Open a Gitea Issue")(s), or request new feature(s).
+{{% /notice %}}
+
+## Features
+
+- Allows easy configuration of executable commands
+
+- Allows for running package operations
+
+- Allows configuring failure, success, and final hooks
+
+- 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

docs/content/cli/_index.md

@@ -0,0 +1,215 @@
+---
+title: CLI
+weight: 4
+---
+
+This page lists documentation for the CLI.
+
+## Backy 
+ 
+```
+Backy is a command-line application useful for configuring backups, or any commands run in sequence.
+
+Usage:
+  backy [command]
+
+Available Commands:
+  backup      Runs commands defined in config file. Use -l flag multiple times to run multiple lists.
+  completion  Generate the autocompletion script for the specified shell
+  cron        Starts a scheduler that runs lists defined in config file.
+  exec        Runs commands defined in config file in order given.
+  help        Help about any command
+  list        List commands, lists, or hosts defined in config file.
+  version     Prints the version and exits
+
+Flags:
+      --cmdStdOut            Pass to print command output to stdout
+  -f, --config string        config file to read from
+  -h, --help                 help for backy
+      --hostsConfig string   yaml hosts file to read from
+      --logFile string       log file to write to
+      --s3Endpoint string    Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
+  -v, --verbose              Sets verbose level
+
+Use "backy [command] --help" for more information about a command.
+```
+ 
+# Subcommands
+
+## backup
+
+```
+Backup executes commands defined in config file.
+Use the --lists or -l flag to execute the specified lists. If not flag is not given, all lists will be executed.
+
+Usage:
+  backy backup [--lists=list1 --lists list2 ... | -l list1 -l list2 ...] [flags]
+
+Flags:
+  -h, --help                help for backup
+  -l, --lists stringArray   Accepts comma-separated names of command lists to execute.
+
+Global Flags:
+      --cmdStdOut            Pass to print command output to stdout
+  -f, --config string        config file to read from
+      --hostsConfig string   yaml hosts file to read from
+      --logFile string       log file to write to
+      --s3Endpoint string    Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
+  -v, --verbose              Sets verbose level
+```
+
+## cron
+
+```
+Cron starts a scheduler that executes command lists at the time defined in config file.
+
+Usage:
+  backy cron [flags]
+
+Flags:
+  -h, --help   help for cron
+
+Global Flags:
+      --cmdStdOut            Pass to print command output to stdout
+  -f, --config string        config file to read from
+      --hostsConfig string   yaml hosts file to read from
+      --logFile string       log file to write to
+      --s3Endpoint string    Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
+  -v, --verbose              Sets verbose level
+```
+
+## exec
+
+```
+Exec executes commands defined in config file in order given.
+
+Usage:
+  backy exec command ... [flags]
+  backy exec [command]
+
+Available Commands:
+  host        Runs command defined in config file on the hosts in order specified.
+  hosts       Runs command defined in config file on the hosts in order specified.
+
+Flags:
+  -h, --help   help for exec
+
+Global Flags:
+      --cmdStdOut            Pass to print command output to stdout
+  -f, --config string        config file to read from
+      --hostsConfig string   yaml hosts file to read from
+      --logFile string       log file to write to
+      --s3Endpoint string    Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
+  -v, --verbose              Sets verbose level
+
+Use "backy exec [command] --help" for more information about a command.
+```
+
+### exec host
+
+```
+Host executes specified commands on the hosts defined in config file.
+Use the --commands or -c flag to choose the commands.
+
+Usage:
+  backy exec host [--command=command1 --command=command2 ... | -c command1 -c command2 ...] [--hosts=host1 --hosts=hosts2 ... | -m host1 -m host2 ...]  [flags]
+
+Flags:
+  -c, --command stringArray   Accepts space-separated names of commands. Specify multiple times for multiple commands.
+  -h, --help                  help for host
+  -m, --hosts stringArray     Accepts space-separated names of hosts. Specify multiple times for multiple hosts.
+
+Global Flags:
+      --cmdStdOut            Pass to print command output to stdout
+  -f, --config string        config file to read from
+      --hostsConfig string   yaml hosts file to read from
+      --logFile string       log file to write to
+      --s3Endpoint string    Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
+  -v, --verbose              Sets verbose level
+```
+
+## version
+
+```
+Prints the version and exits. No arguments just prints the version number only.
+
+Usage:
+  backy version [flags]
+
+Flags:
+  -h, --help   help for version
+  -n, --num    Output the version number only.
+  -V, --vpre   Output the version with v prefixed.
+
+Global Flags:
+      --cmdStdOut            Pass to print command output to stdout
+  -f, --config string        config file to read from
+      --hostsConfig string   yaml hosts file to read from
+      --logFile string       log file to write to
+      --s3Endpoint string    Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
+  -v, --verbose              Sets verbose level
+```
+
+## list
+
+```
+List commands, lists, or hosts defined in config file
+
+Usage:
+  backy list [command]
+
+Available Commands:
+  cmds        List commands defined in config file.
+  lists       List lists defined in config file.
+
+Flags:
+  -h, --help   help for list
+
+Global Flags:
+      --cmdStdOut            Pass to print command output to stdout
+  -f, --config string        config file to read from
+      --hostsConfig string   yaml hosts file to read from
+      --logFile string       log file to write to
+      --s3Endpoint string    Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
+  -v, --verbose              Sets verbose level
+
+Use "backy list [command] --help" for more information about a command.
+```
+## list cmds
+
+```
+List commands defined in config file
+
+Usage:
+  backy list cmds [cmd1 cmd2 cmd3...] [flags]
+
+Flags:
+  -h, --help   help for cmds
+
+Global Flags:
+      --cmdStdOut            Pass to print command output to stdout
+  -f, --config string        config file to read from
+      --hostsConfig string   yaml hosts file to read from
+      --logFile string       log file to write to
+      --s3Endpoint string    Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
+  -v, --verbose              Sets verbose level
+```
+## list lists
+
+```
+List lists defined in config file
+
+Usage:
+  backy list lists [list1 list2 ...] [flags]
+
+Flags:
+  -h, --help   help for lists
+
+Global Flags:
+      --cmdStdOut            Pass to print command output to stdout
+  -f, --config string        config file to read from
+      --hostsConfig string   yaml hosts file to read from
+      --logFile string       log file to write to
+      --s3Endpoint string    Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
+  -v, --verbose              Sets verbose level
+```

docs/content/cli/exec.md

@@ -0,0 +1,19 @@
+---
+title: Exec
+---
+
+The `exec` subcommand can do some things that the configuration file can't do yet. The command `exec host` can execute commands on many hosts.
+
+`exec host` takes the following arguments:
+
+```sh
+  -c, --commands strings   Accepts space-separated names of commands.
+  -h, --help               help for host
+  -m, --hosts strings      Accepts space-separated names of hosts.
+```
+
+The commands have to be defined in the config file. The hosts need to at least be in the ssh_config(5) file.
+
+```sh
+backy exec host [--commands=command1 -commands=command2 ... | -c command1 -c command2 ...] [--hosts=host1 --hosts=hosts2 ... | -m host1 -m host2 ...]  [flags]
+```

docs/content/cli/list.md

@@ -0,0 +1,29 @@
+---
+title: List
+---
+
+
+List commands, lists, or hosts defined in config file
+
+Usage:
+```
+  backy list [command]
+```
+
+Available Commands:
+  cmds        List commands defined in config file.
+  lists       List lists defined in config file.
+
+Flags:
+```
+  -h, --help   help for list
+```
+
+Global Flags:
+```
+      --cmdStdOut            Pass to print command output to stdout
+  -f, --config string        config file to read from
+      --log-file string      log file to write to
+      --s3-endpoint string   Sets the S3 endpoint used for config file fetching. Overrides S3_ENDPOINT env variable.
+  -v, --verbose              Sets verbose level
+```

docs/content/config/_index.md

@@ -0,0 +1,40 @@
+---
+title: "Configuring Backy"
+weight: 3
+description: >
+  This page tells you how to configure Backy.
+---
+
+This is the section on the config file.
+
+To use a specific file:
+```backy [command] -f /path/to/file```
+
+You can also use a remote file:
+```
+backy [command] -f `s3/http source`
+```
+
+See remote resources docs for specific info.
+
+If you leave the config path blank, the following paths will be searched in order:
+
+1. `./backy.yml`
+2. `./backy.yaml`
+3. The same two files above contained in a `backy` subdirectory under in what is returned by Go's `os` package function `UserConfigDir()`.
+
+{{% expand title="`UserConfigDir()` documentation:" %}}
+
+Up-to date documentation for this function may be found on [GoDoc](https://pkg.go.dev/os#UserConfigDir).
+
+>UserConfigDir returns the default root directory to use for user-specific configuration data. Users should create their own application-specific subdirectory within this one and use that.
+
+>On Unix systems, it returns $XDG_CONFIG_HOME as specified by https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html if non-empty, else $HOME/.config. On Darwin, it returns $HOME/Library/Application Support. On Windows, it returns %AppData%. On Plan 9, it returns $home/lib.
+
+>If the location cannot be determined (for example, $HOME is not defined), then it will return an error.
+
+{{% /expand %}}
+
+See the rest of the documentation, titles included below, in this section to configure it.
+
+{{% children description="true" %}}

docs/content/config/command-lists.md

@@ -0,0 +1,99 @@
+---
+title: "Command Lists"
+weight: 2
+description: >
+  This page tells you how to use command lists.
+---
+
+Command lists are for executing commands in sequence and getting notifications from them.
+
+The top-level object key can be anything you want but not the same as another.
+
+Lists can go in a separate file. Command lists should be in a separate file if:
+
+1. key 'cmdLists.file' is specified
+2. lists.yml or lists.yaml is found in the same directory as the backy config file (this includes remote config files as of v0.7.0)
+
+{{% notice info %}}
+The lists file is also checked in remote resources. 
+
+The lists file is ignored under the following condition:
+
+If a remote config file is specified (on the command-line using `-f`) and the lists file is not found in the same directory, the lists file is assumed to not exist.
+{{% /notice %}}
+
+```yaml {lineNos="true" wrap="true" title="yaml"}
+  test2:
+    name: test2
+    order:
+      - test
+      - test2
+    notifications:
+      - mail.prod-email
+      - matrix.sysadmin
+    cron: "0 * * * * *"
+```
+
+| key | description | type | required
+| --- | --- | --- | ---
+| `order` | Defines the sequence of commands to execute | `[]string` | yes
+| `sendNotificationOnSuccess` | Whether to send notification on list success with the commands' output | `bool` | no
+| `notifications` | The notification service(s) and ID(s) to use on success and failure. Must be *`service.id`*. See the [notifications documentation page](/config/notifications/) for more | `[]string` | no
+| `name` | Optional name of the list | `string` | no
+| `cron` | Time at which to schedule the list. Only has affect when cron subcommand is run. | `string` | no
+
+### Order
+
+The order is an array of commands to execute in order. Each command must be defined.
+
+```yaml
+order:
+  - cmd-1
+  - cmd-2
+```
+
+### getOutput
+
+Get command output when a notification is sent.
+
+Is not required. Can be `true` or `false`. Default is `false`.
+
+### Notifications
+
+An array of notification IDs to use on success and failure. Must match any of the `notifications` object map keys.
+
+### Name
+
+Name is optional. If name is not defined, name will be the object's map key.
+
+### Cron mode
+
+Backy also has a cron mode, so one can run `backy cron` and start a process that schedules jobs to run at times defined in the configuration file.
+
+Adding `cron: 0 0 1 * * *` to a `cmdLists` object will schedule the list at 1 in the morning. See [https://crontab.guru/](https://crontab.guru/) for reference.
+
+{{% notice tip %}}
+Note: Backy uses the second field of cron, so add anything except `*` to the beginning of a regular cron expression.
+{{% /notice %}}
+
+```yaml {lineNos="true" wrap="true" title="yaml"}
+cmdLists:
+  docker-container-backup: # this can be any name you want
+    # all commands have to be defined
+    order:
+      - stop-docker-container
+      - backup-docker-container-script
+      - shell-cmd
+      - hostname
+      - start-docker-container
+    notifications:
+      - matrix.id
+    name: backup-some-container
+    cron: "0 0 1 * * *"
+  hostname:
+    name: hostname
+    order:
+      - hostname
+    notifications:
+      - mail.prod-email
+```

docs/content/config/commands/_index.md

@@ -0,0 +1,128 @@
+---
+title: "Commands"
+description: Commands are just that, commands
+weight: 1
+---
+
+
+
+### Example Config
+
+{{% code file="/examples/example.yml" language="yaml" %}}
+
+Values available for this section **(case-sensitive)**:
+
+| name            | notes                                                                                                   | type                  | required | External directive support |
+| ----------------| ------------------------------------------------------------------------------------------------------- | --------------------- | -------- |----------------------------|
+| `cmd`           | Defines the command to execute                                                                          | `string`              | yes      | No                         |
+| `Args`          | Defines the arguments to the command                                                                    | `[]string`            | no       | No                         |
+| `environment`   | Defines environment variables for the command                                                           | `[]string`            | no       | Partial                    |
+| `type`          | See documentation further down the page. Additional fields may be required.                             | `string`              | no       | No                         |
+| `getOutput`     | Command(s) output is in the notification(s)                                                             | `bool`                | no       | No                         |
+| `host`          | If not specified, the command will execute locally.                                                     | `string`              | no       | No                         |
+| `scriptEnvFile` | When type is `scriptFile` or `script`, this file is prepended to the input.                             | `string`              | no       | No                         |
+| `shell`         | Run the command in the shell                                                                            | `string`              | no       | No                         |
+| `hooks`         | Hooks are used at the end of the individual command. Must have at least `error`, `success`, or `final`. | `map[string][]string` | no       | No                         |
+
+#### cmd
+
+cmd must be a valid command or script to execute.
+
+#### Args
+
+args must be arguments to cmd as they would be passed on the command-line:
+
+```sh
+cmd [arg1 arg2 ...]
+```
+
+Define them in an array:
+
+```yaml
+Args:
+  - arg1
+  - arg2
+  - arg3
+```
+
+### getOutput
+
+Get command output when a notification is sent.
+
+Is not required. Can be `true` or `false`.
+
+#### host
+
+{{% notice info %}}
+If any `host` is not defined or left blank, the command will run on the local machine.
+{{% /notice %}}
+
+Host may or may not be defined in the `hosts` section.
+
+{{% notice info %}}
+If any `host` from the commands section does not match any object in the `hosts` section, the `Host` is assumed to be this value. This value will be used to search in the default SSH config files.
+
+For example, say that I have a host defined in my SSH config with the `Host` defined as `web-prod`.
+If I assign a value to host as `host: web-prod` and don't specify this value in the `hosts` object, web-prod will be used as the `Host` in searching the SSH config files.
+{{% /notice %}}
+
+### shell
+
+If shell is defined, the command will run in the specified shell.
+Make sure to escape any shell input.
+
+### scriptEnvFile
+
+Path to a file.
+
+When type is `script` or `scriptFile` , the script is appended to this file.
+
+This is useful for specifying environment variables or other things so they don't have to be included in the script.
+
+### type
+
+The following options are available:
+
+| name | description |
+| --- | --- |
+| script | `cmd` is used as the script |
+| scriptFile | Can only be run on a host. `cmd` is read and used as the script, and `scriptEnvFile` can be used to add env variables |
+| package | Run package operations. See [dedicated page](/config/packages) for configuring package commands |
+| user | Run user operations. See [dedicated page](/config/user-commands) for configuring package commands |
+
+### environment
+
+The environment variables support expansion:
+
+- using escaped values `$VAR` or `${VAR}`
+- using any external directive, and if using the env directive, the variable will be read from a `.env` file
+
+<!-- For now, the variables expanded have to be defined in an `.env` file in the same directory that the program is run from. -->
+
+If using it with host specified, the SSH server has to be configured to accept those env variables.
+
+If the command is run locally, the OS's environment is added.
+
+### hooks
+
+Hooks are run after the command is run.
+
+Errors are run if the command errors, success if it returns no error. Final hooks are run regardless of error condition.
+
+Values for hooks are as follows:
+
+```yaml
+command:
+  hook:
+    # these commands are defined elsewhere in the file
+    error:
+      - errcommand
+    success:
+      - successcommand
+    final:
+      - donecommand
+```
+
+### packages
+
+See the [dedicated page](/config/packages) for package configuration.

docs/content/config/commands/packages.md

@@ -0,0 +1,79 @@
+---
+title: "Packages"
+weight: 2
+description: This is dedicated to package commands.
+---
+
+This is dedicated to `package` commands. The command `type` field must be `package`. Package is a type that allows one to perform package operations. There are several additional options available when `type` is `package`:
+
+| name | notes | type | required |
+| --- | --- | --- | --- |
+| `packageName` | The name of a package to be modified. | `string` | yes |
+| `packageManager` | The name of the package manger to be used. | `string` | yes |
+| `packageOperation` | The type of operation to perform. | `string` | yes |
+| `packageVersion` | The version of a package. | `string` | no |
+
+
+#### example
+
+The following is an example of a package command:
+
+```yaml
+ update-docker:
+    type: package
+    shell: zsh
+    packageName: docker-ce
+    packageManager: apt
+    packageOperation: install
+    host: debian-based-host
+```
+
+#### packageOperation
+
+The following package operations are supported:
+
+- `install`
+- `remove`
+- `upgrade`
+- `checkVersion`
+
+#### packageManager
+
+The following package managers are recognized:
+
+- `apt`
+- `yum`
+- `dnf`
+
+#### package command args
+
+You can add additional arguments using the standard `Args` key. This is useful for adding more packages, yet it does not work with `checkVersion`.
+
+### Development
+
+The PackageManager interface provides an easy way to enforce functions and options. There are two interfaces, `PackageManager` and `ConfigurablePackageManager` in the directory `pkg/pkgman`. Go's import-cycle "feature" caused me to implement functional options using a third interface. `PackageManagerOption`is a function that takes an interface.
+
+#### PackageManager
+
+```go
+// PackageManager is an interface used to define common package commands. This shall be implemented by every package.
+type PackageManager interface {
+	Install(pkg, version string, args []string) (string, []string)
+	Remove(pkg string, args []string) (string, []string)
+	Upgrade(pkg, version string) (string, []string) // Upgrade a specific package
+	UpgradeAll() (string, []string)
+
+	// Configure applies functional options to customize the package manager.
+	Configure(options ...pkgcommon.PackageManagerOption)
+}
+```
+
+There are a few functional options that should be implemented using the `ConfigurablePackageManager` interface:
+
+```go
+// ConfigurablePackageManager defines methods for setting configuration options.
+type ConfigurablePackageManager interface {
+	SetUseAuth(useAuth bool)
+	SetAuthCommand(authCommand string)
+}
+```

docs/content/config/commands/user-commands.md

@@ -0,0 +1,66 @@
+---
+title: "User commands"
+weight: 2
+description: This is dedicated to user commands.
+---
+
+This is dedicated to `user` commands. The command `type` field must be `user`. User is a type that allows one to perform user operations. There are several additional options available when `type` is `user`:
+
+| name            | notes                                                        | type       | required | External directive support
+| ----------------| -------------------------------------------------------------| ---------- | ---------| --------------------------|
+| `userName`      | The name of a user to be configured.                         | `string`   | yes      | no 						 |
+| `userOperation` | The type of operation to perform.                            | `string`   | yes      | no 						 |
+| `userID`        | The user ID to use.                                          | `string`   | no       | no 						 |
+| `userGroups`    | The groups the user should be added to.                      | `[]string` | no       | no 						 |
+| `systemUser`    | Create a system user.                                        | `bool`     | no       | no 						 |
+| `userCreateHome`| Create the home directory.                                   | `bool`     | no       | no 						 |
+| `userSshPubKeys`| The keys to add to the user's authorized keys.               | `[]string` | no       | yes 						 |
+| `userShell`     | The shell for the user.                                      | `string`   | no       | no 						 |
+| `userHome`      | The user's home directory.                                   | `string`   | no       | no 						 |
+| `userPassword`  | The new password value when using the `password` operation.  | `string`   | no       | yes						 |
+
+
+#### example
+
+The following is an example of a package command:
+
+```yaml
+  addUser:
+	name: add user backy with custom home dir
+    type: user
+    userName: backy
+    userHome: /opt/backy
+    userOperation: add
+    host: some-host
+```
+
+#### userOperation
+
+The following package operations are supported:
+
+- `add`
+- `remove`
+- `modify`
+- `password`
+- `checkIfExists`
+
+### Development
+
+The UserManager interface provides an way easy to add new commands. There is one interface `Usermanager` in directory `pkg/usermanager`.
+
+#### UserManager
+
+```go
+// UserManager defines the interface for user management operations.
+// All functions but one return a string for the command and any args.
+type UserManager interface {
+	AddUser(username, homeDir, shell string, isSystem bool, groups, args []string) (string, []string)
+	RemoveUser(username string) (string, []string)
+	ModifyUser(username, homeDir, shell string, groups []string) (string, []string)
+	// Modify password uses chpasswd for Linux systems to build the command to change the password
+	// Should return a password as the last argument
+	// TODO: refactor when adding more systems instead of Linux
+	ModifyPassword(username, password string) (string, *strings.Reader, string)
+	UserExists(username string) (string, []string)
+}
+```

docs/content/config/directives.md

@@ -0,0 +1,15 @@
+---
+title: "External Directives"
+weight: 2
+description: How to set up external directives.
+---
+
+External directives are for including data that should not be in the config file. The following directives are supported:
+
+- `%{file:path/to/file}%`
+- `%{env:ENV_VAR}%`
+- `%{vault:vault-key}%`
+
+See the docs of each command if the field is supported.
+
+If the file path does not begin with a `/`, the config file's directory will be used as the starting point.

docs/content/config/hosts.md

@@ -0,0 +1,24 @@
+---
+title: "Hosts"
+weight: 2
+description: >
+  This page tells you how to use hosts.
+---
+
+| Key                  | Description                                                   | Type     | Required | External directive support |
+|----------------------|---------------------------------------------------------------|----------|----------|----------------------------|
+| `OS`                 | Operating system of the host (used for package commands)      | `string` | no       | No                         |
+| `config`             | Path to the SSH config file                                   | `string` | no       | No                         |
+| `host`               | Specifies the `Host` ssh_config(5) directive                  | `string` | yes      | No                         |
+| `hostname`           | Hostname of the host                                          | `string` | no       | No                         |
+| `knownHostsFile`     | Path to the known hosts file                                  | `string` | no       | No                         |
+| `port`               | Port number to connect to                                     | `uint16` | no       | No                         |
+| `proxyjump`          | Proxy jump hosts, comma-separated                             | `string` | no       | No                         |
+| `password`           | Password for SSH authentication                               | `string` | no       | No                         |
+| `privateKeyPath`     | Path to the private key file                                  | `string` | no       | No                         |
+| `privateKeyPassword` | Password for the private key file                             | `string` | no       | Yes                        |
+| `user`               | Username for SSH authentication                               | `string` | no       | No                         |
+
+## exec host subcommand
+
+Backy has a subcommand `exec host`. This subcommand takes the flags of `-m host1 -m host2`. The commands can also be specified by `-c command1 -c command2`.

docs/content/config/notifications.md

@@ -0,0 +1,75 @@
+---
+title: "Notifications"
+weight: 3
+description: >
+  This page tells you how to get set up Backy notifications.
+---
+
+Notifications are only configurable for command lists, as of right now.
+
+Notifications can be sent on command list completion and failure.
+
+The supported platforms for notifications are email (SMTP) and [Matrix](https://matrix.org/).
+
+Notifications are defined by service, with the current form following below. Ids must come after the service.
+
+```yaml
+notifications:
+  mail:
+    prod-email:
+      host: yourhost.tld
+      port: 587
+      senderaddress: email@domain.tld
+      to:
+        - admin@domain.tld
+      username: smtp-username@domain.tld
+      password: your-password-here
+
+  matrix:
+    matrix:
+      home-server: your-home-server.tld
+      room-id: room-id
+      access-token: your-access-token
+      user-id: your-user-id
+```
+
+Sections recognized are `mail` and `matrix`
+
+There must be a section with an id (eg. `mail.test-svr`) following one of these sections.
+
+### mail
+
+| key | description | type | External directive support |
+| --- | --- | --- | --- |
+| `host` | Specifies the SMTP host to connect to | `string` | no
+| `port` | Specifies the SMTP port | `uint16` | no
+| `senderaddress` | Address from which to send mail | `string` | no
+| `to` | Recipients to send emails to | `[]string` | no
+| `username` | SMTP username | `string` | no
+| `password` | SMTP password | `string` | yes
+
+### matrix
+
+| key | description | type | External directive support |
+| --- | --- | ---| ---- |
+| `home-server` | Specifies the Matrix server connect to | `string` | no
+| `room-id` | Specifies the room ID of the room to send messages to | `string` | no
+| `access-token` | Matrix access token  | `string` | yes
+| `user-id` | Matrix user ID | `string` | no
+
+To get your access token (assumes you are using [Element](https://element.io/)) :
+
+1. Log in to the account you want to get the access token for. Click on the name in the top left corner, then "Settings".
+2. Click the "Help & About" tab (left side of the dialog).
+3. Scroll to the bottom and click on `<click to reveal>` part of Access Token.
+4. Copy your access token to a safe place.
+
+To get the room ID:
+
+1. On Element or a similar client, navigate to the room.
+2. Navigate to the settings from the top menu.
+3. Click on Advanced, the room ID is there.
+
+{{% notice info %}}
+Make sure to quote the room ID, as [YAML spec defines tags using `!`](https://yaml.org/spec/1.2.2/#3212-tags).
+{{% /notice %}}

docs/content/config/remote-resources.md

@@ -0,0 +1,21 @@
+---
+title: "Remote resources"
+weight: 2
+description: This is dedicated to configuring remote resources.
+---
+
+Remote resources can be used for a lot of things, including config files and scripts.
+
+## Config file
+
+For the main config file to be fetched remotely, pass the URL using `-f [url]`.
+
+If using S3, you should use the s3 protocol URI: `s3://bucketName/key/path`. You will also need to set the env variable `S3_ENDPOINT` to the appropriate value. The flag `--s3-endpoint` can be used to override this value or to set this value, if not already set.
+
+## Authentication
+
+Currently, only the AWS authentication credentials file `~/.aws/credentials` is supported. For now, the environment variable `AWS_PROFILE` is used to lookup the profile.
+
+## Scripts
+
+Remote script support is currently limited to http/https endpoints.

docs/content/config/vault.md

@@ -0,0 +1,29 @@
+---
+title: "Vault"
+weight: 4
+description: Set up and configure vault.
+---
+
+[Vault](https://www.vaultproject.io/) is a tool for storing secrets and other data securely.
+
+A Vault key can be used by prefixing `%{vault:vault.keys.name}%` in a field that supports external directives.
+
+This is the object in the config file:
+
+```yaml
+vault:
+  token: hvs.tXqcASvTP8wg92f7riyvGyuf
+  address: http://127.0.0.1:8200
+  enabled: false
+  keys:
+    - name: mongourl
+      mountpath: secret
+      key: data
+      path: mongo/url
+      type: KVv2  # KVv1 or KVv2
+    - name: someKeyName
+      mountpath: secret
+      key: keyData
+      type: KVv2
+      path: some/path
+```

docs/content/examples/backy.yaml

@@ -0,0 +1,108 @@
+commands:
+  stop-docker-container:
+    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
+    hooks:
+      final:
+        - hostname
+      error:
+        - hostname
+  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
+  shell-cmd:
+    cmd: rsync
+    shell: bash
+    Args:
+      - -av some-host:/path/to/data ~/Docker/Backups/docker-data
+  hostname:
+    cmd: hostname
+  update-docker:
+    type: package
+    shell: zsh # best to run package commands in a shell
+    packageName: docker-ce
+    Args:
+      - docker-ce-cli
+    packageManager: apt
+    packageOperation: install
+  update-dockerApt:
+    # type: package
+    shell: zsh
+    cmd: apt
+    Args:
+      - update
+      - "&&"
+      - apt install -y docker-ce
+      - docker-ce-cli
+    packageManager: apt
+    packageOperation: install
+
+cmd-lists:
+  cmds-to-run: # this can be any name you want
+    # all commands have to be defined
+    order:
+      - stop-docker-container
+      - backup-docker-container-script
+      - shell-cmd
+      - hostname
+    notifications:
+      - matrix.matrix
+    name: backup-some-server
+    cron: "0 0 1 * * *"
+  hostname:
+    name: hostname
+    order:
+      - hostname
+    notifications:
+      - mail.prod-email
+
+hosts:
+  # any ssh_config(5) keys/values not listed here will be looked up in the config file or the default config file
+  some-host:
+    hostname: some-hostname
+    config: ~/.ssh/config
+    user: user
+    privateKeyPath: /path/to/private/key
+    port: 22
+    # can also be env:VAR
+    password: file:/path/to/file
+    # only one is supported for now
+    proxyjump: some-proxy-host
+
+# optional
+logging:
+  verbose: true
+  file: ./backy.log
+  console: false
+  cmd-std-out: false
+
+
+notifications:
+  mail:
+    prod-email:
+      id: prod-email
+      type: mail
+      host: yourhost.tld
+      port: 587
+      senderAddress: email@domain.tld
+      to:
+        - admin@domain.tld
+      username: smtp-username@domain.tld
+      password: your-password-here
+  matrix:
+    matrix:
+      id: matrix
+      type: matrix
+      home-server: your-home-server.tld
+      room-id: room-id
+      access-token: your-access-token
+      user-id: your-user-id

docs/content/examples/example.yml

@@ -0,0 +1,24 @@
+commands:
+  stop-docker-container:
+    cmd: docker
+    Args:
+      - compose
+      - -f /some/path/to/docker-compose.yaml
+      - down
+    # if host is not defined, command will be run locally
+    # The host has to be defined in either the config file or the SSH Config files
+    host: some-host
+    hooks:
+      error:
+        - some-other-command-when-failing
+      success:
+        - success-command
+      final:
+        - final-command
+  backup-docker-container-script:
+    cmd: /path/to/local/script
+    # script file is input as stdin to SSH
+    type: scriptFile # also can be script
+    environment:
+      - FOO=BAR
+      - APP=$VAR

docs/content/getting-started/_index.md

@@ -0,0 +1,10 @@
+---
+title: "Getting started"
+weight: 2
+description: >
+  This page tells you how to get started with Backy.
+---
+
+If you have not installed Backy, [see the install documentation](install).
+
+If you need to configure it, [see the config page](config).

docs/content/getting-started/config.md

@@ -0,0 +1,161 @@
+---
+title: "Config File Definitions"
+description: >
+  This page tells you how to configure Backy.
+---
+
+### 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](/config/commands) for further information.
+
+```yaml
+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.
+
+```yaml
+cmdLists:
+  cmds-to-run: # this can be any name you want
+    # all commands have to be defined in the commands section
+    order:
+      - stop-docker-container
+      - backup-docker-container-script
+      - shell-cmd
+      - hostname
+    getOutput: true # Optional and only for when notifications are sent
+    notifications:
+      - matrix
+    name: backup-some-server
+  hostname:
+    name: hostname
+    order:
+      - hostname
+    notifications:
+      - prod-email
+```
+
+### Hosts
+
+The hosts object may or may not be defined.
+
+{{% notice info %}}
+If any `host` from a commands object does not match any `host` object, the needed values will be checked in the default SSH config files.
+{{% /notice %}}
+
+```yaml
+hosts:
+  # any needed ssh_config(5) keys/values not listed here will be looked up in the config file or the default config file
+  some-host:
+    hostname: some-hostname
+    config: ~/.ssh/config
+    user: user
+    privatekeypath: /path/to/private/key
+    port: 22
+    # can also be env:VAR or the password itself
+    password: file:/path/to/file
+    # can also be env:VAR or the password itself
+    privatekeypassword: file:/path/to/file
+    # only one is supported for now
+    proxyjump: some-proxy-host
+```
+
+### Notifications
+
+The notifications object can have two forms.
+
+For more, [see the notification object documentation](/config/notifications). The top-level map key is id that has to be referenced by the `cmdLists` key `notifications`.
+
+```yaml
+notifications:
+  mail:
+    prod-email:
+      id: prod-email
+      type: mail
+      host: yourhost.tld
+      port: 587
+      senderAddress: email@domain.tld
+      to:
+        - admin@domain.tld
+      username: smtp-username@domain.tld
+      password: your-password-here
+  matrix:
+    matrix:
+      id: matrix
+      type: matrix
+      home-server: your-home-server.tld
+      room-id: room-id
+      access-token: your-access-token
+      user-id: your-user-id
+```
+
+### Logging
+
+`cmd-std-out` controls whether commands output is echoed to StdOut.
+
+If `logfile` is not defined, the log file will be written to the config directory in the file `backy.log`.
+
+`console-disabled` controls whether the logging messages are echoed to StdOut. Default is false.
+
+`verbose` prints out debugging messages.
+
+```yaml
+logging:
+  verbose: false
+  file: path/to/log/file.log
+  console-disabled: false
+  cmd-std-out: false
+```
+
+### Vault
+
+[Vault](https://www.vaultproject.io/) can be used to get some configuration values and ENV variables securely.
+
+```yaml
+vault:
+  token: hvs.tXqcASvTP8wg92f7riyvGyuf
+  address: http://127.0.0.1:8200
+  enabled: false
+  keys:
+    - name: mongourl
+      mountpath: secret
+      path: mongo/url
+      type:  # KVv1 or KVv2
+    - name:
+      path:
+      type:
+      mountpath: 
+```

docs/content/getting-started/install.md

@@ -0,0 +1,21 @@
+---
+title: "Install Backy"
+weight: 1
+description: >
+  This page tells you how to install Backy.
+---
+
+
+Binaries are available from the [release page](https://git.andrewnw.xyz/CyberShell/backy/releases). 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](https://go.dev/doc/install).
+
+Then run:
+
+```bash
+go install git.andrewnw.xyz/CyberShell/backy@master
+```
+
+Once set, jump over to the [config docs](/getting-started/config) and start configuring your file.

docs/content/repositories/_index.md

@@ -0,0 +1,9 @@
+---
+title: "Repositories"
+weight: 5
+---
+
+The repo mirrors are:
+
+* [https://git.andrewnw.xyz/CyberShell/backy](https://git.andrewnw.xyz/CyberShell/backy)
+* [https://github.com/CybersShell/backy](https://github.com/CybersShell/backy)

docs/go.mod

@@ -0,0 +1,8 @@
+module git.andrewnw.xyz/CyberShell/backy/docs
+
+go 1.19
+
+require (
+	github.com/McShelby/hugo-theme-relearn v0.0.0-20250103114405-80e448e5bdaa // indirect
+	github.com/divinerites/plausible-hugo v1.21.1 // indirect
+)

docs/go.sum

@@ -0,0 +1,10 @@
+github.com/McShelby/hugo-theme-relearn v0.0.0-20230209073138-890d12ea922d h1:weq1mrQ/qNAvGrNgvZVL1K8adbT3bswZf2ABLr/LCIA=
+github.com/McShelby/hugo-theme-relearn v0.0.0-20230209073138-890d12ea922d/go.mod h1:mKQQdxZNIlLvAj8X3tMq+RzntIJSr9z7XdzuMomt0IM=
+github.com/McShelby/hugo-theme-relearn v0.0.0-20241210183303-16d4de84becf h1:bMx4kwM7Q+dAzvSOWs3XWZ25o+n4mI0GPHqzbzeWb3M=
+github.com/McShelby/hugo-theme-relearn v0.0.0-20241210183303-16d4de84becf/go.mod h1:mKQQdxZNIlLvAj8X3tMq+RzntIJSr9z7XdzuMomt0IM=
+github.com/McShelby/hugo-theme-relearn v0.0.0-20250102210630-dd0597ffa4b2 h1:sWaC1/dL65v3iRvblEAaBLpKC5TIT0R9JASk1hZNET8=
+github.com/McShelby/hugo-theme-relearn v0.0.0-20250102210630-dd0597ffa4b2/go.mod h1:mKQQdxZNIlLvAj8X3tMq+RzntIJSr9z7XdzuMomt0IM=
+github.com/McShelby/hugo-theme-relearn v0.0.0-20250103114405-80e448e5bdaa h1:G+OnMEzK4XOzbbcf1SmaGyOYJ0h5idp/IJdguWs8ioU=
+github.com/McShelby/hugo-theme-relearn v0.0.0-20250103114405-80e448e5bdaa/go.mod h1:mKQQdxZNIlLvAj8X3tMq+RzntIJSr9z7XdzuMomt0IM=
+github.com/divinerites/plausible-hugo v1.21.1 h1:ZTWwjhZ0PmLMacCVGlcGiYFEZW7VaYE767tchDskOug=
+github.com/divinerites/plausible-hugo v1.21.1/go.mod h1:cxr+YB3FUwbLon8KCs4pV4Ankbkq6lJxTQUpNb5KqPo=

docs/layouts/_default/baseof.html

@@ -0,0 +1,84 @@
+<!DOCTYPE html>
+{{- block "storeOutputFormat" . }}{{ end }}
+{{- if .IsHome }}
+  {{- $hugoVersion := "0.126.0" }}
+  {{- if lt hugo.Version $hugoVersion }}
+    {{- errorf "The Relearn theme requires Hugo %s or later" $hugoVersion }}
+  {{- end }}
+{{- end }}
+{{- if .Site.Params.description }}
+  {{- warnf "UNSUPPORTED usage of 'params.description' config parameter found, move it to the front matter of your home page; see https://mcshelby.github.io/hugo-theme-relearn/introduction/releasenotes/6/#6-0-0" }}
+{{- end }}
+<html lang="{{ .Page.Language.LanguageCode }}" dir="{{ .Page.Language.LanguageDirection | default (T "Reading-direction") | default "ltr" }}" itemscope itemtype="http://schema.org/Article" data-r-output-format="{{ with .Store.Get "relearnOutputFormat" }}{{ . }}{{ else }}html{{ end }}">
+  <head>
+    {{ partial "plausible_head.html" . }}
+    {{- partial "meta.html" . }}
+    {{- $title := partial "title.gotmpl" (dict "page" . "fullyQualified" true "reverse" true) }}
+    <title>{{ $title }}</title>
+
+    {{- /* multilingual stuff */}}
+    {{- if .IsTranslated -}}
+      {{- range $index, $trans := .AllTranslations }}
+        {{- if eq $index 0 }}
+    <link href="{{ partial "permalink.gotmpl" (dict "to" . "abs" true) }}" rel="alternate" hreflang="x-default">
+        {{- end }}
+    <link href="{{ partial "permalink.gotmpl" (dict "to" . "abs" true) }}" rel="alternate" hreflang="{{ .Language.LanguageCode }}">
+      {{- end }}
+    {{- end }}
+
+    {{- /* output formats */}}
+    {{- $page := . }}
+    {{- $link := "<link href=\"%s\" rel=\"%s\" type=\"%s\" title=\"%s\">" }}
+    {{- range .AlternativeOutputFormats }}
+      {{- if eq .Rel "canonical" }}
+    {{ (printf $link (partial "permalink.gotmpl" (dict "to" . "abs" true)) .Rel .MediaType.Type ($title | htmlEscape)) | safeHTML }}
+      {{- else if not (partial "_relearn/pageIsSpecial.gotmpl" $page) }}
+    {{ (printf $link (partial "permalink.gotmpl" (dict "to" .)) .Rel .MediaType.Type ($title | htmlEscape)) | safeHTML }}
+      {{- end }}
+    {{- end }}
+    {{- partialCached "favicon.html" . }}
+    {{- partial "stylesheet.html" . }}
+    {{- partial "dependencies.gotmpl" (dict "page" . "location" "header") }}
+    {{- partial "custom-header.html" . }}
+  </head>
+  <body class="mobile-support {{ with .Store.Get "relearnOutputFormat" }}{{ . }}{{ else }}html{{ end }}{{- if .Site.Params.disableInlineCopyToClipBoard }} disableInlineCopyToClipboard{{ end }}{{- if .Site.Params.disableHoverBlockCopyToClipBoard }} disableHoverBlockCopyToClipBoard{{ end }}" data-url="{{ partial "permalink.gotmpl" (dict "to" .) }}">
+    <div id="R-body" class="default-animation">
+      <div id="R-body-overlay"></div>
+      <nav id="R-topbar">
+        <div class="topbar-wrapper">
+          <div class="topbar-sidebar-divider"></div>
+          <div class="topbar-area topbar-area-start" data-area="start">
+            {{- partial "topbar/area/start.html" . }}
+          </div>
+          {{- $showBreadcrumb := (and (not .Params.disableBreadcrumb) (not .Site.Params.disableBreadcrumb)) }}
+          {{- if $showBreadcrumb }}
+          <ol class="topbar-breadcrumbs breadcrumbs highlightable" itemscope itemtype="http://schema.org/BreadcrumbList">
+            {{- partial "breadcrumbs.html" (dict "page" .) }}
+          </ol>
+          {{- else }}
+          <span class="topbar-breadcrumbs highlightable">
+            {{ partial "title.gotmpl" (dict "page" . "linkTitle" true) }}
+          </span>
+          {{- end }}
+          <div class="topbar-area topbar-area-end" data-area="end">
+            {{- partial "topbar/area/end.html" . }}
+          </div>
+        </div>
+      </nav>
+      <div id="R-main-overlay"></div>
+      <main id="R-body-inner" class="highlightable{{ with or .Type "default" }} {{ . }}{{ end }}" tabindex="-1">
+        <div class="flex-block-wrapper">
+{{- block "body" . }}{{ end }}
+        </div>
+      </main>
+{{- partial "custom-comments.html" . }}
+    </div>
+{{- block "menu" . }}{{ end }}
+{{- $assetBusting := partialCached "assetbusting.gotmpl" . }}
+    <script src="{{"js/clipboard.min.js" | relURL}}{{ $assetBusting }}" defer></script>
+    <script src="{{"js/perfect-scrollbar.min.js" | relURL}}{{ $assetBusting }}" defer></script>
+{{- partial "dependencies.gotmpl" (dict "page" . "location" "footer") }}
+    <script src="{{"js/theme.js" | relURL}}{{ $assetBusting }}" defer></script>
+{{- partial "custom-footer.html" . }}
+  </body>
+</html>

docs/layouts/shortcodes/code.html

@@ -0,0 +1,3 @@
+{{ $file := .Get "file" | readFile }}
+{{ $lang := .Get "language" }}
+{{ (print "```" $lang "\n" $file "\n```") }}

docs/themes/hugo-theme-relearn

@@ -0,0 +1 @@
+Subproject commit 80e448e5bdaa92c87ee0d0d86f1125c8606ebf5f

docs/themes/plausible-hugo

@@ -0,0 +1 @@
+Subproject commit 25d00b53c8ba5bac67329d4ed552b11322093811

docs/vangen.json

@@ -0,0 +1,20 @@
+{
+    "domain": "go.cybershell.xyz",
+    "docsDomain": "pkg.go.dev",
+    "repositories": [
+      {
+        "prefix": "backy",
+        "type": "git",
+        "hidden": false,
+        "url": "https://git.andrewnw.xyz/CyberShell/backy",
+        "source": {
+          "home": "https://git.andrewnw.xyz/CyberShell/backy",
+          "dir": "https://git.andrewnw.xyz/CyberShell/backy/src/branch/master/{/dir}",
+          "file": "https://git.andrewnw.xyz/CyberShell/backy/src/branch/master/{/dir}/{file}#L{line}"
+        },
+        "website": {
+          "url": "https://backy.cybershell.xyz/"
+        }
+      }
+    ]
+  }

docs/vangen/backy/index.html

@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html>
+<head>
+<meta charset="utf-8">
+<title>go.cybershell.xyz/backy</title>
+<meta name="go-import" content="go.cybershell.xyz/backy git https://git.andrewnw.xyz/CyberShell/backy">
+<meta name="go-source" content="go.cybershell.xyz/backy https://git.andrewnw.xyz/CyberShell/backy https://git.andrewnw.xyz/CyberShell/backy/src/branch/master/{/dir} https://git.andrewnw.xyz/CyberShell/backy/src/branch/master/{/dir}/{file}#L{line}">
+<style>
+* { font-family: sans-serif; }
+body { margin-top: 0; }
+.content { display: inline-block; }
+code { display: block; font-family: monospace; font-size: 1em; background-color: #d5d5d5; padding: 1em; margin-bottom: 16px; }
+ul { margin-top: 16px; margin-bottom: 16px; }
+</style>
+</head>
+<body>
+<div class="content">
+<h2>go.cybershell.xyz/backy</h2>
+<code>go get go.cybershell.xyz/backy</code>
+<code>import "go.cybershell.xyz/backy"</code>
+Home: <a href="https://backy.cybershell.xyz/">https://backy.cybershell.xyz/</a><br/>
+Source: <a href="https://git.andrewnw.xyz/CyberShell/backy">https://git.andrewnw.xyz/CyberShell/backy</a><br/>
+</div>
+</body>
+</html>

examples/backy.yaml

@@ -6,7 +6,12 @@ commands:
       - -f /some/path/to/docker-compose.yaml
       - down
     # if host is not defined, cmd will be run locally
-    host: some-host 
+    host: some-host
+    hooks:
+      final:
+        - hostname
+      error:
+        - hostname
   backup-docker-container-script:
     cmd: /path/to/script
     # The host has to be defined in the config file
@@ -21,8 +26,27 @@ commands:
       - -av some-host:/path/to/data ~/Docker/Backups/docker-data
   hostname:
     cmd: hostname
+  update-docker:
+    type: package
+    shell: zsh # best to run package commands in a shell
+    packageName: docker-ce
+    Args:
+      - docker-ce-cli
+    packageManager: apt
+    packageOperation: install
+  update-dockerApt:
+    # type: package
+    shell: zsh
+    cmd: apt
+    Args:
+      - update
+      - "&&"
+      - apt install -y docker-ce
+      - docker-ce-cli
+    packageManager: apt
+    packageOperation: install
 
-cmd-configs:
+cmd-lists:
   cmds-to-run: # this can be any name you want
     # all commands have to be defined
     order:
@@ -31,7 +55,7 @@ cmd-configs:
       - shell-cmd
       - hostname
     notifications:
-      - matrix
+      - matrix.matrix
     name: backup-some-server
     cron: "0 0 1 * * *"
   hostname:
@@ -39,7 +63,7 @@ cmd-configs:
     order:
       - hostname
     notifications:
-      - prod-email
+      - mail.prod-email
 
 hosts:
   # any ssh_config(5) keys/values not listed here will be looked up in the config file or the default config file
@@ -57,26 +81,28 @@ hosts:
 # optional
 logging:
   verbose: true
-  file: /path/to/logs/commands.log
+  file: ./backy.log
   console: false
   cmd-std-out: false
 
 
 notifications:
-  prod-email:
-    id: prod-email
-    type: mail
-    host: yourhost.tld
-    port: 587
-    senderAddress: email@domain.tld
-    to:
-      - admin@domain.tld
-    username: smtp-username@domain.tld
-    password: your-password-here
+  mail:
+    prod-email:
+      id: prod-email
+      type: mail
+      host: yourhost.tld
+      port: 587
+      senderAddress: email@domain.tld
+      to:
+        - admin@domain.tld
+      username: smtp-username@domain.tld
+      password: your-password-here
   matrix:
-    id: matrix
-    type: matrix
-    home-server: your-home-server.tld
-    room-id: room-id
-    access-token: your-access-token
-    user-id: your-user-id
+    matrix:
+      id: matrix
+      type: matrix
+      home-server: your-home-server.tld
+      room-id: room-id
+      access-token: your-access-token
+      user-id: your-user-id

examples/example.yml

@@ -0,0 +1,24 @@
+commands:
+  stop-docker-container:
+    cmd: docker
+    Args:
+      - compose
+      - -f /some/path/to/docker-compose.yaml
+      - down
+    # if host is not defined, command will be run locally
+    # The host has to be defined in either the config file or the SSH Config files
+    host: some-host
+    hooks:
+      error:
+        - some-other-command-when-failing
+      success:
+        - success-command
+      final:
+        - final-command
+  backup-docker-container-script:
+    cmd: /path/to/local/script
+    # script file is input as stdin to SSH
+    type: scriptFile # also can be script
+    environment:
+      - FOO=BAR
+      - APP=$VAR