Commit Graph
182 Commits
Author SHA1 Message Date
noahtalerman 19816cee1a Add help text within user actions dropdown menu. Update copy in API documentation. (#142)
- Add help text within dropdown in smaller font size underneath "Require password reset" saying "This will revoke all active Fleet API tokens for this user."
- Update API docs to use "API token" parlance instead of "Auth token"
2020-12-21 15:47:35 -08:00
noahtalerman e9a77cc64a Add information on datastore options in Fleet to FAQ. (#136) 2020-12-16 16:20:38 -08:00
noahtalerman d4780770e0 Update question on fleet performance in FAQ. (#135)
Add copy to Fleet stress test question in infrastructure FAQ.
2020-12-16 16:14:40 -08:00
Matteo Piano c89cd370d5 Add AWS S3 as file carving backend (#126)
This adds the option to set up an S3 bucket as the storage backend for file carving (partially solving #111).

It works by using the multipart upload capabilities of S3 to maintain compatibility with the "upload in blocks" protocol that osquery uses. It does this basically replacing the carve_blocks table while still maintaining the metadata in the original place (it would probably be possible to rely completely on S3 by using object tagging at the cost of listing performance). To make this pluggable, I created a new field in the service struct dedicated to the CarveStore which, if no configuration for S3 is set up will be just a reference to the standard datastore, otherwise it will point to the S3 one (effectively this separation will allow in the future to add more backends).
2020-12-16 09:16:55 -08:00
Ahmed Musaad dc2befaa87 Add documentation for user API endpoints (#114)
@ahmedmusaad added documentation for the following API endpoints:

/api/v1/kolide/users GET
/api/v1/kolide/users POST
/api/v1/kolide/users/admin POST
/api/v1/kolide/users/{id} GET
2020-12-14 08:55:15 -08:00
Zach Wasserman 6f6464f206 Migrate remaining URLs to fleetdm.com (#116) 2020-12-10 11:26:00 -08:00
linsihao7788 3ce7351049 Fix JSON in rest-endpoints.md (#110) 2020-12-08 19:22:01 -08:00
Zach Wasserman 30a0dfc1e1 Fix and clarify API auth documentation (#109)
- Fix header name.
- Add note about SSO auth.
2020-12-08 17:44:26 -08:00
Zach Wasserman 9279e59628 Default to --host_identifier=instance in docs (#103)
This may be a better default for folks to use as it will prevent the
issues caused by duplicate UUIDs in #102.
2020-12-07 15:43:08 -08:00
noahtalerman 392a032141 Add question and answer stub for monitoring query performance to FAQ. (#84)
Question and tentative answer for "How do I monitor the performance of my queries?" added to infrastructure FAQ.
2020-12-03 14:46:56 -05:00
Zach Wasserman 9606196feb Minor improvements in the FAQ (#93) 2020-12-03 08:41:38 -08:00
Zach Wasserman 698b8ab882 Add FAQ question about resetting auth tokens (#92)
Related to #89
2020-12-03 08:41:23 -08:00
Zach Wasserman 47b4f07afb Add documentation on Fleet performance (#86)
- Document scaling.
- Document debugging steps/tools.
- Update issue template to request debug archive.
2020-12-02 09:46:02 -08:00
Zach Wasserman 7d299ca6f7 Add fleetctl.exe.zip to release process (#80)
Closes #56
2020-12-02 08:24:34 -08:00
noahtalerman 268b752366 Change name to Fleet in documentation. (#77)
In the documentation, all references to the Fleet product now use "Fleet" instead of "Kolide Fleet"
2020-12-01 13:34:08 -05:00
noahtalerman ff2ebf513b Add answer to label refresh question to infrastructure docs. (#62)
This question and answer originated from issue #57.

Closes #57
2020-11-23 11:07:51 -08:00
noahtalerman 32f466d6c0 Add documentation for authentication API endpoints (#44)
Endpoints that have been added:
- /api/v1/kolide/login POST
- /api/v1/kolide/logout POST
- /api/v1/kolide/forgot_password POST
- /api/v1/kolide/me GET
- /api/v1/kolide/change_password POST
- /api/v1/kolide/perform_required_password_reset POST
- /api/v1/kolide/sso POST
- /api/v1/kolide/sso GET
2020-11-20 16:57:13 -08:00
noahtalerman d3d4f81530 Add instructions for running osquery agents to development docs. (#58)
Used same verbiage from osquery-in-a-box README (https://github.com/fleetdm/osquery-in-a-box#run-osquery).
2020-11-19 16:36:27 -08:00
Mike McNeil df3b7f2852 Has anyone stress tested Fleet? (#49)
Update FAQ with answer to this question.
2020-11-19 15:53:12 -08:00
Zach Wasserman d89523c830 Add fleetctl installer for NPM (#52)
This PR adds all the necessary configuration to install fleetctl via NPM.

Binaries are downloaded from the GitHub release page.
2020-11-18 13:20:08 -08:00
noahtalerman ecf6fd1c91 Add instructions to connect to Mailhog server in development docs. (#46)
Added walkthrough for users attempting to connect to MailHog server.

Connecting to the simulated mail server allows contributors to interact with features in Fleet UI that require email configuration.
2020-11-17 15:20:46 -08:00
noahtalerman 74700fc2fb Linked development-infra docs from building-the-code docs. (#41)
Added link to development-infrastructure docs at the end of building-the-code docs to walk contributors to the next step of serving Fleet locally.

Added --auth_jwt_key="insecure" flag to fleet serve command in development-infrastructure docs.
2020-11-16 11:50:58 -08:00
Zach Wasserman 6cbd10965c Add dev infrastructure and docs for Prometheus monitoring (#33)
- Set up a simple example of Prometheus monitoring in the development
  docker-compose.yml.
- Add documentation for configuring Prometheus.
2020-11-12 19:06:56 -08:00
Zach Wasserman 138329c371 Fix markdown documentation links (#35)
- Update/remove broken links
- Add appropriate ignore rules for example URLs and osquery site
2020-11-12 19:06:06 -08:00
Zach Wasserman 89c775dd95 Include fleetctl binary archives in release (#31)
This adds tooling to include fleetctl binaries (in separate .tar.gz
archives for each platform) in the release.
2020-11-12 18:03:01 -08:00
noahtalerman 6536ba6ab7 Removed $ character from all shell commands in docs. (#32)
$ character is now removed from all shell commands in markdown documentation.

When docs are eventually compiling to we can add $ automatically to code blocks.
2020-11-12 13:50:08 -08:00
noahtalerman 227f854d8f Beginning of REST API documentation. Added info for /hosts endpoint. (#29)
The beginning of REST API documentation for Fleet.
Added information and example for the /hosts endpoint.
2020-11-12 12:20:39 -08:00
noahtalerman 0085ba4246 Answer to database connection error added to infrastructure faq. (#30)
My best attempt at steps to solve the common database connection error users receive when installing or updating Fleet.

Inserted 'Why am I receiving a database connection error when attempting to "prepare" the database?'.

Also simplified the answer to "Is Fleet available as a SaaS product?".
2020-11-12 10:09:02 -08:00
Zachary Wasserman f08557d33b Update Slack channel names (#22) 2020-11-04 21:52:20 -08:00
noahtalerman ecacbf212b Changes to additional links for transition to fleetdm (#21) 2020-11-04 21:48:39 -08:00
noahtalerman 0ff621670c Changed the Help link and other links to fleetdm/fleet documentation 2020-11-04 21:36:06 -08:00
Zachary Wasserman e452cc6a8a Add file carving support (#15)
- Add endpoints for osquery to register and continue a carve.
- Implement client functionality for retrieving carve details and contents in fleetctl.
- Add documentation on using file carving with Fleet.

Addresses kolide/fleet#1714
2020-11-04 20:45:16 -08:00
Mike McNeil 660289e89d Add GOPATH tips to contributor docs (#13) 2020-11-04 20:29:27 -08:00
noahtalermanandMike McNeil be28d8e3c6 Update build documentation (#3)
Co-authored-by: Mike McNeil <7157539-mikerlmcneil@users.noreply.gitlab.com>
2020-11-03 15:18:45 -08:00
Brendan Shaklovitz c6b285c56e Remove soft-deletion pattern (#2327)
* Perform migration to delete any entries with `deleted` set, and
subsequently drop columns `deleted` and `deleted_at`.
* Remove `deleted` and `deleted_at` references.

Closes #2146
2020-10-22 10:51:26 -07:00
Brendan Shaklovitz 8246b4d1f8 fleetctl: allow disabling packs via apply (#2325)
Closes issue #2240
2020-10-21 16:29:27 -07:00
daniel-infosec 6a8a02fdd2 Update faq with bad record MAC fix suggestion (#2331) 2020-10-14 08:41:35 -07:00
Stefhen Hovland 7ce0472c2c Add -L option to curl (#2305)
The example in the README won't follow the github redirect without `-L`, so the example as is will download an html file instead of the actual `fleet.zip`. This fixes that.
2020-09-24 10:42:19 -07:00
Zachary Wasserman d959a4e4af Fix Slack invitation URL (#2303)
Closes #2299
2020-09-17 13:18:04 -07:00
Lars LehtonenandZachary Wasserman d193ea1717 Remove Support for Deprecated TLSProfileOld (#2142)
Co-authored-by: Zachary Wasserman <zach@dactiv.llc>
2020-09-10 09:31:01 -07:00
James Alseth 3a63dac4a3 Add compression option for filesystem logs when they're rotated (#2292) 2020-09-09 13:33:32 -07:00
James Alseth e88ea5dca5 Fix typo in logging_disable_banner docs (#2289) 2020-09-09 13:32:13 -07:00
billcobblerandBrendan Shaklovitz 20328b0f87 Add stdout and kinesis logger plugins and sts assume role to Firehose (#2282)
Co-authored-by: Brendan Shaklovitz <nyanshak@users.noreply.github.com>
2020-08-19 14:56:44 -07:00
Zachary Wasserman 09632fb1ed Add note about downtime during database migrations (#2279)
This should help clarify that migrations should be run with server
instances stopped.
2020-08-06 17:16:23 -07:00
Stephan Miehe 2ad5205a4b Add support for conn_max_lifetime (#2270)
This adds support to configure MySQL conn_max_lifetime.
2020-07-30 09:00:42 -07:00
Stephan Miehe cf4d8ecfee Add redis database number support (#2269)
Fixes #2268
2020-07-30 08:57:25 -07:00
Zachary Wasserman 42bea2a144 Implement manual labels
"Manual" labels can be specified by hostname, allowing users to specify
the membership of a label without having to use a dynamic query. See the
included documentation.
2020-07-21 14:05:46 -07:00
William Theaker b5b43e7aa7 Brief Auto Table Construction docs (#2249) 2020-06-30 09:18:50 -07:00
Zachary Wasserman c1aa8355cb Add support for multiple enroll secrets (#2238)
- Support multiple enroll secrets
- Record name of enroll secret used when host enrolls
- Update fleetctl and UI to support these features
2020-05-29 09:12:39 -07:00
Zachary Wasserman 619e36755c Add capability to collect "additional" information from hosts (#2236)
Additional information is collected when host details are updated using
the queries specified in the Fleet configuration. This additional
information is then available in the host API responses.
2020-05-21 08:36:00 -07:00