Compare commits
No commits in common. "develop" and "commandHooks" have entirely different histories.
develop
...
commandHoo
@ -1 +0,0 @@
|
||||
*.yaml
|
||||
3
.changes/unreleased/Added-20240828-142730.yaml
Normal file
3
.changes/unreleased/Added-20240828-142730.yaml
Normal file
@ -0,0 +1,3 @@
|
||||
kind: Added
|
||||
body: Lists config can now go in a file. See docs for more information.
|
||||
time: 2024-08-28T14:27:30.427754114-05:00
|
||||
3
.changes/unreleased/Added-20241008-223733.yaml
Normal file
3
.changes/unreleased/Added-20241008-223733.yaml
Normal file
@ -0,0 +1,3 @@
|
||||
kind: Added
|
||||
body: 'new commands.[name].type: script. Works just like scriptFile, but can take arguments.'
|
||||
time: 2024-10-08T22:37:33.664140846-05:00
|
||||
3
.changes/unreleased/Added-20241114-210148.yaml
Normal file
3
.changes/unreleased/Added-20241114-210148.yaml
Normal file
@ -0,0 +1,3 @@
|
||||
kind: Added
|
||||
body: Hooks for Commands.[name]. Error, success, and final. [#12]
|
||||
time: 2024-11-14T21:01:48.823426401-06:00
|
||||
@ -1,3 +0,0 @@
|
||||
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
|
||||
@ -1,3 +0,0 @@
|
||||
kind: Added
|
||||
body: 'Command lists: added `cmdLists.[name].notify` object'
|
||||
time: 2025-05-01T11:07:45.96164753-05:00
|
||||
@ -1,3 +0,0 @@
|
||||
kind: Added
|
||||
body: Testing setup with Docker
|
||||
time: 2025-07-04T08:59:17.430373451-05:00
|
||||
@ -1,3 +0,0 @@
|
||||
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
|
||||
3
.changes/unreleased/Changed-20240514-195817.yaml
Normal file
3
.changes/unreleased/Changed-20240514-195817.yaml
Normal file
@ -0,0 +1,3 @@
|
||||
kind: Changed
|
||||
body: GetKnownHosts is now a method of Host
|
||||
time: 2024-05-14T19:58:17.516072381-05:00
|
||||
@ -1,3 +0,0 @@
|
||||
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
|
||||
@ -1,3 +0,0 @@
|
||||
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
|
||||
@ -1,3 +0,0 @@
|
||||
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
|
||||
@ -1,3 +0,0 @@
|
||||
kind: Changed
|
||||
body: 'Internal: refactoring and renaming functions'
|
||||
time: 2025-04-18T13:34:40.842541658-05:00
|
||||
@ -1,3 +0,0 @@
|
||||
kind: Changed
|
||||
body: 'Commands: moved output-prefixed keys to the `commands.[name].output` object'
|
||||
time: 2025-05-01T11:05:34.90130087-05:00
|
||||
@ -1,3 +0,0 @@
|
||||
kind: Changed
|
||||
body: Change internal method name for better understanding
|
||||
time: 2025-06-09T07:26:01.819927627-05:00
|
||||
3
.changes/unreleased/Fixed-20241114-211306.yaml
Normal file
3
.changes/unreleased/Fixed-20241114-211306.yaml
Normal file
@ -0,0 +1,3 @@
|
||||
kind: Fixed
|
||||
body: make command logger be used for errors, not just when running the command
|
||||
time: 2024-11-14T21:13:06.404134926-06:00
|
||||
@ -1,3 +0,0 @@
|
||||
kind: Fixed
|
||||
body: 'Command Lists: hooks now run correctly when commands finish'
|
||||
time: 2025-04-18T09:57:47.39035092-05:00
|
||||
@ -1,3 +0,0 @@
|
||||
kind: Fixed
|
||||
body: Log file passed using `--log-file` correctly used
|
||||
time: 2025-04-24T22:57:11.592829277-05:00
|
||||
@ -1,16 +0,0 @@
|
||||
## 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
|
||||
@ -1,8 +0,0 @@
|
||||
## 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`
|
||||
@ -1,6 +0,0 @@
|
||||
## 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
|
||||
@ -1,9 +0,0 @@
|
||||
## 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
|
||||
@ -1,4 +0,0 @@
|
||||
## 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)
|
||||
@ -1,3 +0,0 @@
|
||||
## 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.
|
||||
@ -1,16 +0,0 @@
|
||||
## 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
|
||||
@ -1,3 +0,0 @@
|
||||
## v0.7.1 - 2025-02-14
|
||||
### Fixed
|
||||
* Incorrect local config file loading logic caused files to not be detected
|
||||
@ -1,3 +0,0 @@
|
||||
## v0.7.2 - 2025-02-14
|
||||
### Fixed
|
||||
* CI configs
|
||||
@ -1,3 +0,0 @@
|
||||
## v0.7.3 - 2025-02-14
|
||||
### Changed
|
||||
* GoReleaser configs
|
||||
@ -1,5 +0,0 @@
|
||||
## 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
|
||||
@ -1,5 +0,0 @@
|
||||
## 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
|
||||
@ -1,4 +0,0 @@
|
||||
## v0.7.6 - 2025-02-14
|
||||
### Fixed
|
||||
* v0.7.1: Incorrect local config file loading logic caused files to not be detected
|
||||
* CI configs
|
||||
@ -1,4 +0,0 @@
|
||||
## v0.7.7 - 2025-02-14
|
||||
### Fixed
|
||||
* v0.7.1: Incorrect local config file loading logic caused files to not be detected
|
||||
* CI configs
|
||||
@ -1,4 +0,0 @@
|
||||
## 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
|
||||
@ -1,6 +0,0 @@
|
||||
## 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
|
||||
@ -1,12 +0,0 @@
|
||||
## 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
|
||||
@ -1,3 +0,0 @@
|
||||
## v0.9.1 - 2025-03-01
|
||||
### Changed
|
||||
* Use EnvVar AWS_PROFILE to get S3 profile
|
||||
22
.github/workflows/release.yml
vendored
22
.github/workflows/release.yml
vendored
@ -15,26 +15,26 @@ jobs:
|
||||
goreleaser:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions/checkout@v3
|
||||
with:
|
||||
fetch-depth: 0
|
||||
- run: git fetch --force --tags
|
||||
- uses: actions/setup-go@v5
|
||||
- uses: actions/setup-go@v4
|
||||
with:
|
||||
go-version: '1.23'
|
||||
go-version: '1.20'
|
||||
cache: true
|
||||
# More assembly might be required: Docker logins, GPG, etc. It all depends
|
||||
# on your needs.
|
||||
- uses: olegtarasov/get-tag@v2.1.4
|
||||
id: tagName
|
||||
- name: Get tag
|
||||
id: tag
|
||||
uses: dawidd6/action-get-tag@v1
|
||||
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
|
||||
# Optionally strip `v` prefix
|
||||
strip_v: false
|
||||
- uses: goreleaser/goreleaser-action@v4
|
||||
with:
|
||||
distribution: goreleaser
|
||||
version: 2.7.0
|
||||
args: release --release-notes=".changes/${{ env.GIT_TAG_NAME }}.md" -f .goreleaser/github.yml --clean
|
||||
version: latest
|
||||
args: release --release-notes=".changes/${{steps.tag.outputs.tag}}.md" -f .goreleaser/github.yml --clean
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GORELEASER_TOKEN }}
|
||||
GIT_TAG_NAME: ${{ steps.tagName.outputs.tag }}
|
||||
|
||||
8
.gitignore
vendored
8
.gitignore
vendored
@ -1,10 +1,2 @@
|
||||
!.changie.yaml
|
||||
!.changes/**
|
||||
|
||||
dist/
|
||||
.codegpt
|
||||
|
||||
*.log
|
||||
/*.sh
|
||||
/*.yaml
|
||||
/*.yml
|
||||
|
||||
6
.gitmodules
vendored
6
.gitmodules
vendored
@ -1,7 +1,3 @@
|
||||
[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
|
||||
url = https://github.com/McShelby/hugo-theme-relearn
|
||||
|
||||
@ -1,4 +1,3 @@
|
||||
version: 2
|
||||
before:
|
||||
hooks:
|
||||
# You may remove this if you don't use go modules.
|
||||
@ -6,6 +5,7 @@ before:
|
||||
builds:
|
||||
- env:
|
||||
- CGO_ENABLED=0
|
||||
- GOPROXY=https://goproxy.io
|
||||
goos:
|
||||
- freebsd
|
||||
- linux
|
||||
@ -15,7 +15,7 @@ builds:
|
||||
- arm64
|
||||
|
||||
archives:
|
||||
- formats: tar.gz
|
||||
- format: tar.gz
|
||||
# this name template makes the OS and Arch compatible with the results of uname.
|
||||
name_template: >-
|
||||
{{ .ProjectName }}_{{ .Version }}_
|
||||
@ -27,13 +27,13 @@ archives:
|
||||
# use zip for windows archives
|
||||
format_overrides:
|
||||
- goos: windows
|
||||
formats: [zip]
|
||||
format: zip
|
||||
checksum:
|
||||
name_template: 'checksums.txt'
|
||||
snapshot:
|
||||
version_template: "{{ incpatch .Version }}-next"
|
||||
name_template: "{{ incpatch .Version }}-next"
|
||||
changelog:
|
||||
disable: false
|
||||
skip: false
|
||||
|
||||
gitea_urls:
|
||||
api: https://git.andrewnw.xyz/api/v1
|
||||
|
||||
@ -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:
|
||||
- formats: tar.gz
|
||||
- format: 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
|
||||
formats: [zip]
|
||||
format: zip
|
||||
checksum:
|
||||
name_template: 'checksums.txt'
|
||||
snapshot:
|
||||
version_template: "{{ incpatch .Version }}-next"
|
||||
name_template: "{{ incpatch .Version }}-next"
|
||||
changelog:
|
||||
sort: asc
|
||||
filters:
|
||||
|
||||
4
.vscode/settings.json
vendored
4
.vscode/settings.json
vendored
@ -1,7 +1,6 @@
|
||||
{
|
||||
"cSpell.words": [
|
||||
"Cmds",
|
||||
"remotefetcher",
|
||||
"knadh",
|
||||
"koanf",
|
||||
"mattn",
|
||||
@ -9,6 +8,5 @@
|
||||
"mautrix",
|
||||
"nikoksr",
|
||||
"Strs"
|
||||
],
|
||||
"CodeGPT.apiKey": "CodeGPT Plus Beta"
|
||||
]
|
||||
}
|
||||
@ -1,18 +1,11 @@
|
||||
steps:
|
||||
golang:
|
||||
image: golang:1.23
|
||||
release:
|
||||
image: goreleaser/goreleaser
|
||||
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
|
||||
|
||||
secrets: [ gitea_token ]
|
||||
when:
|
||||
event: tag
|
||||
# release:
|
||||
# image: goreleaser/goreleaser
|
||||
# commands:
|
||||
|
||||
when:
|
||||
- event: tag
|
||||
|
||||
@ -5,10 +5,6 @@ steps:
|
||||
- go build
|
||||
- go test
|
||||
release:
|
||||
image: golangci/golangci-lint:v1.64.7
|
||||
image: golangci/golangci-lint:v1.53.3
|
||||
commands:
|
||||
- golangci-lint run -v --timeout 5m
|
||||
|
||||
when:
|
||||
- event: push
|
||||
branch: develop
|
||||
- golangci-lint run -v --timeout 5m
|
||||
@ -1,11 +1,9 @@
|
||||
steps:
|
||||
build:
|
||||
image: hugomods/hugo:ci
|
||||
image: klakegg/hugo:ext-debian-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:
|
||||
@ -23,14 +21,10 @@ steps:
|
||||
- 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
|
||||
secrets: [ ssh_host_key, ssh_deploy_key, ssh_passphrase ]
|
||||
|
||||
|
||||
when:
|
||||
- branch: master
|
||||
- path: 'docs/**'
|
||||
- event: push
|
||||
branch: master
|
||||
path: "docs/*"
|
||||
145
CHANGELOG.md
145
CHANGELOG.md
@ -6,151 +6,6 @@ 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.
|
||||
|
||||
@ -1,27 +0,0 @@
|
||||
{
|
||||
"folders": [
|
||||
{
|
||||
"name": "backy",
|
||||
"path": "."
|
||||
}
|
||||
],
|
||||
"settings": {
|
||||
"cSpell.words": [
|
||||
"Autorestic",
|
||||
"changie",
|
||||
"Cmds",
|
||||
"CMDSTDOUT",
|
||||
"goreleaser",
|
||||
"knadh",
|
||||
"koanf",
|
||||
"mattn",
|
||||
"maunium",
|
||||
"mautrix",
|
||||
"nikoksr",
|
||||
"packagemanagercommon",
|
||||
"rawbytes",
|
||||
"remotefetcher",
|
||||
"Strs"
|
||||
]
|
||||
}
|
||||
}
|
||||
@ -12,8 +12,8 @@ import (
|
||||
|
||||
var (
|
||||
backupCmd = &cobra.Command{
|
||||
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.",
|
||||
Use: "backup [--lists=list1,list2,... | -l list1, list2,...]",
|
||||
Short: "Runs commands defined in config file.",
|
||||
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,21 +23,16 @@ var (
|
||||
var cmdLists []string
|
||||
|
||||
func init() {
|
||||
parseS3Config()
|
||||
|
||||
backupCmd.Flags().StringArrayVarP(&cmdLists, "lists", "l", nil, "Accepts comma-separated names of command lists to execute.")
|
||||
backupCmd.Flags().StringSliceVarP(&cmdLists, "lists", "l", nil, "Accepts comma-separated names of command lists to execute.")
|
||||
|
||||
}
|
||||
|
||||
func Backup(cmd *cobra.Command, args []string) {
|
||||
backyConfOpts := backy.NewConfigOptions(configFile,
|
||||
backy.AddCommandLists(cmdLists),
|
||||
backy.SetLogFile(logFile),
|
||||
backy.EnableCommandStdOut(cmdStdOut),
|
||||
backy.SetHostsConfigFile(hostsConfigFile))
|
||||
|
||||
backyConfOpts := backy.NewOpts(cfgFile, backy.AddCommandLists(cmdLists))
|
||||
backyConfOpts.InitConfig()
|
||||
backyConfOpts.ParseConfigurationFile()
|
||||
|
||||
backy.ReadConfig(backyConfOpts)
|
||||
|
||||
backyConfOpts.RunListConfig("")
|
||||
for _, host := range backyConfOpts.Hosts {
|
||||
|
||||
@ -1,54 +0,0 @@
|
||||
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"
|
||||
|
||||
// }
|
||||
@ -20,7 +20,7 @@ package cmd
|
||||
|
||||
// func config(cmd *cobra.Command, args []string) {
|
||||
|
||||
// opts := backy.NewConfigOptions(configFile, backy.cronEnabled())
|
||||
// opts := backy.NewOpts(cfgFile, backy.cronEnabled())
|
||||
// opts.InitConfig()
|
||||
|
||||
// }
|
||||
|
||||
11
cmd/cron.go
11
cmd/cron.go
@ -16,16 +16,9 @@ var (
|
||||
)
|
||||
|
||||
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.CronEnabled())
|
||||
opts.InitConfig()
|
||||
opts.ParseConfigurationFile()
|
||||
|
||||
backy.ReadConfig(opts)
|
||||
opts.Cron()
|
||||
}
|
||||
|
||||
16
cmd/exec.go
16
cmd/exec.go
@ -20,24 +20,14 @@ var (
|
||||
}
|
||||
)
|
||||
|
||||
func init() {
|
||||
execCmd.AddCommand(hostExecCommand)
|
||||
|
||||
}
|
||||
|
||||
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.", 1, nil)
|
||||
}
|
||||
|
||||
opts := backy.NewConfigOptions(configFile,
|
||||
backy.AddCommands(args),
|
||||
backy.SetLogFile(logFile),
|
||||
backy.EnableCommandStdOut(cmdStdOut),
|
||||
backy.SetHostsConfigFile(hostsConfigFile))
|
||||
opts := backy.NewOpts(cfgFile, backy.AddCommands(args))
|
||||
opts.InitConfig()
|
||||
opts.ParseConfigurationFile()
|
||||
opts.ExecuteCmds()
|
||||
// opts.InitMongo()
|
||||
backy.ReadConfig(opts).ExecuteCmds(opts)
|
||||
}
|
||||
|
||||
81
cmd/host.go
81
cmd/host.go
@ -1,81 +0,0 @@
|
||||
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)
|
||||
}
|
||||
71
cmd/list.go
71
cmd/list.go
@ -6,29 +6,16 @@ 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,
|
||||
Use: "list [--list=list1,list2,... | -l list1, list2,...] [ -cmd cmd1 cmd2 cmd3...]",
|
||||
Short: "Lists commands, lists, or hosts defined in config file.",
|
||||
Long: "Backup lists commands or groups defined in config file.\nUse the --lists or -l flag to list the specified lists. If not flag is not given, all lists will be executed.",
|
||||
Run: List,
|
||||
}
|
||||
)
|
||||
|
||||
@ -36,55 +23,27 @@ var listsToList []string
|
||||
var cmdsToList []string
|
||||
|
||||
func init() {
|
||||
listCmd.AddCommand(listCmds, listCmdLists)
|
||||
|
||||
listCmd.Flags().StringSliceVarP(&listsToList, "lists", "l", nil, "Accepts comma-separated names of command lists to list.")
|
||||
listCmd.Flags().StringSliceVarP(&cmdsToList, "cmds", "c", nil, "Accepts comma-separated names of commands to list.")
|
||||
|
||||
}
|
||||
|
||||
func ListCommands(cmd *cobra.Command, args []string) {
|
||||
func List(cmd *cobra.Command, args []string) {
|
||||
|
||||
// setup based on whats passed in:
|
||||
// settup 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)
|
||||
if cmdLists != nil {
|
||||
|
||||
}
|
||||
|
||||
parseS3Config()
|
||||
|
||||
opts := backy.NewConfigOptions(configFile,
|
||||
backy.SetLogFile(logFile),
|
||||
backy.SetHostsConfigFile(hostsConfigFile))
|
||||
opts := backy.NewOpts(cfgFile)
|
||||
|
||||
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)
|
||||
}
|
||||
|
||||
opts = backy.ReadConfig(opts)
|
||||
|
||||
opts.ListCommand("rm-sn-db")
|
||||
}
|
||||
|
||||
21
cmd/root.go
21
cmd/root.go
@ -13,12 +13,8 @@ import (
|
||||
|
||||
var (
|
||||
// Used for flags.
|
||||
configFile string
|
||||
hostsConfigFile string
|
||||
verbose bool
|
||||
cmdStdOut bool
|
||||
logFile string
|
||||
s3Endpoint string
|
||||
cfgFile string
|
||||
verbose bool
|
||||
|
||||
rootCmd = &cobra.Command{
|
||||
Use: "backy",
|
||||
@ -36,18 +32,9 @@ func Execute() {
|
||||
}
|
||||
|
||||
func init() {
|
||||
rootCmd.PersistentFlags().StringVar(&logFile, "log-file", "", "log file to write to")
|
||||
rootCmd.PersistentFlags().BoolVar(&cmdStdOut, "cmdStdOut", false, "Pass to print command output to stdout")
|
||||
|
||||
rootCmd.PersistentFlags().StringVarP(&configFile, "config", "f", "", "config file to read from")
|
||||
rootCmd.PersistentFlags().StringVar(&hostsConfigFile, "hostsConfig", "", "yaml hosts file to read from")
|
||||
rootCmd.PersistentFlags().StringVarP(&cfgFile, "config", "f", "", "config file to read from")
|
||||
rootCmd.PersistentFlags().BoolVarP(&verbose, "verbose", "v", false, "Sets verbose level")
|
||||
rootCmd.PersistentFlags().StringVar(&s3Endpoint, "s3-endpoint", "", "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)
|
||||
}
|
||||
}
|
||||
|
||||
@ -7,7 +7,7 @@ import (
|
||||
"github.com/spf13/cobra"
|
||||
)
|
||||
|
||||
const versionStr = "0.10.2"
|
||||
const versionStr = "0.4.0"
|
||||
|
||||
var (
|
||||
versionCmd = &cobra.Command{
|
||||
|
||||
2
docs/.gitignore
vendored
2
docs/.gitignore
vendored
@ -1,2 +0,0 @@
|
||||
public/
|
||||
resources/_gen
|
||||
90
docs/config.toml
Normal file
90
docs/config.toml
Normal file
@ -0,0 +1,90 @@
|
||||
baseURL = 'http://example.org/'
|
||||
languageCode = 'en-us'
|
||||
title = 'A tool for commands'
|
||||
|
||||
# Change the default theme to be use when building the site with Hugo
|
||||
theme = "hugo-theme-relearn"
|
||||
|
||||
# For search functionality
|
||||
[outputs]
|
||||
home = [ "HTML", "RSS", "SEARCH"]
|
||||
|
||||
[params]
|
||||
# This controls whether submenus will be expanded (true), or collapsed (false) in the
|
||||
# menu; if no setting is given, the first menu level is set to false, all others to true;
|
||||
# this can be overridden in the pages frontmatter
|
||||
alwaysopen = false
|
||||
# Prefix URL to edit current page. Will display an "Edit" button on top right hand corner of every page.
|
||||
# Useful to give opportunity to people to create merge request for your doc.
|
||||
# See the config.toml file from this documentation site to have an example.
|
||||
editURL = ""
|
||||
# Author of the site, will be used in meta information
|
||||
author = ""
|
||||
# Description of the site, will be used in meta information
|
||||
description = ""
|
||||
# Shows a checkmark for visited pages on the menu
|
||||
showVisitedLinks = false
|
||||
# Disable search function. It will hide search bar
|
||||
disableSearch = false
|
||||
# Disable search in hidden pages, otherwise they will be shown in search box
|
||||
disableSearchHiddenPages = false
|
||||
# Disables hidden pages from showing up in the sitemap and on Google (et all), otherwise they may be indexed by search engines
|
||||
disableSeoHiddenPages = false
|
||||
# Disables hidden pages from showing up on the tags page although the tag term will be displayed even if all pages are hidden
|
||||
disableTagHiddenPages = false
|
||||
# Javascript and CSS cache are automatically busted when new version of site is generated.
|
||||
# Set this to true to disable this behavior (some proxies don't handle well this optimization)
|
||||
disableAssetsBusting = false
|
||||
# Set this to true if you want to disable generation for generator version meta tags of hugo and the theme;
|
||||
# don't forget to also set Hugo's disableHugoGeneratorInject=true, otherwise it will generate a meta tag into your home page
|
||||
disableGeneratorVersion = false
|
||||
# Set this to true to disable copy-to-clipboard button for inline code.
|
||||
disableInlineCopyToClipBoard = false
|
||||
# A title for shortcuts in menu is set by default. Set this to true to disable it.
|
||||
disableShortcutsTitle = false
|
||||
# If set to false, a Home button will appear below the search bar on the menu.
|
||||
# It is redirecting to the landing page of the current language if specified. (Default is "/")
|
||||
disableLandingPageButton = true
|
||||
# When using mulitlingual website, disable the switch language button.
|
||||
disableLanguageSwitchingButton = false
|
||||
# Hide breadcrumbs in the header and only show the current page title
|
||||
disableBreadcrumb = true
|
||||
# If set to true, hide table of contents menu in the header of all pages
|
||||
disableToc = false
|
||||
# If set to false, load the MathJax module on every page regardless if a MathJax shortcode is present
|
||||
disableMathJax = false
|
||||
# Specifies the remote location of the MathJax js
|
||||
customMathJaxURL = "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"
|
||||
# Initialization parameter for MathJax, see MathJax documentation
|
||||
mathJaxInitialize = "{}"
|
||||
# If set to false, load the Mermaid module on every page regardless if a Mermaid shortcode or Mermaid codefence is present
|
||||
disableMermaid = false
|
||||
# Specifies the remote location of the Mermaid js
|
||||
customMermaidURL = "https://unpkg.com/mermaid/dist/mermaid.min.js"
|
||||
# Initialization parameter for Mermaid, see Mermaid documentation
|
||||
mermaidInitialize = "{ \"theme\": \"default\" }"
|
||||
# If set to false, load the Swagger module on every page regardless if a Swagger shortcode is present
|
||||
disableSwagger = false
|
||||
# Specifies the remote location of the RapiDoc js
|
||||
customSwaggerURL = "https://unpkg.com/rapidoc/dist/rapidoc-min.js"
|
||||
# Initialization parameter for Swagger, see RapiDoc documentation
|
||||
swaggerInitialize = "{ \"theme\": \"light\" }"
|
||||
# Hide Next and Previous page buttons normally displayed full height beside content
|
||||
disableNextPrev = true
|
||||
# Order sections in menu by "weight" or "title". Default to "weight";
|
||||
# this can be overridden in the pages frontmatter
|
||||
ordersectionsby = "weight"
|
||||
# Change default color scheme with a variant one. Eg. can be "auto", "red", "blue", "green" or an array like [ "blue", "green" ].
|
||||
themeVariant = "auto"
|
||||
# Change the title separator. Default to "::".
|
||||
titleSeparator = "-"
|
||||
# If set to true, the menu in the sidebar will be displayed in a collapsible tree view. Although the functionality works with old browsers (IE11), the display of the expander icons is limited to modern browsers
|
||||
collapsibleMenu = true
|
||||
# If a single page can contain content in multiple languages, add those here
|
||||
additionalContentLanguage = [ "en" ]
|
||||
# If set to true, no index.html will be appended to prettyURLs; this will cause pages not
|
||||
# to be servable from the file system
|
||||
disableExplicitIndexURLs = false
|
||||
# For external links you can define how they are opened in your browser; this setting will only be applied to the content area but not the shortcut menu
|
||||
externalLinkTarget = "_blank"
|
||||
|
||||
@ -1,78 +0,0 @@
|
||||
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
|
||||
@ -7,8 +7,6 @@ Backy is a tool for automating data backup and remote command execution. It can
|
||||
|
||||
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 %}}
|
||||
@ -17,10 +15,6 @@ Feel free to open a [PR](https://git.andrewnw.xyz/CyberShell/backy/pulls), raise
|
||||
|
||||
- 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
|
||||
|
||||
@ -14,21 +14,18 @@ Usage:
|
||||
backy [command]
|
||||
|
||||
Available Commands:
|
||||
backup Runs commands defined in config file. Use -l flag multiple times to run multiple lists.
|
||||
backup Runs commands defined in config file.
|
||||
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.
|
||||
list Lists 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
|
||||
--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
|
||||
-f, --config string config file to read from
|
||||
-h, --help help for backy
|
||||
-v, --verbose Sets verbose level
|
||||
|
||||
Use "backy [command] --help" for more information about a command.
|
||||
```
|
||||
@ -42,18 +39,15 @@ 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]
|
||||
backy backup [--lists=list1,list2,... | -l list1, list2,...] [flags]
|
||||
|
||||
Flags:
|
||||
-h, --help help for backup
|
||||
-l, --lists stringArray Accepts comma-separated names of command lists to execute.
|
||||
-h, --help help for backup
|
||||
-l, --lists strings 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
|
||||
--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
|
||||
-f, --config string config file to read from
|
||||
-v, --verbose Sets verbose level
|
||||
```
|
||||
|
||||
## cron
|
||||
@ -68,11 +62,8 @@ Flags:
|
||||
-h, --help help for cron
|
||||
|
||||
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
|
||||
-f, --config string config file to read from
|
||||
-v, --verbose Sets verbose level
|
||||
```
|
||||
|
||||
## exec
|
||||
@ -82,44 +73,13 @@ 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.
|
||||
|
||||
Flags:
|
||||
-h, --help help for exec
|
||||
|
||||
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
|
||||
|
||||
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
|
||||
--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
|
||||
-f, --config string config file to read from
|
||||
-v, --verbose Sets verbose level
|
||||
```
|
||||
|
||||
## version
|
||||
@ -136,70 +96,24 @@ Flags:
|
||||
-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
|
||||
--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
|
||||
-f, --config string config file to read from
|
||||
-v, --verbose Sets verbose level
|
||||
```
|
||||
|
||||
## list
|
||||
|
||||
```
|
||||
List commands, lists, or hosts defined in config file
|
||||
Backup lists commands or groups defined in config file.
|
||||
Use the --lists or -l flag to list the specified lists. If not flag is not given, all lists will be executed.
|
||||
|
||||
Usage:
|
||||
backy list [command]
|
||||
|
||||
Available Commands:
|
||||
cmds List commands defined in config file.
|
||||
lists List lists defined in config file.
|
||||
backy list [--list=list1,list2,... | -l list1, list2,...] [ -cmd cmd1 cmd2 cmd3...] [flags]
|
||||
|
||||
Flags:
|
||||
-h, --help help for list
|
||||
-h, --help help for list
|
||||
-l, --lists strings Accepts comma-separated names of command lists to 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
|
||||
|
||||
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
|
||||
--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
|
||||
```
|
||||
## 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
|
||||
--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
|
||||
-f, --config string config file to read from
|
||||
-v, --verbose Sets verbose level
|
||||
```
|
||||
|
||||
@ -1,19 +0,0 @@
|
||||
---
|
||||
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]
|
||||
```
|
||||
@ -1,29 +0,0 @@
|
||||
---
|
||||
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
|
||||
```
|
||||
@ -10,31 +10,13 @@ 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()`.
|
||||
- `./backy.yml`
|
||||
- `./backy.yaml`
|
||||
- `~/.config/backy.yml`
|
||||
- `~/.config/backy.yaml`
|
||||
|
||||
{{% expand title="`UserConfigDir()` documentation:" %}}
|
||||
Create a file at `~/.config/backy.yml`.
|
||||
|
||||
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" %}}
|
||||
See the rest of the documentation in this section to configure it.
|
||||
|
||||
@ -2,27 +2,14 @@
|
||||
title: "Command Lists"
|
||||
weight: 2
|
||||
description: >
|
||||
This page tells you how to use command lists.
|
||||
This page tells you how to get started with Backy.
|
||||
---
|
||||
|
||||
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"}
|
||||
```yaml
|
||||
test2:
|
||||
name: test2
|
||||
order:
|
||||
@ -35,12 +22,12 @@ If a remote config file is specified (on the command-line using `-f`) and the li
|
||||
```
|
||||
|
||||
| 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` | Defines the sequence of commands to execute | `[]string` | yes |
|
||||
| `getOutput` | Command(s) output is in the notification(s) | `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
|
||||
|
||||
@ -64,20 +51,20 @@ An array of notification IDs to use on success and failure. Must match any of th
|
||||
|
||||
### Name
|
||||
|
||||
Name is optional. If name is not defined, name will be the object's map key.
|
||||
Name is optional for logging. 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.
|
||||
Adding `cron: 0 0 1 * * *` to a `cmd-lists` 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.
|
||||
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:
|
||||
```yaml
|
||||
cmd-lists:
|
||||
docker-container-backup: # this can be any name you want
|
||||
# all commands have to be defined
|
||||
order:
|
||||
|
||||
118
docs/content/config/commands.md
Normal file
118
docs/content/config/commands.md
Normal file
@ -0,0 +1,118 @@
|
||||
---
|
||||
title: "Commands"
|
||||
weight: 1
|
||||
---
|
||||
|
||||
The yaml top-level map can be any string.
|
||||
|
||||
The top-level name must be unique.
|
||||
|
||||
### Example Config
|
||||
|
||||
```yaml
|
||||
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
|
||||
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
|
||||
```
|
||||
|
||||
Values available for this section:
|
||||
|
||||
| name | notes | type | required
|
||||
| --- | --- | --- | --- |
|
||||
| `cmd` | Defines the command to execute | `string` | yes |
|
||||
| `args` | Defines the arguments to the command | `[]string` | no |
|
||||
| `environment` | Defines evironment variables for the command | `[]string` | no |
|
||||
| `type` | May be `scriptFile` or `script`. Runs script from local machine on remote. Only applicable when `host` is defined. | `string` | no |
|
||||
| `getOutput` | Command(s) output is in the notification(s) | `bool` | no |
|
||||
| `host` | If not specified, the command will execute locally. | `string` | no |
|
||||
| `scriptEnvFile` | When type is `scriptFile`, the script is appended to this file. | `string` | no |
|
||||
| `shell` | Only applicable when host is not specified | `string` | no |
|
||||
|
||||
#### cmd
|
||||
|
||||
cmd must be a valid command or script to execute.
|
||||
|
||||
#### args
|
||||
|
||||
args must be arguments to cmd as they would be 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 and host is NOT defined, the command will run in the specified shell.
|
||||
Make sure to escape any shell input.
|
||||
|
||||
### scriptEnvFile
|
||||
|
||||
Path to a file.
|
||||
|
||||
When type is `scriptFile`, the script is appended to this file.
|
||||
|
||||
This is useful for specifiing environment variables or other things so they don't have to be included in the script.
|
||||
|
||||
### type
|
||||
|
||||
May be `scriptFile` or `script`. Runs script from local machine on remote host passed to the SSH session as standard input.
|
||||
|
||||
If `type` is `script`, `cmd` is used as the script.
|
||||
|
||||
If `type` is `scriptFile`, cmd must be a script file.
|
||||
|
||||
### environment
|
||||
|
||||
The environment variables support expansion:
|
||||
|
||||
- using escaped values `$VAR` or `${VAR}`
|
||||
|
||||
For now, the variables have to be defined in an `.env` file in the same directory as the config file.
|
||||
|
||||
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.
|
||||
@ -1,128 +0,0 @@
|
||||
---
|
||||
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.
|
||||
@ -1,79 +0,0 @@
|
||||
---
|
||||
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)
|
||||
}
|
||||
```
|
||||
@ -1,66 +0,0 @@
|
||||
---
|
||||
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)
|
||||
}
|
||||
```
|
||||
@ -1,15 +0,0 @@
|
||||
---
|
||||
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.
|
||||
@ -1,24 +0,0 @@
|
||||
---
|
||||
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`. For now these hosts need to be defined in the config file.
|
||||
@ -5,7 +5,6 @@ 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.
|
||||
|
||||
@ -39,23 +38,23 @@ There must be a section with an id (eg. `mail.test-svr`) following one of these
|
||||
|
||||
### 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
|
||||
| key | description | type
|
||||
| --- | --- | ---
|
||||
| `host` | Specifies the SMTP host to connect to | `string`
|
||||
| `port` | Specifies the SMTP port | `uint16`
|
||||
| `senderaddress` | Address from which to send mail | `string`
|
||||
| `to` | Recipients to send emails to | `[]string`
|
||||
| `username` | SMTP username | `string`
|
||||
| `password` | SMTP password | `string`
|
||||
|
||||
### 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
|
||||
| key | description | type
|
||||
| --- | --- | ---
|
||||
| `home-server` | Specifies the Matrix server connect to | `string`
|
||||
| `room-id` | Specifies the room ID of the room to send messages to | `string`
|
||||
| `access-token` | Matrix access token | `string`
|
||||
| `user-id` | Matrix user ID | `string`
|
||||
|
||||
To get your access token (assumes you are using [Element](https://element.io/)) :
|
||||
|
||||
|
||||
@ -1,21 +0,0 @@
|
||||
---
|
||||
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.
|
||||
@ -1,12 +1,11 @@
|
||||
---
|
||||
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.
|
||||
Vault config can be used by prefixing `vault:` in front of a password or ENV var.
|
||||
|
||||
This is the object in the config file:
|
||||
|
||||
@ -18,12 +17,10 @@ vault:
|
||||
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
|
||||
type: # KVv1 or KVv2
|
||||
- name:
|
||||
path:
|
||||
type:
|
||||
mountpath:
|
||||
```
|
||||
|
||||
@ -1,108 +0,0 @@
|
||||
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
|
||||
@ -1,24 +0,0 @@
|
||||
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
|
||||
@ -48,7 +48,7 @@ commands:
|
||||
To execute groups of commands in sequence, use a list configuration.
|
||||
|
||||
```yaml
|
||||
cmdLists:
|
||||
cmd-lists:
|
||||
cmds-to-run: # this can be any name you want
|
||||
# all commands have to be defined in the commands section
|
||||
order:
|
||||
@ -97,29 +97,25 @@ hosts:
|
||||
|
||||
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`.
|
||||
For more, [see the notification object documentation](/config/notifications). The top-level map key is id that has to be referenced by the `cmd-lists` 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
|
||||
prod-email:
|
||||
type: mail
|
||||
host: yourhost.tld
|
||||
port: 587
|
||||
senderAddress: email@domain.tld
|
||||
recipients:
|
||||
- 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
|
||||
type: matrix
|
||||
home-server: your-home-server.tld
|
||||
room-id: room-id
|
||||
access-token: your-access-token
|
||||
user-id: your-user-id
|
||||
```
|
||||
|
||||
### Logging
|
||||
@ -130,7 +126,7 @@ If logfile is not defined, the log file will be written to the config directory
|
||||
|
||||
`console-disabled` controls whether the logging messages are echoed to StdOut. Default is false.
|
||||
|
||||
`verbose` prints out debugging messages.
|
||||
`verbose` basically does nothing as all necessary info is already output.
|
||||
|
||||
```yaml
|
||||
logging:
|
||||
@ -144,7 +140,7 @@ logging:
|
||||
|
||||
[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
|
||||
|
||||
@ -1,8 +1,5 @@
|
||||
module git.andrewnw.xyz/CyberShell/backy/docs
|
||||
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
|
||||
)
|
||||
require github.com/McShelby/hugo-theme-relearn v0.0.0-20230209073138-890d12ea922d // indirect
|
||||
|
||||
@ -1,10 +1,2 @@
|
||||
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=
|
||||
|
||||
@ -1,84 +0,0 @@
|
||||
<!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>
|
||||
File diff suppressed because one or more lines are too long
@ -1,3 +0,0 @@
|
||||
{{ $file := .Get "file" | readFile }}
|
||||
{{ $lang := .Get "language" }}
|
||||
{{ (print "```" $lang "\n" $file "\n```") }}
|
||||
66
docs/public/404.html
Normal file
66
docs/public/404.html
Normal file
@ -0,0 +1,66 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en" dir="ltr">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="height=device-height, width=device-width, initial-scale=1.0, minimum-scale=1.0">
|
||||
<meta name="generator" content="Hugo 0.110.0">
|
||||
<meta name="generator" content="Relearn 5.11.2">
|
||||
<meta name="description" content="">
|
||||
<title>404 Page not found - A tool for commands</title>
|
||||
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how-to-use -->
|
||||
<link href="/css/fontawesome-all.min.css?1676866111" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/css/fontawesome-all.min.css?1676866111" rel="stylesheet"></noscript>
|
||||
<link href="/css/auto-complete.css?1676866111" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/css/auto-complete.css?1676866111" rel="stylesheet"></noscript>
|
||||
<link href="/css/perfect-scrollbar.min.css?1676866111" rel="stylesheet">
|
||||
<link href="/css/nucleus.css?1676866111" rel="stylesheet">
|
||||
<link href="/css/fonts.css?1676866111" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/css/fonts.css?1676866111" rel="stylesheet"></noscript>
|
||||
<link href="/css/theme.css?1676866111" rel="stylesheet">
|
||||
<link href="/css/theme-auto.css?1676866111" rel="stylesheet" id="variant-style">
|
||||
<link href="/css/ie.css?1676866111" rel="stylesheet">
|
||||
<link href="/css/variant.css?1676866111" rel="stylesheet">
|
||||
<link href="/css/print.css?1676866111" rel="stylesheet" media="print">
|
||||
<script src="/js/url.js?1676866111"></script>
|
||||
<script src="/js/variant.js?1676866111"></script>
|
||||
<script>
|
||||
// hack to let hugo tell us how to get to the root when using relativeURLs, it needs to be called *url= for it to do its magic:
|
||||
// https://github.com/gohugoio/hugo/blob/145b3fcce35fbac25c7033c91c1b7ae6d1179da8/transform/urlreplacers/absurlreplacer.go#L72
|
||||
window.index_js_url="/index.search.js";
|
||||
var root_url="/";
|
||||
var baseUri=root_url.replace(/\/$/, '');
|
||||
// translations
|
||||
window.T_Copy_to_clipboard = 'Copy to clipboard';
|
||||
window.T_Copied_to_clipboard = 'Copied to clipboard!';
|
||||
window.T_Copy_link_to_clipboard = 'Copy link to clipboard';
|
||||
window.T_Link_copied_to_clipboard = 'Copied link to clipboard!';
|
||||
window.T_No_results_found = 'No results found for \u0022{0}\u0022';
|
||||
window.T_N_results_found = '{1} results found for \u0022{0}\u0022';
|
||||
// some further base stuff
|
||||
var baseUriFull='http:\/\/example.org/';
|
||||
window.variants && variants.init( [ 'auto' ] );
|
||||
</script>
|
||||
<style>
|
||||
p, li, ul {
|
||||
text-align: center
|
||||
}
|
||||
ul {
|
||||
list-style-type: none;
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body class="mobile-support" data-url="/404.html">
|
||||
<div id="body" class="default-animation" style="margin-left:0px;">
|
||||
<div id="sidebar-overlay"></div>
|
||||
<main id="body-inner" class="chapter" tabindex="-1">
|
||||
<div class="flex-block-wrapper">
|
||||
<article class="default">
|
||||
<h1 id="error">Error</h1>
|
||||
<p></p>
|
||||
<p>Woops. Looks like this page doesn't exist ¯\_(ツ)_/¯.</p>
|
||||
<p></p>
|
||||
<p><a href="/index.html">Go to homepage</a></p>
|
||||
<p><img src="/images/gopher-404.jpg" style="width:50%" alt="Page not found!"></p>
|
||||
</article>
|
||||
</div>
|
||||
</main>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
238
docs/public/categories/index.html
Normal file
238
docs/public/categories/index.html
Normal file
File diff suppressed because one or more lines are too long
10
docs/public/categories/index.xml
Normal file
10
docs/public/categories/index.xml
Normal file
@ -0,0 +1,10 @@
|
||||
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
|
||||
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
|
||||
<channel>
|
||||
<title>Categories on A tool for commands</title>
|
||||
<link>http://example.org/categories/index.html</link>
|
||||
<description>Recent content in Categories on A tool for commands</description>
|
||||
<generator>Hugo -- gohugo.io</generator>
|
||||
<language>en-us</language><atom:link href="http://example.org/categories/index.xml" rel="self" type="application/rss+xml" />
|
||||
</channel>
|
||||
</rss>
|
||||
303
docs/public/cli/index.html
Normal file
303
docs/public/cli/index.html
Normal file
File diff suppressed because one or more lines are too long
10
docs/public/cli/index.xml
Normal file
10
docs/public/cli/index.xml
Normal file
@ -0,0 +1,10 @@
|
||||
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
|
||||
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
|
||||
<channel>
|
||||
<title>CLI on A tool for commands</title>
|
||||
<link>http://example.org/cli/index.html</link>
|
||||
<description>Recent content in CLI on A tool for commands</description>
|
||||
<generator>Hugo -- gohugo.io</generator>
|
||||
<language>en-us</language><atom:link href="http://example.org/cli/index.xml" rel="self" type="application/rss+xml" />
|
||||
</channel>
|
||||
</rss>
|
||||
327
docs/public/config/command-lists/index.html
Normal file
327
docs/public/config/command-lists/index.html
Normal file
File diff suppressed because one or more lines are too long
353
docs/public/config/commands/index.html
Normal file
353
docs/public/config/commands/index.html
Normal file
File diff suppressed because one or more lines are too long
251
docs/public/config/index.html
Normal file
251
docs/public/config/index.html
Normal file
File diff suppressed because one or more lines are too long
39
docs/public/config/index.xml
Normal file
39
docs/public/config/index.xml
Normal file
@ -0,0 +1,39 @@
|
||||
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
|
||||
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
|
||||
<channel>
|
||||
<title>Configuring Backy on A tool for commands</title>
|
||||
<link>http://example.org/config/index.html</link>
|
||||
<description>Recent content in Configuring Backy on A tool for commands</description>
|
||||
<generator>Hugo -- gohugo.io</generator>
|
||||
<language>en-us</language><atom:link href="http://example.org/config/index.xml" rel="self" type="application/rss+xml" />
|
||||
<item>
|
||||
<title>Command Lists</title>
|
||||
<link>http://example.org/config/command-lists/index.html</link>
|
||||
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
|
||||
<guid>http://example.org/config/command-lists/index.html</guid>
|
||||
<description>Command lists are for executing commands in sequence and getting notifications from them.
|
||||
The top-level object key can be anything you want.
|
||||
key description type required order Defines the sequence of commands to execute []string yes notifications The notification IDs to use on success and failure []string no name Optional name of the list string no cron Time at which to schedule the list. string no Order The order is an array of commands to execute in order.</description>
|
||||
</item>
|
||||
<item>
|
||||
<title>Commands</title>
|
||||
<link>http://example.org/config/commands/index.html</link>
|
||||
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
|
||||
<guid>http://example.org/config/commands/index.html</guid>
|
||||
<description>The yaml top-level map can be any string.
|
||||
The top-level name must be unique.
|
||||
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 host: some-host backup-docker-container-script: cmd: /path/to/script # The host has to be defined in either the config file or the SSH Config files host: some-host environment: - FOO=BAR - APP=$VAR Values available for this section:</description>
|
||||
</item>
|
||||
<item>
|
||||
<title>Notifications</title>
|
||||
<link>http://example.org/config/notifications/index.html</link>
|
||||
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
|
||||
<guid>http://example.org/config/notifications/index.html</guid>
|
||||
<description>Notifications can be sent on command list completion and failure.
|
||||
The supported platforms for notifications are email (SMTP) and Matrix.
|
||||
Notifications are defined by type. The top-level object will be the id, and the type is required.
|
||||
Info Type in a cmd-configs object must match one of these.
|
||||
notifications: 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: type: matrix home-server: your-home-server.tld room-id: room-id access-token: your-access-token user-id: your-user-id Types recognized are type: mail and type: matrix</description>
|
||||
</item>
|
||||
</channel>
|
||||
</rss>
|
||||
376
docs/public/config/notifications/index.html
Normal file
376
docs/public/config/notifications/index.html
Normal file
File diff suppressed because one or more lines are too long
58
docs/public/css/auto-complete.css
Normal file
58
docs/public/css/auto-complete.css
Normal file
@ -0,0 +1,58 @@
|
||||
.autocomplete-suggestions {
|
||||
text-align: left;
|
||||
cursor: default;
|
||||
border: 1px solid #ccc;
|
||||
border-top: 0;
|
||||
background: #fff;
|
||||
box-shadow: -1px 1px 3px rgba(0,0,0,.1);
|
||||
|
||||
/* core styles should not be changed */
|
||||
position: absolute;
|
||||
display: none;
|
||||
z-index: 9999;
|
||||
max-height: 150px;
|
||||
max-height: calc( 100vh - 150px );
|
||||
overflow: hidden;
|
||||
overflow-y: auto;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
.autocomplete-suggestion {
|
||||
position: relative;
|
||||
cursor: pointer;
|
||||
padding: 7px;
|
||||
line-height: 23px;
|
||||
white-space: nowrap;
|
||||
overflow: hidden;
|
||||
text-overflow: ellipsis;
|
||||
color: #282828;
|
||||
}
|
||||
|
||||
.autocomplete-suggestion b {
|
||||
font-weight: normal;
|
||||
color: #1f8dd6;
|
||||
}
|
||||
|
||||
.autocomplete-suggestion.selected {
|
||||
background: #282828;
|
||||
color: #fff;
|
||||
}
|
||||
|
||||
.autocomplete-suggestion:hover,
|
||||
.autocomplete-suggestion:focus,
|
||||
.autocomplete-suggestion:active,
|
||||
.autocomplete-suggestion:hover > .context,
|
||||
.autocomplete-suggestion:focus > .context,
|
||||
.autocomplete-suggestion:active > .context,
|
||||
#searchresults .autocomplete-suggestion:hover > .context,
|
||||
#searchresults .autocomplete-suggestion:focus > .context,
|
||||
#searchresults .autocomplete-suggestion:active > .context {
|
||||
background: #383838;
|
||||
color: #fff;
|
||||
}
|
||||
|
||||
.autocomplete-suggestion > .context {
|
||||
font-size: 12px;
|
||||
margin-inline-start: 1em;
|
||||
overflow: hidden;
|
||||
text-overflow: ellipsis;
|
||||
}
|
||||
83
docs/public/css/chroma-learn.css
Normal file
83
docs/public/css/chroma-learn.css
Normal file
@ -0,0 +1,83 @@
|
||||
/* based on base16-snazzy
|
||||
/* Background */ .chroma { color: #e2e4e5; background-color: #282a36 }
|
||||
/* Other */ .chroma .x { }
|
||||
/* Error */ .chroma .err { color: #ff5c57 }
|
||||
/* LineTableTD */ .chroma .lntd { vertical-align: top; padding: 0; margin: 0; border: 0; }
|
||||
/* LineTable */ .chroma .lntable { border-spacing: 0; padding: 0; margin: 0; border: 0; width: auto; overflow: auto; display: block; }
|
||||
/* LineHighlight */ .chroma .hl { display: block; width: 100%;background-color: #ffffcc }
|
||||
/* LineNumbersTable */ .chroma .lnt { margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #7f7f7f }
|
||||
/* LineNumbers */ .chroma .ln { margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #7f7f7f }
|
||||
/* Keyword */ .chroma .k { color: #ff6ac1 }
|
||||
/* KeywordConstant */ .chroma .kc { color: #ff6ac1 }
|
||||
/* KeywordDeclaration */ .chroma .kd { color: #ff5c57 }
|
||||
/* KeywordNamespace */ .chroma .kn { color: #ff6ac1 }
|
||||
/* KeywordPseudo */ .chroma .kp { color: #ff6ac1 }
|
||||
/* KeywordReserved */ .chroma .kr { color: #ff6ac1 }
|
||||
/* KeywordType */ .chroma .kt { color: #9aedfe }
|
||||
/* Name */ .chroma .n { }
|
||||
/* NameAttribute */ .chroma .na { color: #57c7ff }
|
||||
/* NameBuiltin */ .chroma .nb { color: #ff5c57 }
|
||||
/* NameBuiltinPseudo */ .chroma .bp { }
|
||||
/* NameClass */ .chroma .nc { color: #f3f99d }
|
||||
/* NameConstant */ .chroma .no { color: #ff9f43 }
|
||||
/* NameDecorator */ .chroma .nd { color: #ff9f43 }
|
||||
/* NameEntity */ .chroma .ni { }
|
||||
/* NameException */ .chroma .ne { }
|
||||
/* NameFunction */ .chroma .nf { color: #57c7ff }
|
||||
/* NameFunctionMagic */ .chroma .fm { }
|
||||
/* NameLabel */ .chroma .nl { color: #ff5c57 }
|
||||
/* NameNamespace */ .chroma .nn { }
|
||||
/* NameOther */ .chroma .nx { }
|
||||
/* NameProperty */ .chroma .py { }
|
||||
/* NameTag */ .chroma .nt { color: #ff6ac1 }
|
||||
/* NameVariable */ .chroma .nv { color: #ff5c57 }
|
||||
/* NameVariableClass */ .chroma .vc { color: #ff5c57 }
|
||||
/* NameVariableGlobal */ .chroma .vg { color: #ff5c57 }
|
||||
/* NameVariableInstance */ .chroma .vi { color: #ff5c57 }
|
||||
/* NameVariableMagic */ .chroma .vm { }
|
||||
/* Literal */ .chroma .l { }
|
||||
/* LiteralDate */ .chroma .ld { }
|
||||
/* LiteralString */ .chroma .s { color: #5af78e }
|
||||
/* LiteralStringAffix */ .chroma .sa { color: #5af78e }
|
||||
/* LiteralStringBacktick */ .chroma .sb { color: #5af78e }
|
||||
/* LiteralStringChar */ .chroma .sc { color: #5af78e }
|
||||
/* LiteralStringDelimiter */ .chroma .dl { color: #5af78e }
|
||||
/* LiteralStringDoc */ .chroma .sd { color: #5af78e }
|
||||
/* LiteralStringDouble */ .chroma .s2 { color: #5af78e }
|
||||
/* LiteralStringEscape */ .chroma .se { color: #5af78e }
|
||||
/* LiteralStringHeredoc */ .chroma .sh { color: #5af78e }
|
||||
/* LiteralStringInterpol */ .chroma .si { color: #5af78e }
|
||||
/* LiteralStringOther */ .chroma .sx { color: #5af78e }
|
||||
/* LiteralStringRegex */ .chroma .sr { color: #5af78e }
|
||||
/* LiteralStringSingle */ .chroma .s1 { color: #5af78e }
|
||||
/* LiteralStringSymbol */ .chroma .ss { color: #5af78e }
|
||||
/* LiteralNumber */ .chroma .m { color: #ff9f43 }
|
||||
/* LiteralNumberBin */ .chroma .mb { color: #ff9f43 }
|
||||
/* LiteralNumberFloat */ .chroma .mf { color: #ff9f43 }
|
||||
/* LiteralNumberHex */ .chroma .mh { color: #ff9f43 }
|
||||
/* LiteralNumberInteger */ .chroma .mi { color: #ff9f43 }
|
||||
/* LiteralNumberIntegerLong */ .chroma .il { color: #ff9f43 }
|
||||
/* LiteralNumberOct */ .chroma .mo { color: #ff9f43 }
|
||||
/* Operator */ .chroma .o { color: #ff6ac1 }
|
||||
/* OperatorWord */ .chroma .ow { color: #ff6ac1 }
|
||||
/* Punctuation */ .chroma .p { }
|
||||
/* Comment */ .chroma .c { color: #78787e }
|
||||
/* CommentHashbang */ .chroma .ch { color: #78787e }
|
||||
/* CommentMultiline */ .chroma .cm { color: #78787e }
|
||||
/* CommentSingle */ .chroma .c1 { color: #78787e }
|
||||
/* CommentSpecial */ .chroma .cs { color: #78787e }
|
||||
/* CommentPreproc */ .chroma .cp { color: #78787e }
|
||||
/* CommentPreprocFile */ .chroma .cpf { color: #78787e }
|
||||
/* Generic */ .chroma .g { }
|
||||
/* GenericDeleted */ .chroma .gd { color: #ff5c57 }
|
||||
/* GenericEmph */ .chroma .ge { text-decoration: underline }
|
||||
/* GenericError */ .chroma .gr { color: #ff5c57 }
|
||||
/* GenericHeading */ .chroma .gh { font-weight: bold }
|
||||
/* GenericInserted */ .chroma .gi { font-weight: bold }
|
||||
/* GenericOutput */ .chroma .go { color: #43454f }
|
||||
/* GenericPrompt */ .chroma .gp { }
|
||||
/* GenericStrong */ .chroma .gs { font-style: italic }
|
||||
/* GenericSubheading */ .chroma .gu { font-weight: bold }
|
||||
/* GenericTraceback */ .chroma .gt { }
|
||||
/* GenericUnderline */ .chroma .gl { text-decoration: underline }
|
||||
/* TextWhitespace */ .chroma .w { }
|
||||
89
docs/public/css/chroma-neon.css
Normal file
89
docs/public/css/chroma-neon.css
Normal file
@ -0,0 +1,89 @@
|
||||
/* this variant does not work well if we use fallback styles for IE11 so better
|
||||
ignore this variant in IE completely */
|
||||
@supports not (-ms-high-contrast:none) {
|
||||
|
||||
/* based on rrt
|
||||
/* Background */ .chroma { color: #f8f8f2; background-color: #000000 }
|
||||
/* Other */ .chroma .x { }
|
||||
/* Error */ .chroma .err { }
|
||||
/* LineTableTD */ .chroma .lntd { vertical-align: top; padding: 0; margin: 0; border: 0; }
|
||||
/* LineTable */ .chroma .lntable { border-spacing: 0; padding: 0; margin: 0; border: 0; width: auto; overflow: auto; display: block; }
|
||||
/* LineHighlight */ .chroma .hl { display: block; width: 100%;background-color: #ffffcc }
|
||||
/* LineNumbersTable */ .chroma .lnt { margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #7c7c79 }
|
||||
/* LineNumbers */ .chroma .ln { margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #7c7c79 }
|
||||
/* Keyword */ .chroma .k { color: #ff0000 }
|
||||
/* KeywordConstant */ .chroma .kc { color: #ff0000 }
|
||||
/* KeywordDeclaration */ .chroma .kd { color: #ff0000 }
|
||||
/* KeywordNamespace */ .chroma .kn { color: #ff0000 }
|
||||
/* KeywordPseudo */ .chroma .kp { color: #ff0000 }
|
||||
/* KeywordReserved */ .chroma .kr { color: #ff0000 }
|
||||
/* KeywordType */ .chroma .kt { color: #ee82ee }
|
||||
/* Name */ .chroma .n { }
|
||||
/* NameAttribute */ .chroma .na { }
|
||||
/* NameBuiltin */ .chroma .nb { }
|
||||
/* NameBuiltinPseudo */ .chroma .bp { }
|
||||
/* NameClass */ .chroma .nc { }
|
||||
/* NameConstant */ .chroma .no { color: #7fffd4 }
|
||||
/* NameDecorator */ .chroma .nd { }
|
||||
/* NameEntity */ .chroma .ni { }
|
||||
/* NameException */ .chroma .ne { }
|
||||
/* NameFunction */ .chroma .nf { color: #ffff00 }
|
||||
/* NameFunctionMagic */ .chroma .fm { }
|
||||
/* NameLabel */ .chroma .nl { }
|
||||
/* NameNamespace */ .chroma .nn { }
|
||||
/* NameOther */ .chroma .nx { }
|
||||
/* NameProperty */ .chroma .py { }
|
||||
/* NameTag */ .chroma .nt { }
|
||||
/* NameVariable */ .chroma .nv { color: #eedd82 }
|
||||
/* NameVariableClass */ .chroma .vc { }
|
||||
/* NameVariableGlobal */ .chroma .vg { }
|
||||
/* NameVariableInstance */ .chroma .vi { }
|
||||
/* NameVariableMagic */ .chroma .vm { }
|
||||
/* Literal */ .chroma .l { }
|
||||
/* LiteralDate */ .chroma .ld { }
|
||||
/* LiteralString */ .chroma .s { color: #87ceeb }
|
||||
/* LiteralStringAffix */ .chroma .sa { color: #87ceeb }
|
||||
/* LiteralStringBacktick */ .chroma .sb { color: #87ceeb }
|
||||
/* LiteralStringChar */ .chroma .sc { color: #87ceeb }
|
||||
/* LiteralStringDelimiter */ .chroma .dl { color: #87ceeb }
|
||||
/* LiteralStringDoc */ .chroma .sd { color: #87ceeb }
|
||||
/* LiteralStringDouble */ .chroma .s2 { color: #87ceeb }
|
||||
/* LiteralStringEscape */ .chroma .se { color: #87ceeb }
|
||||
/* LiteralStringHeredoc */ .chroma .sh { color: #87ceeb }
|
||||
/* LiteralStringInterpol */ .chroma .si { color: #87ceeb }
|
||||
/* LiteralStringOther */ .chroma .sx { color: #87ceeb }
|
||||
/* LiteralStringRegex */ .chroma .sr { color: #87ceeb }
|
||||
/* LiteralStringSingle */ .chroma .s1 { color: #87ceeb }
|
||||
/* LiteralStringSymbol */ .chroma .ss { color: #ff6600 }
|
||||
/* LiteralNumber */ .chroma .m { color: #ff6600 }
|
||||
/* LiteralNumberBin */ .chroma .mb { color: #ff6600 }
|
||||
/* LiteralNumberFloat */ .chroma .mf { color: #ff6600 }
|
||||
/* LiteralNumberHex */ .chroma .mh { color: #ff6600 }
|
||||
/* LiteralNumberInteger */ .chroma .mi { color: #ff6600 }
|
||||
/* LiteralNumberIntegerLong */ .chroma .il { color: #ff6600 }
|
||||
/* LiteralNumberOct */ .chroma .mo { color: #ff6600 }
|
||||
/* Operator */ .chroma .o { }
|
||||
/* OperatorWord */ .chroma .ow { }
|
||||
/* Punctuation */ .chroma .p { }
|
||||
/* Comment */ .chroma .c { color: #00ff00 }
|
||||
/* CommentHashbang */ .chroma .ch { color: #00ff00 }
|
||||
/* CommentMultiline */ .chroma .cm { color: #00ff00 }
|
||||
/* CommentSingle */ .chroma .c1 { color: #00ff00 }
|
||||
/* CommentSpecial */ .chroma .cs { color: #00ff00 }
|
||||
/* CommentPreproc */ .chroma .cp { color: #e5e5e5 }
|
||||
/* CommentPreprocFile */ .chroma .cpf { color: #e5e5e5 }
|
||||
/* Generic */ .chroma .g { }
|
||||
/* GenericDeleted */ .chroma .gd { }
|
||||
/* GenericEmph */ .chroma .ge { }
|
||||
/* GenericError */ .chroma .gr { }
|
||||
/* GenericHeading */ .chroma .gh { }
|
||||
/* GenericInserted */ .chroma .gi { }
|
||||
/* GenericOutput */ .chroma .go { }
|
||||
/* GenericPrompt */ .chroma .gp { }
|
||||
/* GenericStrong */ .chroma .gs { }
|
||||
/* GenericSubheading */ .chroma .gu { }
|
||||
/* GenericTraceback */ .chroma .gt { }
|
||||
/* GenericUnderline */ .chroma .gl { }
|
||||
/* TextWhitespace */ .chroma .w { }
|
||||
|
||||
}
|
||||
83
docs/public/css/chroma-relearn-dark.css
Normal file
83
docs/public/css/chroma-relearn-dark.css
Normal file
@ -0,0 +1,83 @@
|
||||
/* based on monokai
|
||||
/* Background */ .chroma { color: #f8f8f8; background-color: #2b2b2b }
|
||||
/* Other */ .chroma .x { }
|
||||
/* Error */ .chroma .err { color: #960050; }
|
||||
/* LineTableTD */ .chroma .lntd { vertical-align: top; padding: 0; margin: 0; border: 0; }
|
||||
/* LineTable */ .chroma .lntable { border-spacing: 0; padding: 0; margin: 0; border: 0; width: auto; overflow: auto; display: block; }
|
||||
/* LineHighlight */ .chroma .hl { display: block; width: 100%;background-color: #ffffcc }
|
||||
/* LineNumbersTable */ .chroma .lnt { margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #7f7f7f }
|
||||
/* LineNumbers */ .chroma .ln { margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #7f7f7f }
|
||||
/* Keyword */ .chroma .k { color: #66d9ef }
|
||||
/* KeywordConstant */ .chroma .kc { color: #66d9ef }
|
||||
/* KeywordDeclaration */ .chroma .kd { color: #66d9ef }
|
||||
/* KeywordNamespace */ .chroma .kn { color: #f92672 }
|
||||
/* KeywordPseudo */ .chroma .kp { color: #66d9ef }
|
||||
/* KeywordReserved */ .chroma .kr { color: #66d9ef }
|
||||
/* KeywordType */ .chroma .kt { color: #66d9ef }
|
||||
/* Name */ .chroma .n { }
|
||||
/* NameAttribute */ .chroma .na { color: #a6e22e }
|
||||
/* NameBuiltin */ .chroma .nb { }
|
||||
/* NameBuiltinPseudo */ .chroma .bp { }
|
||||
/* NameClass */ .chroma .nc { color: #a6e22e }
|
||||
/* NameConstant */ .chroma .no { color: #66d9ef }
|
||||
/* NameDecorator */ .chroma .nd { color: #a6e22e }
|
||||
/* NameEntity */ .chroma .ni { }
|
||||
/* NameException */ .chroma .ne { color: #a6e22e }
|
||||
/* NameFunction */ .chroma .nf { color: #a6e22e }
|
||||
/* NameFunctionMagic */ .chroma .fm { }
|
||||
/* NameLabel */ .chroma .nl { }
|
||||
/* NameNamespace */ .chroma .nn { }
|
||||
/* NameOther */ .chroma .nx { color: #a6e22e }
|
||||
/* NameProperty */ .chroma .py { }
|
||||
/* NameTag */ .chroma .nt { color: #f92672 }
|
||||
/* NameVariable */ .chroma .nv { }
|
||||
/* NameVariableClass */ .chroma .vc { }
|
||||
/* NameVariableGlobal */ .chroma .vg { }
|
||||
/* NameVariableInstance */ .chroma .vi { }
|
||||
/* NameVariableMagic */ .chroma .vm { }
|
||||
/* Literal */ .chroma .l { color: #ae81ff }
|
||||
/* LiteralDate */ .chroma .ld { color: #e6db74 }
|
||||
/* LiteralString */ .chroma .s { color: #e6db74 }
|
||||
/* LiteralStringAffix */ .chroma .sa { color: #e6db74 }
|
||||
/* LiteralStringBacktick */ .chroma .sb { color: #e6db74 }
|
||||
/* LiteralStringChar */ .chroma .sc { color: #e6db74 }
|
||||
/* LiteralStringDelimiter */ .chroma .dl { color: #e6db74 }
|
||||
/* LiteralStringDoc */ .chroma .sd { color: #e6db74 }
|
||||
/* LiteralStringDouble */ .chroma .s2 { color: #e6db74 }
|
||||
/* LiteralStringEscape */ .chroma .se { color: #ae81ff }
|
||||
/* LiteralStringHeredoc */ .chroma .sh { color: #e6db74 }
|
||||
/* LiteralStringInterpol */ .chroma .si { color: #e6db74 }
|
||||
/* LiteralStringOther */ .chroma .sx { color: #e6db74 }
|
||||
/* LiteralStringRegex */ .chroma .sr { color: #e6db74 }
|
||||
/* LiteralStringSingle */ .chroma .s1 { color: #e6db74 }
|
||||
/* LiteralStringSymbol */ .chroma .ss { color: #e6db74 }
|
||||
/* LiteralNumber */ .chroma .m { color: #ae81ff }
|
||||
/* LiteralNumberBin */ .chroma .mb { color: #ae81ff }
|
||||
/* LiteralNumberFloat */ .chroma .mf { color: #ae81ff }
|
||||
/* LiteralNumberHex */ .chroma .mh { color: #ae81ff }
|
||||
/* LiteralNumberInteger */ .chroma .mi { color: #ae81ff }
|
||||
/* LiteralNumberIntegerLong */ .chroma .il { color: #ae81ff }
|
||||
/* LiteralNumberOct */ .chroma .mo { color: #ae81ff }
|
||||
/* Operator */ .chroma .o { color: #f92672 }
|
||||
/* OperatorWord */ .chroma .ow { color: #f92672 }
|
||||
/* Punctuation */ .chroma .p { }
|
||||
/* Comment */ .chroma .c { color: #7c7c7c }
|
||||
/* CommentHashbang */ .chroma .ch { color: #7c7c7c }
|
||||
/* CommentMultiline */ .chroma .cm { color: #7c7c7c }
|
||||
/* CommentSingle */ .chroma .c1 { color: #7c7c7c }
|
||||
/* CommentSpecial */ .chroma .cs { color: #7c7c7c }
|
||||
/* CommentPreproc */ .chroma .cp { color: #7c7c7c }
|
||||
/* CommentPreprocFile */ .chroma .cpf { color: #7c7c7c }
|
||||
/* Generic */ .chroma .g { }
|
||||
/* GenericDeleted */ .chroma .gd { color: #f92672 }
|
||||
/* GenericEmph */ .chroma .ge { font-style: italic }
|
||||
/* GenericError */ .chroma .gr { }
|
||||
/* GenericHeading */ .chroma .gh { }
|
||||
/* GenericInserted */ .chroma .gi { color: #a6e22e }
|
||||
/* GenericOutput */ .chroma .go { }
|
||||
/* GenericPrompt */ .chroma .gp { }
|
||||
/* GenericStrong */ .chroma .gs { font-weight: bold }
|
||||
/* GenericSubheading */ .chroma .gu { color: #7c7c7c }
|
||||
/* GenericTraceback */ .chroma .gt { }
|
||||
/* GenericUnderline */ .chroma .gl { }
|
||||
/* TextWhitespace */ .chroma .w { }
|
||||
83
docs/public/css/chroma-relearn-light.css
Normal file
83
docs/public/css/chroma-relearn-light.css
Normal file
@ -0,0 +1,83 @@
|
||||
/* based on tango
|
||||
/* Background */ .chroma { background-color: #f8f8f8 }
|
||||
/* Other */ .chroma .x { color: #000000 }
|
||||
/* Error */ .chroma .err { color: #a40000 }
|
||||
/* LineTableTD */ .chroma .lntd { vertical-align: top; padding: 0; margin: 0; border: 0; }
|
||||
/* LineTable */ .chroma .lntable { border-spacing: 0; padding: 0; margin: 0; border: 0; width: auto; overflow: auto; display: block; }
|
||||
/* LineHighlight */ .chroma .hl { display: block; width: 100%;background-color: #ffffcc }
|
||||
/* LineNumbersTable */ .chroma .lnt { margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #7f7f7f }
|
||||
/* LineNumbers */ .chroma .ln { margin-right: 0.4em; padding: 0 0.4em 0 0.4em;color: #7f7f7f }
|
||||
/* Keyword */ .chroma .k { color: #204a87; font-weight: bold }
|
||||
/* KeywordConstant */ .chroma .kc { color: #204a87; font-weight: bold }
|
||||
/* KeywordDeclaration */ .chroma .kd { color: #204a87; font-weight: bold }
|
||||
/* KeywordNamespace */ .chroma .kn { color: #204a87; font-weight: bold }
|
||||
/* KeywordPseudo */ .chroma .kp { color: #204a87; font-weight: bold }
|
||||
/* KeywordReserved */ .chroma .kr { color: #204a87; font-weight: bold }
|
||||
/* KeywordType */ .chroma .kt { color: #204a87; font-weight: bold }
|
||||
/* Name */ .chroma .n { color: #000000 }
|
||||
/* NameAttribute */ .chroma .na { color: #c4a000 }
|
||||
/* NameBuiltin */ .chroma .nb { color: #204a87 }
|
||||
/* NameBuiltinPseudo */ .chroma .bp { color: #3465a4 }
|
||||
/* NameClass */ .chroma .nc { color: #000000 }
|
||||
/* NameConstant */ .chroma .no { color: #000000 }
|
||||
/* NameDecorator */ .chroma .nd { color: #5c35cc; font-weight: bold }
|
||||
/* NameEntity */ .chroma .ni { color: #ce5c00 }
|
||||
/* NameException */ .chroma .ne { color: #cc0000; font-weight: bold }
|
||||
/* NameFunction */ .chroma .nf { color: #000000 }
|
||||
/* NameFunctionMagic */ .chroma .fm { color: #000000 }
|
||||
/* NameLabel */ .chroma .nl { color: #f57900 }
|
||||
/* NameNamespace */ .chroma .nn { color: #000000 }
|
||||
/* NameOther */ .chroma .nx { color: #000000 }
|
||||
/* NameProperty */ .chroma .py { color: #000000 }
|
||||
/* NameTag */ .chroma .nt { color: #204a87; font-weight: bold }
|
||||
/* NameVariable */ .chroma .nv { color: #000000 }
|
||||
/* NameVariableClass */ .chroma .vc { color: #000000 }
|
||||
/* NameVariableGlobal */ .chroma .vg { color: #000000 }
|
||||
/* NameVariableInstance */ .chroma .vi { color: #000000 }
|
||||
/* NameVariableMagic */ .chroma .vm { color: #000000 }
|
||||
/* Literal */ .chroma .l { color: #000000 }
|
||||
/* LiteralDate */ .chroma .ld { color: #000000 }
|
||||
/* LiteralString */ .chroma .s { color: #4e9a06 }
|
||||
/* LiteralStringAffix */ .chroma .sa { color: #4e9a06 }
|
||||
/* LiteralStringBacktick */ .chroma .sb { color: #4e9a06 }
|
||||
/* LiteralStringChar */ .chroma .sc { color: #4e9a06 }
|
||||
/* LiteralStringDelimiter */ .chroma .dl { color: #4e9a06 }
|
||||
/* LiteralStringDoc */ .chroma .sd { color: #8f5902; font-style: italic }
|
||||
/* LiteralStringDouble */ .chroma .s2 { color: #4e9a06 }
|
||||
/* LiteralStringEscape */ .chroma .se { color: #4e9a06 }
|
||||
/* LiteralStringHeredoc */ .chroma .sh { color: #4e9a06 }
|
||||
/* LiteralStringInterpol */ .chroma .si { color: #4e9a06 }
|
||||
/* LiteralStringOther */ .chroma .sx { color: #4e9a06 }
|
||||
/* LiteralStringRegex */ .chroma .sr { color: #4e9a06 }
|
||||
/* LiteralStringSingle */ .chroma .s1 { color: #4e9a06 }
|
||||
/* LiteralStringSymbol */ .chroma .ss { color: #4e9a06 }
|
||||
/* LiteralNumber */ .chroma .m { color: #0000cf; font-weight: bold }
|
||||
/* LiteralNumberBin */ .chroma .mb { color: #0000cf; font-weight: bold }
|
||||
/* LiteralNumberFloat */ .chroma .mf { color: #0000cf; font-weight: bold }
|
||||
/* LiteralNumberHex */ .chroma .mh { color: #0000cf; font-weight: bold }
|
||||
/* LiteralNumberInteger */ .chroma .mi { color: #0000cf; font-weight: bold }
|
||||
/* LiteralNumberIntegerLong */ .chroma .il { color: #0000cf; font-weight: bold }
|
||||
/* LiteralNumberOct */ .chroma .mo { color: #0000cf; font-weight: bold }
|
||||
/* Operator */ .chroma .o { color: #ce5c00; font-weight: bold }
|
||||
/* OperatorWord */ .chroma .ow { color: #204a87; font-weight: bold }
|
||||
/* Punctuation */ .chroma .p { color: #000000; font-weight: bold }
|
||||
/* Comment */ .chroma .c { color: #8f5902; font-style: italic }
|
||||
/* CommentHashbang */ .chroma .ch { color: #8f5902; font-style: italic }
|
||||
/* CommentMultiline */ .chroma .cm { color: #8f5902; font-style: italic }
|
||||
/* CommentSingle */ .chroma .c1 { color: #8f5902; font-style: italic }
|
||||
/* CommentSpecial */ .chroma .cs { color: #8f5902; font-style: italic }
|
||||
/* CommentPreproc */ .chroma .cp { color: #8f5902; font-style: italic }
|
||||
/* CommentPreprocFile */ .chroma .cpf { color: #8f5902; font-style: italic }
|
||||
/* Generic */ .chroma .g { color: #000000 }
|
||||
/* GenericDeleted */ .chroma .gd { color: #a40000 }
|
||||
/* GenericEmph */ .chroma .ge { color: #000000; font-style: italic }
|
||||
/* GenericError */ .chroma .gr { color: #ef2929 }
|
||||
/* GenericHeading */ .chroma .gh { color: #000080; font-weight: bold }
|
||||
/* GenericInserted */ .chroma .gi { color: #00a000 }
|
||||
/* GenericOutput */ .chroma .go { color: #000000; font-style: italic }
|
||||
/* GenericPrompt */ .chroma .gp { color: #8f5902 }
|
||||
/* GenericStrong */ .chroma .gs { color: #000000; font-weight: bold }
|
||||
/* GenericSubheading */ .chroma .gu { color: #800080; font-weight: bold }
|
||||
/* GenericTraceback */ .chroma .gt { color: #a40000; font-weight: bold }
|
||||
/* GenericUnderline */ .chroma .gl { color: #000000; text-decoration: underline }
|
||||
/* TextWhitespace */ .chroma .w { color: #f8f8f8; text-decoration: underline }
|
||||
5
docs/public/css/fontawesome-all.min.css
vendored
Normal file
5
docs/public/css/fontawesome-all.min.css
vendored
Normal file
File diff suppressed because one or more lines are too long
39
docs/public/css/fonts.css
Normal file
39
docs/public/css/fonts.css
Normal file
@ -0,0 +1,39 @@
|
||||
@font-face {
|
||||
font-family: 'Work Sans';
|
||||
font-style: normal;
|
||||
font-weight: 200;
|
||||
src: url("../fonts/WorkSans-ExtraLight.woff") format("woff2"), url("../fonts/WorkSans-ExtraLight.woff") format("woff");
|
||||
font-display: swap;
|
||||
}
|
||||
|
||||
@font-face {
|
||||
font-family: 'Work Sans';
|
||||
font-style: normal;
|
||||
font-weight: 300;
|
||||
src: url("../fonts/WorkSans-Light.woff2") format("woff2"), url("../fonts/WorkSans-Light.woff") format("woff");
|
||||
font-display: swap;
|
||||
}
|
||||
|
||||
@font-face {
|
||||
font-family: 'Work Sans';
|
||||
font-style: normal;
|
||||
font-weight: 400;
|
||||
src: url("../fonts/WorkSans-Regular.woff2") format("woff2"), url("../fonts/WorkSans-Regular.woff") format("woff");
|
||||
font-display: swap;
|
||||
}
|
||||
|
||||
@font-face {
|
||||
font-family: 'Work Sans';
|
||||
font-style: normal;
|
||||
font-weight: 500;
|
||||
src: url("../fonts/WorkSans-Medium.woff2") format("woff2"), url("../fonts/WorkSans-Medium.woff") format("woff");
|
||||
font-display: swap;
|
||||
}
|
||||
|
||||
@font-face {
|
||||
font-family: 'Work Sans';
|
||||
font-style: normal;
|
||||
font-weight: 600;
|
||||
src: url("../fonts/WorkSans-Bold.woff2") format("woff2"), url("../fonts/WorkSans-Bold.woff") format("woff");
|
||||
font-display: swap;
|
||||
}
|
||||
233
docs/public/css/format-print.css
Normal file
233
docs/public/css/format-print.css
Normal file
@ -0,0 +1,233 @@
|
||||
@import "theme-relearn-light.css";
|
||||
|
||||
#sidebar {
|
||||
display: none;
|
||||
}
|
||||
#body {
|
||||
margin-left: 0 !important;
|
||||
min-width: 100% !important;
|
||||
max-width: 100% !important;
|
||||
width: 100% !important;
|
||||
}
|
||||
#body #navigation {
|
||||
display: none;
|
||||
}
|
||||
html{
|
||||
font-size: 8.763pt;
|
||||
}
|
||||
body {
|
||||
background-color: white;
|
||||
}
|
||||
code.copy-to-clipboard-code {
|
||||
border-bottom-right-radius: 2px;
|
||||
border-top-right-radius: 2px;
|
||||
border-right-width: 1px;
|
||||
}
|
||||
span > code.copy-to-clipboard-code {
|
||||
border-end-end-radius: 2px;
|
||||
border-start-end-radius: 2px;
|
||||
border-inline-end-width: 1px;
|
||||
}
|
||||
pre {
|
||||
border: 1px solid #ccc;
|
||||
}
|
||||
#body #topbar{
|
||||
background-color: #fff; /* avoid background bleeding*/
|
||||
border-bottom: 1px solid #ddd;
|
||||
border-radius: 0;
|
||||
padding-left: 0; /* for print, we want to align with the footer to ease the layout */
|
||||
color: #777;
|
||||
}
|
||||
.navigation,
|
||||
#top-print-link,
|
||||
#top-github-link {
|
||||
/* we don't need this while printing */
|
||||
display: none;
|
||||
}
|
||||
#body #breadcrumbs {
|
||||
width: 100%;
|
||||
}
|
||||
#body #breadcrumbs .links {
|
||||
overflow-x: hidden;
|
||||
visibility: visible;
|
||||
}
|
||||
.copy-to-clipboard-button {
|
||||
display: none;
|
||||
}
|
||||
|
||||
#body h1, #body h2, #body h3, #body .article-subheading, #body h4, #body h5, #body h6 {
|
||||
/* better contrast for colored elements */
|
||||
color: black;
|
||||
}
|
||||
#body th, #body td,
|
||||
#body code, #body strong, #body b,
|
||||
#body li, #body dd, #body dt,
|
||||
#body p,
|
||||
#body a, #body button, #body .badge .badge-content {
|
||||
/* better contrast for colored elements */
|
||||
color: black;
|
||||
}
|
||||
#body .anchor{
|
||||
display: none;
|
||||
}
|
||||
#body pre,
|
||||
#body code {
|
||||
background-color: white;
|
||||
border-color: #ddd;
|
||||
}
|
||||
|
||||
hr{
|
||||
border-bottom: 1px solid #ddd;
|
||||
}
|
||||
body,
|
||||
#body,
|
||||
#body-inner {
|
||||
overflow: visible !important; /* turn off limitations for perfect scrollbar */
|
||||
}
|
||||
#body #body-inner {
|
||||
/* reset paddings for chapters in screen */
|
||||
padding: 0 3.25rem 4rem 3.25rem;
|
||||
}
|
||||
|
||||
#body #body-inner h1 {
|
||||
border-bottom: 1px solid #ddd;
|
||||
margin-bottom: 2rem;
|
||||
padding-bottom: .75rem;
|
||||
}
|
||||
#body-inner .chapter h3:first-of-type {
|
||||
margin-top: 2rem;
|
||||
}
|
||||
|
||||
/* Children shortcode */
|
||||
.children p,
|
||||
.children-li p,
|
||||
.children-h2 p,
|
||||
.children-h3 p {
|
||||
font-size: 1rem;
|
||||
}
|
||||
|
||||
.footline {
|
||||
/* in print mode show footer line to signal reader the end of document */
|
||||
border-top: 1px solid #ddd;
|
||||
color: #777;
|
||||
margin-top: 1.5rem;
|
||||
padding-top: .75rem;
|
||||
}
|
||||
#body #body-inner .footline a,
|
||||
#body #body-inner .btn a {
|
||||
text-decoration: none;
|
||||
}
|
||||
#body #body-inner a {
|
||||
/* in print we want to distinguish links in our content from
|
||||
normal text even if printed black/white;
|
||||
don't use a.highlight in selector to also get links that are
|
||||
put as HTML into markdown */
|
||||
text-decoration-line: underline;
|
||||
}
|
||||
#toc-menu {
|
||||
/* we don't need this while printing */
|
||||
display: none;
|
||||
}
|
||||
#body #sidebar-toggle-span {
|
||||
/* we don't need this while printing */
|
||||
display: none;
|
||||
}
|
||||
#breadcrumbs .links {
|
||||
display: inline;
|
||||
}
|
||||
#topbar{
|
||||
/* the header is sticky which is not suitable for print; */
|
||||
position: inherit; /* IE11 doesn't know "initial" here */
|
||||
}
|
||||
#topbar > div {
|
||||
background-color: #ffffff; /* IE11 doesn't know "initial" here */
|
||||
}
|
||||
#body .tab-nav-button:not(.active) {
|
||||
opacity: .5;
|
||||
}
|
||||
#head-tags {
|
||||
display: none;
|
||||
}
|
||||
mark {
|
||||
background: inherit;
|
||||
color: inherit;
|
||||
}
|
||||
.mermaid > svg:hover {
|
||||
border-color: transparent;
|
||||
}
|
||||
div.box {
|
||||
border: 1px solid #ddd;
|
||||
}
|
||||
div.box > .box-content {
|
||||
background-color: white;
|
||||
}
|
||||
|
||||
rapi-doc{
|
||||
/* adjust rapi-doc internals to fill out available space with render-style=read */
|
||||
margin-left: calc( -80px );
|
||||
width: calc( 100% + 80px + 80px );
|
||||
}
|
||||
@media (max-width: 1023px) {
|
||||
rapi-doc {
|
||||
margin-left: calc( -8px );
|
||||
width: calc( 100% + 8px + 8px );
|
||||
}
|
||||
}
|
||||
rapi-doc::part(section-tag) {
|
||||
/* adjust rapi-doc internals to fill out available space with render-style=read */
|
||||
margin-left: 80px;
|
||||
margin-right: 80px;
|
||||
padding-left: 0;
|
||||
padding-right: 0;
|
||||
}
|
||||
@media (max-width: 1023px) {
|
||||
rapi-doc::part(section-tag) {
|
||||
margin-left: 8px;
|
||||
margin-right: 8px;
|
||||
padding-left: 0;
|
||||
padding-right: 0;
|
||||
}
|
||||
}
|
||||
|
||||
rapi-doc::part(section-main-content) {
|
||||
/* override variables for adapting rapidoc design to print theme */
|
||||
--fg: black;
|
||||
--fg2: black;
|
||||
--fg3: black;
|
||||
}
|
||||
|
||||
rapi-doc::part(section-overview-title) {
|
||||
/* set print color for titles */
|
||||
color: black !important;
|
||||
}
|
||||
|
||||
rapi-doc::part(operation-divider) {
|
||||
/* remove whitespace */
|
||||
margin-bottom: 1rem;
|
||||
margin-top: 1rem;
|
||||
}
|
||||
|
||||
rapi-doc::part(section-navbar) {
|
||||
/* removes the nav bar for render-style=read */
|
||||
display: none;
|
||||
}
|
||||
|
||||
.btn,
|
||||
#body .tab-nav-button {
|
||||
color: black !important;
|
||||
}
|
||||
#body .tab-nav-button.active {
|
||||
background-color: white !important;
|
||||
border-bottom-color: white !important;
|
||||
color: black;
|
||||
}
|
||||
#body .tab-nav-button:not(.active) {
|
||||
opacity: 1;
|
||||
}
|
||||
|
||||
article {
|
||||
break-before: page;
|
||||
}
|
||||
#body-inner > * > article:first-of-type {
|
||||
break-before: avoid;
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user