diff --git a/docs/README.md b/docs/README.md index 73a09f3..4aa9227 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,4 +1,5 @@ # LURE Docs - [Build Scripts](build-scripts.md) -- [Usage](usage.md) \ No newline at end of file +- [Usage](usage.md) +- [Configuration](configuration.md) \ No newline at end of file diff --git a/docs/configuration.md b/docs/configuration.md new file mode 100644 index 0000000..4a4281b --- /dev/null +++ b/docs/configuration.md @@ -0,0 +1,33 @@ +# Configuration + +This page describes the configuration of LURE + +--- + +## Table of Contents + +- [Config file](#config-file) + - [rootCmd](#rootcmd) + - [repo](#repo) + +--- + +## Config file + +### rootCmd + +The `rootCmd` field in the config specifies which command should be used for privilege elevation. The default value is `sudo`. + +### repo + +The `repo` array in the config specifies which repos are added to LURE. Each repo must have a name and URL. A repo looks like this in the config: + +```toml +[[repo]] +name = 'default' +url = 'https://github.com/Arsen6331/lure-repo.git' +``` + +The `default` repo is added by default. Any amount of repos may be added. + +--- \ No newline at end of file