diff --git a/docs/development/building-the-code.md b/docs/development/building-the-code.md index 1e959c0c8d4..7a0293b22d3 100644 --- a/docs/development/building-the-code.md +++ b/docs/development/building-the-code.md @@ -3,9 +3,7 @@ Building The Code ## Building the Code -Checkout this repository to `$GOPATH/src/github.com/kolide/fleet`. If you're new to Go and you don't know about `$GOPATH`, then check out the repo to `$HOME/go/src/github.com/kolide/fleet`. You will also need to install Go (1.9 or greater). - -* [Go Documentation: Workspaces](https://golang.org/doc/code.html#Workspaces) +Clone this repository. To setup a working local development environment, you must install the following minimum toolset: diff --git a/docs/infrastructure/adding-hosts-to-fleet.md b/docs/infrastructure/adding-hosts-to-fleet.md index 191ad264d0a..e00bff2fccc 100644 --- a/docs/infrastructure/adding-hosts-to-fleet.md +++ b/docs/infrastructure/adding-hosts-to-fleet.md @@ -18,19 +18,34 @@ We provide compiled releases of the launcher for all supported platforms. Those To directly execute the launcher binary without having to mess with packages, invoke the binary with just a few flags: -- `--hostname`: the hostname of the gRPC server for your environment -- `--root_directory`: the location of the local database, pidfiles, etc. +- `--hostname`: the hostname of Fleet (aka the gRPC server for your environment) +- `--root_directory`: the location for osquery's local database, pidfiles, etc. - `--enroll_secret`: the enroll secret to authenticate hosts with Fleet (retrieve from Fleet UI or `fleetctl get enroll_secret`) ``` +mkdir .osquery ./build/launcher \ --hostname=fleet.acme.net:443 \ - --root_directory=$(mktemp -d) \ + --root_directory=.osquery \ --enroll_secret=32IeN3QLgckHUmMD3iW40kyLdNJcGzP5 ``` -You may also need to define the `--insecure` and/or `--insecure_grpc` flag. If you're running Fleet locally, include `--insecure` because your TLS certificate will not be signed by a valid CA. +You may also need to define the `--insecure` and/or `--insecure_grpc` flag. + + + + + +If you're running Fleet locally, include `--insecure` because your TLS certificate will not be signed by a valid CA: +``` +mkdir .osquery +./build/launcher \ + --hostname=localhost:8412 \ + --root_directory=.osquery \ + --enroll_secret=32IeN3QLgckHUmMD3iW40kyLdNJcGzP5 + --insecure +``` #### Generating packages