[WIP] v0.7.0 fixes and changes to cache and remotefetcher

This commit is contained in:
2025-01-28 15:42:50 -06:00
parent 8c633fd4b2
commit 086835453b
23 changed files with 491 additions and 96 deletions

View File

@ -14,9 +14,20 @@ If you leave the config path blank, the following paths will be searched in orde
1. `./backy.yml`
2. `./backy.yaml`
3. `~/.config/backy.yml`
4. `~/.config/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()`.
Create a file at `~/.config/backy.yml`.
{{% expand title="`UserConfigDir()` documentation:" %}}
See the rest of the documentation in this section to configure it.
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" %}}

View File

@ -2,7 +2,7 @@
title: "Command Lists"
weight: 2
description: >
This page tells you how to get started with Backy.
This page tells you how to get use command lists.
---
Command lists are for executing commands in sequence and getting notifications from them.
@ -14,7 +14,7 @@ Lists can go in a separate file. Command lists should be in a separate file if:
1. key 'cmd-lists.file' is found
2. hosts.yml or hosts.yaml is found in the same directory as the backy config file
```yaml
```yaml {lineNos="true" wrap="true" title="yaml"}
test2:
name: test2
order:
@ -65,10 +65,10 @@ Backy also has a cron mode, so one can run `backy cron` and start a process that
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
```yaml {lineNos="true" wrap="true" title="yaml"}
cmd-lists:
  docker-container-backup: # this can be any name you want
    # all commands have to be defined

View File

@ -1,5 +1,6 @@
---
title: "Commands"
description: Commands are just that, commands
weight: 1
---

View File

@ -1,6 +1,7 @@
---
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`:

View File

@ -1,6 +1,7 @@
---
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.