From b27b7bfd4e95b35a5dbce225ac135287a8bbdb24 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ra=C3=BAl=20Benencia?= Date: Tue, 8 Jan 2019 19:48:29 -0800 Subject: Move screenshots to docs/screenshots --- docs/screenshots/shoelaces-frontend-1.png | Bin 0 -> 49354 bytes docs/screenshots/shoelaces-frontend-2.png | Bin 0 -> 38786 bytes docs/screenshots/shoelaces-overview.png | Bin 0 -> 21554 bytes 3 files changed, 0 insertions(+), 0 deletions(-) create mode 100644 docs/screenshots/shoelaces-frontend-1.png create mode 100644 docs/screenshots/shoelaces-frontend-2.png create mode 100644 docs/screenshots/shoelaces-overview.png (limited to 'docs') diff --git a/docs/screenshots/shoelaces-frontend-1.png b/docs/screenshots/shoelaces-frontend-1.png new file mode 100644 index 0000000..96518e9 Binary files /dev/null and b/docs/screenshots/shoelaces-frontend-1.png differ diff --git a/docs/screenshots/shoelaces-frontend-2.png b/docs/screenshots/shoelaces-frontend-2.png new file mode 100644 index 0000000..4864303 Binary files /dev/null and b/docs/screenshots/shoelaces-frontend-2.png differ diff --git a/docs/screenshots/shoelaces-overview.png b/docs/screenshots/shoelaces-overview.png new file mode 100644 index 0000000..812fa8b Binary files /dev/null and b/docs/screenshots/shoelaces-overview.png differ -- cgit v1.2.3 From 5e8ae5156c72593eb24dd125db32e860f59be820 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ra=C3=BAl=20Benencia?= Date: Tue, 8 Jan 2019 21:00:42 -0800 Subject: Add scdoc manpage --- docs/shoelaces.8.scd | 120 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 120 insertions(+) create mode 100644 docs/shoelaces.8.scd (limited to 'docs') diff --git a/docs/shoelaces.8.scd b/docs/shoelaces.8.scd new file mode 100644 index 0000000..ec38101 --- /dev/null +++ b/docs/shoelaces.8.scd @@ -0,0 +1,120 @@ +shoelaces(8) + +# NAME + +shoelaces - automated server bootstrapping + +# SYNOPSIS + +*shoelaces* [options...] + +# OPTIONS + +*-config* + Specifies a config file. All the following options can be specified in + the config. + +*-data-dir* + Specifies a directory with mappings, configs, templates, etc. + +*-debug* + Enables debug mode. + +*-domain* + Specifies the address where the server is going to listen. + Defaults to "localhost". + +*-env-dir* + Specifies a directory with environment overrides. Refer to the README of + the project for more information about environment overrides. + +*-mappings-file* + Specifies a mappings YAML file. Defaults to "mappings.yaml". Refer to the + README of the project for more information about mappings. + +*-port* + Specifies the port where the server is going to listen. + Defaults to 8080. + +*-static-dir* + Specifies a custom web directory with static files. Defaults to "web". + +*-template-extension* + Shoelaces template extension. Defaults to ".slc". + +# DESCRIPTION + +Shoelaces serves over HTTP iPXE boot scripts, cloud-init configuration, and +any other configuration files to baremetal or virtual machines booting +using iPXE. It also does a few other things to make easier managing server +deployments: + +- Has a simple but nice UI to show the current configuration, and history + of servers that booted. +- Uses Go templates to handle complex configurations. +- Allows specifying the boot entry point for a given server based on its IP + address or DNS PTR record. +- Supports the notion of environments for Development and Production + environment configurations, while trying to minimize template + duplication. +- Puts unknown servers into iPXE script boot retry loop, while at the same + time showing them in the UI allowing the user to select a specific boot + configuration. + +Shoelaces is better when used along a DHCP server. Refer to the +*CONFIGURATION* section for examples on how to configure a DHCP server for +hooking it with Shoelaces. + +# CONFIGURATION + +Shoelaces searches for a config file whenever the *-config* flag is +specified. + +Here is example config file: + +``` +port=8081 +domain=localhost +data-dir=/etc/shoelaces/data-dir/ +template-extension=.slc +mappings-file=mappings.yaml +debug=true +``` + +*dhcpd*(8) can be hooked with Shoelaces by adding the following snippet in +*dhcpd.conf*(5): + +``` +# dhcp.conf +next-server ; +if exists user-class and option user-class = "iPXE" { + filename "http:///poll/1/${netX/mac:hexhyp}"; +} else { + filename "undionly.kpxe"; +} +``` + +Similarly, *dnsmasq*(8) can be configured for working with Shoelaces with +the following snippet: + +``` +dhcp-match=set:ipxe,175 # iPXE sends a 175 option. +dhcp-boot=tag:!ipxe,undionly.kpxe +dhcp-boot=http:///poll/1/${netX/mac:hexhyp} +``` + +A TFTP server such as *tftpd*(8) must be configured to serve the IPXE ROM, +*undionly.kpxe*. + +# SEE ALSO + +*dhcpd*(8) *dhcpd.conf*(5) *dnsmasq*(8) *tftpd*(8) + +# AUTHORS + +Maintained by ThousandEyes Inc. . + +Up-to-date sources can be found at https://github.com/thousandeyes/shoelaces. + +Bugs reports and patches can be submitted via GitHub's interface or +contacting the maintainers directly via email. -- cgit v1.2.3