github-personal/matchbox
1
0
Fork 0
mirror of https://github.com/outbackdingo/matchbox.git synced 2026-01-27 10:19:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve documentation of bootcfg arguments and files

Browse Source 
also fix typo in Makefile
This commit is contained in:
Spencer Brown
2016-05-26 10:33:33 -05:00
parent ba1beec39b
commit 1e0c21b1cf
2 changed files with 15 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
Documentation/config.md
View File

@@ -3,22 +3,23 @@
Configuration arguments can be provided as flags or as environment variables.
| flag | variable | example |
|------|----------|---------|
| -address | BOOTCFG_ADDRESS | 0.0.0.0:8080 |
| -rpc-address | BOOTCFG_RPC_ADDRESS | 127.0.0.1:8081
| -data-path | BOOTCFG_DATA_PATH | /var/lib/bootcfg |
| -assets-path | BOOTCFG_ASSETS_PATH | /var/lib/bootcfg/assets |
| -key-ring-path | BOOTCFG_KEY_RING_PATH | ~/.secrets/vault/bootcfg/secring.gpg |
| Disallowed | BOOTCFG_PASSPHRASE | secret passphrase |
| -log-level | BOOTCFG_LOG_LEVEL | critical, error, warning, notice, info, debug |
| flag | variable | default | example |
|------|----------|---------|---------|
| -address | BOOTCFG_ADDRESS | 127.0.0.1:8080 | 0.0.0.0:8080 |
| -log-level | BOOTCFG_LOG_LEVEL | info | critical, error, warning, notice, info, debug |
| -data-path | BOOTCFG_DATA_PATH | /var/lib/bootcfg | ~/.bootcfg |
| -assets-path | BOOTCFG_ASSETS_PATH | /var/lib/bootcfg/assets | ~/.bootcfg/assets |
| -rpc-address | BOOTCFG_RPC_ADDRESS | (RPC server disabled) | 127.0.0.1:8081 |
| -key-ring-path | BOOTCFG_KEY_RING_PATH | (no key ring) | ~/.secrets/vault/bootcfg/secring.gpg |
| (no flag) | BOOTCFG_PASSPHRASE | (no passphrase) | "secret passphrase" |
## Files and Directories
| Contents | Default Location |
|-----------|-------------------|
| data | /var/lib/bootcfg/{profiles,groups,ignition,cloud} |
| assets | /var/lib/bootcfg/assets |
| Contents | Default Location |
|:---------|:--------------------------------------------------|
| data | /var/lib/bootcfg/{profiles,groups,ignition,cloud} |
| assets | /var/lib/bootcfg/assets |
| environment variables |/etc/bootcfg.env |
## Version

2
Makefile
View File

@@ -16,7 +16,7 @@ install:
cp bin/bootcfg $(BIN_DIR)
cp bin/bootcmd $(BIN_DIR)
@echo "**************"
@echo "INSTALL SUCESS"
@echo "INSTALL SUCCESS"
@echo "**************"
@echo "bootcfg was installed to /usr/local/bin/bootcfg"
@echo "bootcmd was installed to /usr/local/bin/bootcmd"