Skip to content

Update build documentation #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zwass merged 5 commits into from
Nov 3, 2020
Merged

Update build documentation #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fa9fba1
Update adding-hosts-to-fleet.md
Oct 14, 2020
39f7847
Update adding-hosts-to-fleet.md
Oct 14, 2020
89dda83
Merge branch 'update-docs' into 'master'
noahtalerman Oct 28, 2020
e79bec0
Removed GOPATH instructions from building the code docs
noahtalerman Oct 29, 2020
d528d86
Changed 'checkout' to 'clone' in messaging
noahtalerman Oct 29, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions docs/development/building-the-code.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
23 changes: 19 additions & 4 deletions docs/infrastructure/adding-hosts-to-fleet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<!-- TODO: When is --insecure_grpc needed? -->

<!-- TODO: pull prod-focused example above out into deployment docs, then only include one example (the local one) with --insecure for easier copy+pasting during quickstart -->

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

Expand Down