diff options
| author | Raúl Benencia <rul@kalgan.cc> | 2019-01-09 07:03:53 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-01-09 07:03:53 -0800 |
| commit | 70bb90ae82abb46c0434d806cfd79e25b7c0098d (patch) | |
| tree | 0897c238912e95794d5a74345837ea4b352662c7 /README.md | |
| parent | f08e7ef525d431223084184e5e234ed8acbecfc4 (diff) | |
| parent | 5e8ae5156c72593eb24dd125db32e860f59be820 (diff) | |
Merge pull request #3 from rul/doc
Tidy up example files and add an scdoc manpage
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 10 |
1 files changed, 5 insertions, 5 deletions
@@ -22,7 +22,7 @@ As soon as Shoelaces starts, the service will be patiently waiting for servers to boot. If no servers are detected, you'll simply see a spinner in the web UI, as can be seen in the screenshot. - + The URL `localhost:8081` will actually point to wherever you are running your Shoelaces instance. It must be reachable by the booting hosts. @@ -30,7 +30,7 @@ Shoelaces instance. It must be reachable by the booting hosts. The following picture shows a high level overview of how a server notifies Shoelaces that it's ready for booting. - + In this graph we can see that as soon as the server boots using network boot, we instruct the machine to switch to an [iPXE](https://ipxe.org/) ROM. We do this @@ -50,7 +50,7 @@ guessed, will be pointing to Shoelaces. If there was no automated installation configured for the booting server, you'll be able to select an option to bootstrap it in the Shoelaces UI. - + A couple of things can be said about this screenshot: @@ -95,7 +95,7 @@ Shoelaces accepts several parameters: * `config`: the path to a configuration file. * `data-dir`: the path to the root directory with the templates. It's advised to manage the templates in a VCS, such as a git repository. Refer to the [example - data directory](configs/example-templates-configs/) for more information. + data directory](configs/data-dir/) for more information. * `debug`: enable debug messages. * `domain`: the domain Shoelaces is going to be listening on. * `mappings-file`: the path to the YAML mappings file, relative to the `data-dir` parameter. @@ -178,7 +178,7 @@ that. Shoelaces will read these mappings from a YAML file that can be passed as a program parameter. Refer to the [example mappings -file](configs/example-templates-configs/mappings.yaml) for more information. +file](configs/data-dir/mappings.yaml) for more information. ## Environments |