aboutsummaryrefslogtreecommitdiff
path: root/share/doc/bashtard.5.scd
blob: 5fe37d2ce1ae88da4e24f0a30915077140d99419 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
bashtard(5)

; SPDX-FileCopyrightText: 2022 Patrick Spek <p.spek@tyil.nl>
; SPDX-License-Identifier: AGPL-3.0-or-later

# NAME

bashtard - A Bash-based configuration management utility

# INTRODUCTION

When it comes to configuration, *bashtard* checks various locations for files
defining key-value pairs, mostly for use in *playbooks*. The files use a very
simple _key_=_value_ construction. The _key_ cannot contain an equals sign (=),
but the _value_ can. Quotes around the _value_ are not needed. If you add these,
they will be taken literally. If a _key_ is found in multiple configuration
files, the first hit will be used and subsequent files will not be tried.

# PATHS

The following paths are tried, in order, from top to bottom, to find a _key_:

- $BASHTARD_ETCDIR/hosts.d/$host
- $BASHTARD_ETCDIR/os.d/${BASHTARD_PLATFORM[key]}
- $BASHTARD_ETCDIR/defaults
- $BASHTARD_ETCDIR/playbooks.d/$BASHTARD_PLAYBOOK/etc/os.d
- $BASHTARD_ETCDIR/playbooks.d/$BASHTARD_PLAYBOOK/etc/defaults
- $BASHTARD_SHAREDIR/os.d/${BASHTARD_PLATFORM[key]}
- $BASHTARD_SHAREDIR/defaults

The *$BASHTARD_* variables are set by *bashtard* itself. More information about
these variables can be found in _bashtard(3)_.

# SEE ALSO

- _bashtard(3)_ -- Functions and variables exposed by *bashtard* for use in
                 playbooks