Elgato_dark/fleet
1
0
Fork 0
mirror of https://github.com/fleetdm/fleet synced 2026-04-21 13:37:30 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 91

Update build documentation (#3)

Browse source 
Co-authored-by: Mike McNeil <7157539-mikerlmcneil@users.noreply.gitlab.com>
This commit is contained in:
noahtalerman 2020-11-03 15:18:45 -08:00 committed by GitHub
parent c6b285c56e
commit be28d8e3c6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 20 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/development/building-the-code.md
View file

@ -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:

23
docs/infrastructure/adding-hosts-to-fleet.md
View file

@ -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