Commit Graph

635 Commits

Author SHA1 Message Date
Martin Angers
07cf136d03
Add TLS support to Redis connections (#2568) 2021-10-20 10:09:18 -04:00
Martin Angers
057d4e8b2e
Add configuration and support for Redis to read from replicas (#2509) 2021-10-18 09:32:17 -04:00
Noah Talerman
e821bcb054
Edits to Fleet public load testing documentation (#2535)
- Add a summary to the top of the document
- Rename "Baseline Test" section to "Test parameters"
- Rename "Bare minimum setup" section to "1,000 hosts"
- Several smaller edits that call out the number of hosts tested and the results (did Fleet work?)
2021-10-15 13:52:25 -04:00
Tomas Touceda
89c6d18ed2
Issue 2293 reveal failing policies list host (#2528)
* Add host issues

* Update docs

* Remove comment

* Update tests
2021-10-15 07:34:30 -03:00
Tomas Touceda
d3a0d62902
Issue 2456 policies yaml (#2512)
* wip

* Add policy specs support

* Add documentation

* Make policy apply idempotent

* Fold in code

* Improve tests and simplify auth checks

* Lint and fix test
2021-10-15 07:34:11 -03:00
Tomas Touceda
bb1dc401a3
Load vulnerabilities alongisde the software (#2518)
* Load vulnerabilities alongisde the software

* Update docs
2021-10-14 13:51:41 -03:00
Tomas Touceda
d904d501ac
Add infra for loadtest (#2218)
* Add infra for loadtest

* Move loadtest stuff to a new file and parametrize fleet min/max capacity

* wip

* wip

* wip

* wip

* wip

* wip

* wip

* Update to be ready for review

* Update link and other variables needed

* Address review comments and update links
2021-10-14 12:04:27 -03:00
Tomas Touceda
0510075398
Issue 2134 add team admin role (#2499)
* wip

* Add team admin role and tests

* Revert change in invites

* Update permission doc

* Fix lint
2021-10-13 12:34:59 -03:00
eashaw
f97072f2a4
Update using fleet FAQ (#2483)
* add question to faq

* Update docs/01-Using-Fleet/FAQ.md

Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
2021-10-12 17:11:03 -05:00
Benjamin Edwards
16c5823692
add support for minio backend file carving (#2448)
* add support for minio backend file carving
* add changes file
Co-authored-by: Zach Wasserman <zach@fleetdm.com>
2021-10-12 15:32:06 -04:00
Tomas Touceda
782f276e0b
Issue 2050 add software filter list hosts (#2486)
* Add software_id filter to list hosts

* Add integration test for API endpoint

* Add doc

* Simplify sql query
2021-10-12 11:38:12 -03:00
RachelElysia
981028705e
Sentence Case: Throughout UI, tests, validators, docs (#2455) 2021-10-11 10:58:27 -04:00
Mike Thomas
f4c6c8e534
Update 00-Learn-how-to-use-Fleet.md (#2393)
Update to enroll device command to remove line-break.
2021-10-07 23:43:02 +09:00
eashaw
14ac341b30
Normalize docs and handbook headings (#2428)
* header styles

* update headers

* updated headings

* update padding

* handbook headings, update landing page breadcrumbs

* update heading and font-size

* Update 03-Example-deployment-scenarios.md

* handbook styles

* Update basic-handbook.page.js

* lint fixes
2021-10-07 23:40:22 +09:00
Martin Angers
3aef96e15c
Add test for fleetctl preview (#2388)
* Start a fleetctl preview test

* Add tests for fleetctl preview

* Fix setting of fleetctl auth token in test

* Add fleet instance vulnerabilities config to response of GetAppConfig

* Add checks that fleetctl preview enables vulnerability detection

* Adjust doc for get config API response

* Add the include-server-config flag to fleetctl get config

* Update test now that some of the PRs have been merged

Co-authored-by: Tomas Touceda <chiiph@gmail.com>
2021-10-07 10:19:10 -03:00
Tomas Touceda
876aa0e366
Add host count API (#2356)
* Add host count API

* Add rest api docs

* Add host count for labels and address review comments

* Add regex for id
2021-10-07 08:25:35 -03:00
Tomas Touceda
9b809a2d35
Issue 1890 host details policy (#2410)
* wip

* Add policies to hosts
2021-10-07 08:11:10 -03:00
Mike McNeil
2972b2fde0
Update 03-Example-deployment-scenarios.md (#2398)
* Update 03-Example-deployment-scenarios.md

* Update 03-Example-deployment-scenarios.md
2021-10-06 19:32:51 -05:00
Noah Talerman
a067fc1145
Update GET /software documentation to reflect the current response (#2348)
- Remove the `hosts_count` property from the `GET /api/v1/fleet/software` API route because this property is not currently included in the response.
2021-10-06 10:05:14 -04:00
eashaw
87b3563db7
Add questions to Contributing and Using Fleet FAQ (#2366)
* Update FAQ.md

* Update FAQ.md

* Update docs/01-Using-Fleet/FAQ.md

Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>

* Update docs/01-Using-Fleet/FAQ.md

I couldn't make a decision about the correct science around the mum and baby reference, so I just deleted to be safe 😅

Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
2021-10-06 11:51:00 +09:00
Benjamin Edwards
b2cae6321d
update deployment docs to include AWS deployment scenario (#2370) 2021-10-05 12:53:45 -04:00
eashaw
afc8bdd093
Update instructions in Enroll your own device (#2364) 2021-10-05 21:28:52 +09:00
Zach Wasserman
f8971f6f59
Fix links to tools in contributor documentation (#2363)
Fixes #2354
2021-10-04 16:36:20 -07:00
eashaw
ac45bc0706
Docs image updates (#2297)
* addred cropped images to replace images in configuration.md, fixed duplicated alt text, added box-shadow to images

* more cropping

* reduce padding on ordered lists, point urls in markdown to where images will be

* Update 02-Configuration.md

* Update build-static-content.js

* remove box-shadow on images

* Update 02-Configuration.md

* Added handbook entry about images

* changed img tags to markdown links to be consistent

* undo small style change

* Update build-static-content.js

* Update handbook/product.md

Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>

Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
2021-10-05 08:25:34 +09:00
eashaw
5de5b13223
Dynamic titles for documentation, query, and handbook pages (#2298)
* handling redirect

* clean up redirect/notFound flow

* dynamic query titles and description

* dynamic docs titles

* Remove locals from queries and docs, updated comment and variable names

* handling FAQ page titles

* update comment, title in meta, and adjust get started title

* remove unneeded meta tag

* handbook titles

* cleaning up conditionals

* update comments

* removed added meta tags, change meta variable names

* passing in meta description if provided, update conditionals and comments

* Update FAQ.md
2021-09-30 21:14:02 -05:00
RachelElysia
f397b77c1a
Schedule Page: Team maintainer can modify their team's schedule (#2243)
* Change permissions to schedule UI to include team maintainers
* Update e2e tests
2021-09-30 10:30:44 -04:00
Mike McNeil
d3a2083188
add example query that checks a malware artifact (#2296) 2021-09-29 22:08:39 -05:00
Tomas Touceda
36b4c0df5d
Allow team maintainers to read global policies and schedule (#2282)
* Allow team maintainers to read global policies and schedules

* Update docs
2021-09-29 14:07:10 -03:00
Renee Jackson
37c6ca1043
add e2e test descriptions (#2263)
* add e2e test descriptions

* Update docs/03-Contributing/02-Testing.md

Co-authored-by: noahtalerman <47070608+noahtalerman@users.noreply.github.com>

Co-authored-by: noahtalerman <47070608+noahtalerman@users.noreply.github.com>
2021-09-29 13:53:27 -03:00
Tomas Touceda
d9f34b2c19
Issue 1840 bulk delete hosts (#2268)
* wp

* Add test by ids

* Add changes file

* Update docs and remove unneeded return values

* Address review comments

* Improve integration tests

* Use TearDownTest
2021-09-29 13:13:23 -03:00
Tomas Touceda
435178e93c
Add bundle identifier to software when available (#2220)
* Add bundle identifier to software when available

* Update docs

* Delete unneeded test
2021-09-28 18:13:34 -03:00
Tomas Touceda
e2caf46d6d
Issue 2133 team maintainer can edit delete queries (#2256)
* wip

* Team maintainers can edit and delete queries they authored

* Update documentation

* Fix test
2021-09-28 14:53:05 -03:00
Tomas Touceda
968854c721
Correct documentation typo for interval (#2248) 2021-09-27 16:28:02 -03:00
Tomas Touceda
2033d8208c
Add policy updated at (#2246)
* wip

* Add policy updated at interval and update the UI to use that

* Update rest api

* Fix tests
2021-09-27 16:27:38 -03:00
Benjamin Edwards
2c6fbe4ea2
update deployment faq (#2216)
* update deployment faq

* Update docs/02-Deploying/FAQ.md

Co-authored-by: Zach Wasserman <zach@fleetdm.com>

Co-authored-by: Zach Wasserman <zach@fleetdm.com>
2021-09-27 13:12:08 -04:00
Tomas Touceda
5653f1e868
Update URLs from team to teams, add tests for policy auth (#2228)
* Update URLs from team to teams, add tests for policy auth

* Fix test

* Address review comments
2021-09-27 14:02:11 -03:00
noahtalerman
97750d1e07
Improve examples and API documentation for managing teams with fleetctl (#2199)
- Add example `team.yml` configuration file. A file with this format can be used to apply teams using `fleetctl apply`
- Add `spec/teams` API route to API docs
2021-09-27 10:08:40 -04:00
Mike Thomas
429875d4e5
Update 00-Learn-how-to-use-Fleet.md (#2217)
Updated to reflect latest UI and query library content changes in Fleet 4.3.0.
2021-09-27 20:25:23 +09:00
Benjamin Edwards
655b57789d
add faq about host team enrollment 2021-09-23 23:38:21 -04:00
Benjamin Edwards
3987cdf82d
update deploy docs to mention the need for the mysql user to have the ability to create temporary tables for migrations (#2209) 2021-09-23 22:57:38 -04:00
Zach Wasserman
a859d46af9
Fixes to fleetctl debug archive docs (#2203) 2021-09-23 08:50:34 -07:00
Martin Angers
3ea0439cf0
Document the recommended max lifetime config for read replicas (#2189) 2021-09-22 14:44:45 -04:00
Renee Jackson
ca27bd9d5c
fix broken links by adding missing 0 (#2187)
* fix broken links by adding missing 0

* fix broken links take 2

gather links missed in first pass
2021-09-22 13:28:25 -03:00
Tomas Touceda
1f324339f8
Add jitter to intervals (#2158)
* Add max jitter percent config

* Fix jitter calc

* Remove comment

* Reduce test jitter to make tests less flaky

* Remove jitter entirely

* Document new config

* Fix doc link
2021-09-21 14:21:44 -03:00
eashaw
470889ba3a
Update code blocks in documentation (#2151)
* updated css to be compatible with Chrome 87 and earlier

* fixed JSON syntax code blocks, remove empty response data

* Update code-blocks.less

* fix broken links
2021-09-20 20:59:45 -05:00
noahtalerman
bcb5288f71
Add Policies feature to permissions documentation (#2153) 2021-09-20 18:40:11 -04:00
Martavis Parker
4f3f6187d6
Top-level seed data doc and re-numbering (#2109)
* created separate doc for seeding data

* re-numbered doc names
2021-09-20 11:48:24 -07:00
Martin Angers
86dce785ae
Improve performance of the Go test suite (#2060)
Closes #1805
2021-09-20 14:09:38 -04:00
Tomas Touceda
baa42d367e
Add team policies (#2103)
* Add team policies

* Add team policy documentation

* Add changes file

* Update titles

* Fix lint

* Rewrite TeamAuthorize for more clarify

* Explicitly use two slices for clarity

* Simplify switch
2021-09-20 11:00:57 -03:00
AndrewB
2c4ee75bc2
Update 4-Committing-Changes.md (#2047) 2021-09-17 11:19:30 -05:00
Zach Wasserman
a905cb3be5
Update SSO configuration docs (#2092)
- Include full example for Google IDP configuration
2021-09-16 12:47:04 -07:00
eashaw
57b063125e
json highlighting (#2084) 2021-09-16 16:45:14 +09:00
Mike Thomas
98499a0349
Docs image replacement (#2073)
https://github.com/fleetdm/fleet/pull/2071 (removing hardcoded widths on images) undoes what we previously did for making smaller images look good at <990px breakpoints.

Only current examples of these smaller images are on this page in the docs, although there are a couple of instances in the handbook. So I propose that we only crop images that will work at full container width sizes.

With that in mind I have replaced one of the affected images on this page.
2021-09-16 15:42:22 +09:00
Mike McNeil
e968a26b2d
Make support challenges on Chrome OS explicit in docs (#2037)
re https://github.com/fleetdm/fleet/issues/969
2021-09-15 12:00:19 -05:00
Benjamin Edwards
0bc485b32f
fix some broken document separators in standard-query-library file (#2072)
* fix some broken document separators in standard-query-library file

* remove in progress dockerfile
2021-09-15 10:21:26 -05:00
Martin Angers
1fa5ce16b8
Add configurable Redis connection retries and following of cluster redirections (#2045)
Closes #1969
2021-09-15 08:50:32 -04:00
eashaw
404ae820c9
Documentation image updates (#2071)
* remove hardcoded width on images

* fix inconsistent image padding on fleet ui docs page

* Broken link fix

Fixed a couple of broken links to help this PR pass the automated tests.

Co-authored-by: Mike Thomas <mthomas@fleetdm.com>
2021-09-15 11:19:21 +09:00
Mike McNeil
029f67d36b
remove concept of "Detection", for now (in favor of what's coming) (#2046)
* remove concept of "Detection", for now (in favor of what's coming)

* remove extra --- to make YAML parse properly

* Simplify the check to remove remediation check for now

* Run compile script any time docs or handbook is changed
2021-09-14 11:43:45 -05:00
Tomas Touceda
176037cad2
Implement fleetctl get software and the underlying API (#1999)
* Implement fleetctl get software and the underlying API

* Add documentation

* Simplify list software implementation

* Lint fixes

* Make team name unique

* Address review comments

* Fix lint

* Fix tests
2021-09-14 10:58:48 -03:00
Tomas Touceda
429af72b69
Issue 1963 vulnerabilities no sync (#1976)
* wip

* Add tests for skip sync

* Add changes file

* Fix lint
2021-09-14 10:58:35 -03:00
AndrewB
ac5decde20
Update standard-query-library.yml (#2036)
* Update standard-query-library.yml

Added new queries to library

* sentence-case capitalization + standardize first word in name

* andrewbare => alphabrevity (so your picture shows up correctly on the website)

Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
2021-09-13 18:27:41 -05:00
noahtalerman
c5bc6b8128
Add note to POST /api/v1/fleet/queries/run about required parameter for running live query as an observer (#2028) 2021-09-13 10:58:36 -07:00
RachelElysia
d32479622c
App Settings Page: Host status webhook UI (#1899)
* Skeleton UI

* Rebase to main

* Work towards config API request modification

* Nest and unnest when formatting for server and frontend

* Changelog

* Add validation to UI, fix ? vertical spacing

* Rebase e2e

* 1 of 2 passing unit tests for config

* Update REST-API.md to include webhook_settings

* Destructure / flatten config webhook in unit test

* Merge advance options e2e conflict

* x and y example not x and x

* Fix observer e2e

* Add new data to read only example request

Co-authored-by: Noah Talerman <noahtal@umich.edu>
Co-authored-by: Martavis Parker <martavis@auraticdevelopment.com>
2021-09-10 10:49:11 -07:00
Tomas Touceda
13e5e6a6db
Debug log per host (#1978)
* Add extra debug logging for hosts

* Add changes file

* Ignore if appconfig is nil

* Use slice of uints instead of a string

* Debug response request for enabled hosts

* Add host-id to request/response

* Lint fixes

* Add missing AppConfigFuncs
2021-09-10 14:48:33 -03:00
Mike Thomas
d81698bbf5
syntax highlight text (#1989) 2021-09-09 19:04:58 -05:00
Benjamin Edwards
823775844e
added package command from orbit as fleetctl command (#1802)
* added package command from orbit as fleetctl command

* update deployment docs

* add changes file

* added tests for package command, run go mod tidy & go mod verify

* validate that package files exist

* comment out msi packaging test until we can investigate github runner permission issues
2021-09-09 01:34:12 -04:00
Tomas Touceda
b2efc9f51c
Make redis conn timeout and keep alive configurable (#1968)
* Make redis conn timeout and keep alive configurable

* Document new configs

* Correct config name
2021-09-08 17:55:12 -03:00
eashaw
13cae833c0
Change code block headings in documentation (#1943)
* updated headings to remove codeblocks

* Update 3-REST-API.md

* Update 2-Configuration.md

* h5 styles

* h6 styles, removed h5 font-size
2021-09-08 03:55:55 +09:00
Tomas Touceda
99e9e846f4
Remove id column from host_users to allow for bulk insert (#1931)
* Remove id column from host_users to allow for bulk insert

* Update documentation
2021-09-07 11:02:35 -03:00
Tomas Touceda
6d2ae02efd
Rename core->free and basic->premium (#1870)
* Rename core->free and basic->premium

* Fix lint js

* Comment out portion of test that seems to timeout

* Rename tier  to premium if basic is still loaded
2021-09-03 13:05:23 -03:00
eashaw
0cb2f21233
updated two links that linked to github (#1913) 2021-09-03 13:02:26 +09:00
Martin Angers
3755a58070
Add support for MySQL read replicas (#1786)
Adds configuration options to use a read-only MySQL replica,
and uses it instead of the primary for reads.
2021-09-01 15:50:52 -04:00
eashaw
1cca9a2a92
Remove IE11 from supported browsers on fleet website (#1865)
* adjusted isUnsupportedBrowser to include all versions of internet explorer and changed unsupported browser message for ie11

* removed ie11 from supported browsers docs page
2021-08-31 18:33:06 -05:00
noahtalerman
e1ba813f0c
Add Schedule feature to permissions documentation (#1864) 2021-08-31 09:04:55 -04:00
noahtalerman
247267daa5
Add canonical URL for link to prometheus example configuration (#1854) 2021-08-30 17:00:34 -04:00
Tomas Touceda
15b7f5dd80
Create vuln path if dynamic (#1830)
* Create vuln path if possible

* Make sure we skip creation if static instance is selected

* Document behavior

* Fix return in crons and test without sleeps
2021-08-30 12:29:05 -03:00
noahtalerman
731fb599a1
Update sources (links) to check when on call in Support process document (#1833)
- Add item and link to all "Reported bugs" (GitHub issues with the "bug" and ":reproduce" label). This way, the individual on call can navigate to a list of bugs that need reproduction. 
- Add a link to the open pull requests. This way, the individual on call can identify any PRs that have been opened by the community.
2021-08-27 14:45:41 -04:00
Tomas Touceda
8b908f6506
Issue 1599 offline webhook (#1777)
* wip

* Add tests and finish implementation

* Add proper default for periodicity, changes file, and documentation

* Fix tests and add defaults also to new installs

* EnableHostUsers should be true if undefined as well

* In some cases, periodicity can be zero because of the migrations

* Apply defaults when migrating appconfig

* Fix lint

* lint

* Address review comments
2021-08-27 11:15:36 -03:00
gillespi314
edd4366abf
Update 3-REST-API.md
Update `/config` API documentation for `osquery_detail` response in nanoseconds instead of string
2021-08-26 22:15:38 -05:00
Zach Wasserman
4eec4ebbbe
Fix typo in Prometheus docs (#1814) 2021-08-25 20:08:22 -07:00
Zach Wasserman
53e4f1077e
Add make changelog command and update documentation (#1795) 2021-08-25 15:14:24 -07:00
noahtalerman
a02bede9c7
Update "Policies" section in API docs (#1801)
- Add anchor link to "Policies" section. Move this section below "Packs"
- Add note on Fleet version in which the Policies feature will be released
2021-08-25 17:05:48 -04:00
RachelElysia
f10636f8d1
Host Details Page: Render disk space (#1770) 2021-08-25 13:05:54 -07:00
Tomas Touceda
a8642493ad
Add global policies (#1750)
* Add global policies

* Update documentation and add extra parameter to config

* Fix failing tests

* Store historic policy records

* Address review comments

And also remove other inmem references I saw by chance

* Add documentation for get by id request

* Add parameter doc

* Move schema generation to a cmd instead of a test

Otherwise it messes up running all tests sometimes depending on how parallel it does

* Remove brain dump for another task

* Make migration tests a separate beast

* Make schema generation idempotent and move dbutils cmd to tools

* Allow all filters and add counts to Policy

* Add test for Policy
2021-08-24 17:24:52 -03:00
Martin Angers
80fb3cb145
Run golangci-lint with the make lint-go target, adjust workflows (#1778) 2021-08-24 15:36:50 -04:00
William Theaker
c81a18922d
Vuln processing documentation tweak (#1768) 2021-08-23 16:37:00 -07:00
Martin Angers
605983f422
Mention the forward-only migrations in the docs (#1767) 2021-08-23 14:26:34 -04:00
Zach Wasserman
2d22020973
Update live query API documentation (#1745)
Attempt to add clarity to the process of using the API to run live queries.
2021-08-19 16:39:17 -07:00
Zach Wasserman
23fabff12a
Update host API doc (#1744)
Include software inventory and users in example response.
2021-08-19 16:22:17 -07:00
noahtalerman
4836864db6
Fix anchor links for "Get enroll secrets" and "Modify enroll secrets" sections in API docs (#1738) 2021-08-19 17:03:35 -04:00
Mike Thomas
7b3b24547d
Updated product name on website and docs (#1731)
Updated product name on website and docs
2021-08-19 12:50:21 -05:00
Mike Thomas
9bef2a1a1b
update-ask-questions-about-your-devices.md (#1734)
Changes name to "0-Learn-how-to-use-Fleet.md," moved into "1-Using-Fleet" folder, and deleted "Tutorials" folder.
2021-08-19 23:39:22 +09:00
Mike Thomas
457ba20aa0
Update Ask-questions-about-your-devices.md (#1733)
* Update Ask-questions-about-your-devices.md

Further edited the doc for tone and grammar.
Added section about enrolling your own device.

* Update docs/1-Using-Fleet/tutorials/Ask-questions-about-your-devices.md

* Update docs/1-Using-Fleet/tutorials/Ask-questions-about-your-devices.md

* Update docs/1-Using-Fleet/tutorials/Ask-questions-about-your-devices.md

Co-authored-by: noahtalerman <47070608+noahtalerman@users.noreply.github.com>

* Update docs/1-Using-Fleet/tutorials/Ask-questions-about-your-devices.md

Co-authored-by: noahtalerman <47070608+noahtalerman@users.noreply.github.com>

* Update docs/1-Using-Fleet/tutorials/Ask-questions-about-your-devices.md

Co-authored-by: noahtalerman <47070608+noahtalerman@users.noreply.github.com>

* Update docs/1-Using-Fleet/tutorials/Ask-questions-about-your-devices.md

Co-authored-by: noahtalerman <47070608+noahtalerman@users.noreply.github.com>

Co-authored-by: noahtalerman <47070608+noahtalerman@users.noreply.github.com>
2021-08-19 22:27:53 +09:00
Zach Wasserman
403f9d2c74
Clarify Safari in supported browsers doc (#1725) 2021-08-18 17:29:25 -07:00
noahtalerman
3725781597
Move vulnerabilities configuration options into 2-Deploying/2-Configuration.md (#1722)
- Move vulnerabilities config options into `2-Deploying/2-Configuration.md` and link to these options from the Vulnerability processing docs
2021-08-18 17:16:59 -04:00
Tomas Touceda
70f728fe84
Make vulnerability processing more configurable (#1718)
* Make vulnerability processing more configurable

* Simplify leader selection
2021-08-18 17:25:14 -03:00
Mike McNeil
8097251565
Put live documentation on fleetdm.com (#1380)
* minor clarifications

* further expand comments and stubs

* absorb custom titles embedded in metadata, plus further comment expansion and a followup fix for something i left hanging in f8cbc14829d91e7577c63307fd9c4346dbc229bb

* Skip non-markdown files and use real path maths

* Prep for running in parallel (Remove `continue` so this isn't dependent on the `for` loop)

* determine + track unique HTML output paths

* Compile markdown + spit out real HTML  (without involving any but the crunchy nougaty dependency from the very center of everything)

* add md metadata parsing

* add timestamp

* Update build-static-content.js

* attach misc metadata as "other"

* how doc images might should work (this also aligns with how the select few images in the sailsjs.com docs work)

* add file extension to generated HTML files

* "options"=>"meta"

* Make "htmlId" useful for alphabetically sorting pages within their bottom-level section

See recent comments on https://github.com/fleetdm/fleet/issues/706 for more information.

* list out the most important, specific build-time transformations

* Omit ordering prefixes like "1-" from expected content page URLs

* add a little zone for consolidating backwards compatible permalinks

* interpret README.md files by mapping their URLs to match their containing folder

* clarify plan for images

* decrease probability of collisions

* Make capitalization smarter using known acronyms, proper nouns, and a smarter numeric word trim

* Resolve app path in case pwd is different in prod

* Delete HTML output from previous runs, if any

* condense the stuff about github emojis

* got rid of "permalink" thing, since id gets automatically attached during markdown compilation anyway

Also "permalink" isn't even a good name for what this is.  See https://github.com/fleetdm/fleet/issues/706#issuecomment-884693931

* …and that eliminates the need for the cheerio dep!

* Bring in bubbles+syntax highlighting into build script, and remove sails.helpers.compileMarkdownContent()  -- this leaves link munging as a todo though

* trivial (condense comments)

* Remove unused code from toHtml() helper

* Implemented target="_blank" and root-relative-ification

* remove todo about emojis after testing and verifying it works just fine

* trivial: add link to comment in case github emojis matter at some point

* consolidate "what ifs" in comments

* Leave this up to Sarah, for now. (Either bring it back here in the build script or do it all on the frontend)

* Enable /docs and /handbook routes, and add example of a redirect for a legacy/deprecated URL

* implement routing

* Upgrade deps

this takes advantages of the latest work from @eashaw, @rachaelshaw, and the rest of the Sails community

* tweak var names and comments

* make readme pages use their folder names to determine their default (fallback) titles

as discussed in https://github.com/fleetdm/fleet/issues/706#issuecomment-884788002

* first (good enough for now) pass at link rewriting

as discussed in https://github.com/fleetdm/fleet/issues/706#issuecomment-884742072

* Adapt docs pages to build from markdown output

* Continue work on docs pages

* Add landing page

* Remove unused code; minor changes

* Replace regex

* fixes https://github.com/fleetdm/fleet/pull/1380#issuecomment-891429581

* Don't rely on "path" being a global var

* Syle fleetdm doc pages

* Continue work on docs pages

* Fix linting error

* Disable lesshint style warnings

* parasails-has-no-page-script attribute

Added a parasails-has-no-page-script attribute to the docs template, added a check for that attribute in parasails.js and removed the empty page script for 498

* bring in latest parasails dep

* trivial

* Update links to dedupe and not open in new tab unless actually external

* Disable handbook for now til styles are ready

* fix CTA links

* trivial

* make sitemap.xml get served in prod

* hide search boxes for now, remove hard-coded version and make releases open in new tab

* clean out unused files

Co-authored-by: gillespi314 <73313222+gillespi314@users.noreply.github.com>
Co-authored-by: eashaw <caglc@live.com>
2021-08-17 19:55:13 -05:00
Martin Angers
ed428d707b
Clarify a few points in the Contributing docs (#1692)
Document that `fleet serve --dev` requires `make generate-dev` and
that for changelog we now use changes files.
2021-08-16 14:59:03 -04:00
RachelElysia
7d23ff2b53
Align API docs and frontend interfaces with API GET responses (#1602) 2021-08-16 10:30:19 -04:00
Zach Wasserman
9a5842d9c3
Document minimal online keys for Orbit updates (#1678) 2021-08-15 16:47:24 -07:00
Benjamin Edwards
2d5c7ed683
issue 1313 -- add file destination for convert command (#1672)
* add file destination flag for convert command, add tests
* add changes file
* remove leftover debugging code, add comment explaing why sorting was necessary
* update docs for fleetctl convert
* Update cmd/fleetctl/convert_test.go
Co-authored-by: Zach Wasserman <zach@fleetdm.com>
2021-08-13 20:42:58 -04:00
noahtalerman
b2c7faf251
Update "Ask questions about your devices" walkthrough and update API docs (#1670)
- Remove "How to add Fleet's standard query library" section from the "Ask questions about your devices" walkthrough.
- Add `license`, `vulnerability_settings`, and `logging` properties to the example response for the `GET /api/v1/fleet/config` and `PATCH /api/v1/fleet/config` API routes
2021-08-13 15:01:53 -04:00
noahtalerman
e2e812d9c2
Add correct query (#1669)
- Replace incorrect query
2021-08-13 15:00:46 -04:00
Mike Thomas
4cb315e2f1
Update 12-Supported-browsers.md (#1653)
Grammar/typo fix.
2021-08-11 20:26:29 -05:00
Mike Thomas
bc24e88b66
Update Ask-questions-about-your-devices.md 2021-08-12 10:20:54 +09:00
noahtalerman
2df7c71749
Prepare for Fleet 4.2.0 (#1645) 2021-08-11 17:14:32 -07:00
Zach Wasserman
544652e833
Clarify label responses and API docs (#1633)
- Include platform and description even when empty in API responses.
- Update docs to indicate immutability.
2021-08-11 14:57:05 -07:00
Mike Thomas
1d6aa19990
Update Ask-questions-about-your-devices.md 2021-08-12 06:34:24 +09:00
Mike Thomas
dca5aac6e1
Update Ask-questions-about-your-devices.md (#1642)
* Update Ask-questions-about-your-devices.md

Added screenshots.

* Update Ask-questions-about-your-devices.md

changed to img tags for better control of sizing.

* Update docs/1-Using-Fleet/tutorials/Ask-questions-about-your-devices.md

* Update docs/1-Using-Fleet/tutorials/Ask-questions-about-your-devices.md

* Update docs/1-Using-Fleet/tutorials/Ask-questions-about-your-devices.md

* Update docs/1-Using-Fleet/tutorials/Ask-questions-about-your-devices.md
2021-08-12 06:31:34 +09:00
Tomas Touceda
3d8a766ca1
Make receive calls to redis conn thread safe (#1641)
* Make receive calls to redis conn thread safe

Also removes REDIS_TEST env var. Redis is lightweight and fast, no need
to skip these tests.

* No need to increase the wait
2021-08-11 17:34:35 -03:00
Tomas Touceda
ae2bd137b1
Issue 1632 software inventory config (#1636)
* Add config option for software inventory

* Add documentation for the new config
2021-08-11 15:57:53 -03:00
Tomas Touceda
cf6f2152b6
Document vulnerability processing configuration (#1616)
* Document vulnerability processing configuration

* Fix review comments
2021-08-11 13:42:16 -03:00
noahtalerman
63e598e595
API documentation for "filter hosts by team" (#1510) 2021-08-11 11:14:59 -04:00
Tomas Touceda
989e638cc0
Make creating dirs and files more secure by checking permissions (#1566)
* Add safe mkdirall and open

* Use secure as much as possible and merge gomodules for orbit to fleet

* Improve openfile and mkdirall to check for permissiveness instead of equality

* Don't shift

* Fix links

* Address review comments
2021-08-11 11:02:22 -03:00
Mike Thomas
41e8ab271c
Update Ask-questions-about-your-devices.md (#1575)
Checked and fixed a couple of typos here and there, and made some edits to some of the sentence structure to improve the flow, and to soften the tone a bit.
2021-08-11 12:15:49 +09:00
Zach Wasserman
6a1b82f52f
Add yarn install to Windows instructions (#1606) 2021-08-09 18:21:42 -07:00
Tomas Touceda
ccd52985ac
Add Team Schedule documentation (#1576)
* Add Team Schedule documentation

* Update docs/1-Using-Fleet/3-REST-API.md

Co-authored-by: noahtalerman <47070608+noahtalerman@users.noreply.github.com>

Co-authored-by: noahtalerman <47070608+noahtalerman@users.noreply.github.com>
2021-08-06 11:19:20 -03:00
noahtalerman
d5974aad97
Add valid time units to Configuration documentation (#1548)
- Specify valid time units of `s`, `m`, and `h` for the `session_duration`, `osquery_label_update_interval`, and `osquery_detail_update_interval` configuration options.
2021-08-04 12:31:24 -04:00
noahtalerman
dea00479d7
Add "Asking questions about your devices" tutorial to "Using Fleet" documentation (#1530)
This tutorial is the first step at bridging the gaps between trying Fleet, getting to know Fleet in an enterprise setting, and deploying Fleet.

- Add "tutorials" subdirectory 
- Add walkthrough
- Remove duplicate documentation from "Fleet UI" section
- Link to walkthrough from top-level README
2021-08-03 11:22:42 -04:00
noahtalerman
741cfb6a58
Add /activities API route to API documentation (#1529) 2021-08-02 13:49:51 -04:00
Tomas Touceda
da46ecc002
Update FAQs based on lessons learned (#1495)
* Update FAQs based on lessons learned

* Update docs/2-Deploying/FAQ.md

Co-authored-by: Zach Wasserman <zach@fleetdm.com>

Co-authored-by: Zach Wasserman <zach@fleetdm.com>
2021-07-28 19:30:03 -03:00
noahtalerman
da7925e1d7
Remove changes files. Update release process. Update support process (#1492)
- Remove changes files that were collected during the 4.1.0 release cycle
- Add removing changes files step to release process documentation
- Update support process docs to reflect the change to discussing the last on-call rotation at 🍽️  Daily standup meeting
2021-07-27 17:06:16 -04:00
Mike McNeil
7a9d530938
fix copy/paste mistake in docs (#1487) 2021-07-27 11:17:04 -05:00
AndrewB
1decb2a56f
Add "Find deleted files from disk" to Standard query library (#1481) 2021-07-27 09:33:33 -04:00
noahtalerman
3478e2759d
Add the query that populates the 'Users' table in the Fleet UI to the standard query library (#1453)
- The included query populates the `users` property in the `/api/v1/fleet/hosts/{id}` response object.
- This information also populates the new "Users" table on the Host details page
2021-07-26 09:54:50 -04:00
Mike Thomas
27303765cf
Update FAQ.md (#1462)
fixed a small grammatical error.
2021-07-23 21:33:52 +09:00
Mike McNeil
200bc0c036
revert 39d55bf66a 2021-07-22 02:23:42 -05:00
Mike McNeil
39d55bf66a
Test emoji compilation 2021-07-22 02:21:58 -05:00
Benjamin Edwards
799243ffb5
Windows friendly changes after walking through getting started guide (#1441)
* update .gitattributes to be explicit about line endings with regards to the test certs
* update building-fleet guide to include python2 dependency on windows
* update configuration to default to OS specific temporary directories
2021-07-21 20:49:44 -04:00
Tomas Touceda
484c6153e3
Issue 1359 fleetctl team transfer (#1413)
* wip

* Add delete user command and translator

* Add host transfer command

* Add changes file

* Undo bad refactor

* Fix copypaste error

* Implement with interfaces instead of assertions

* Ad documentation and simplify implementation further

* Update docs/1-Using-Fleet/3-REST-API.md

Co-authored-by: Zach Wasserman <zach@fleetdm.com>

Co-authored-by: Zach Wasserman <zach@fleetdm.com>
2021-07-21 14:03:10 -03:00
noahtalerman
00ea74ed80
Add YARA configuration to documentation (#1428)
- Add example YARA config to the configuration-files documentation
- Update `single-file-configuration.yml`
2021-07-21 10:04:50 -04:00
noahtalerman
285d1e66ca
Remove duplicate sections from REST API documentation (#1427)
- Remove duplicate "Transfer hosts to a team" and "Transfer hosts to a team by filter" sections
2021-07-20 09:57:14 -04:00
noahtalerman
7caedd9347
Add routes for Schedule feature to REST API documentation (#1401)
Add documentation (route, parameters, example) for the following routes:
- `GET /api/v1/fleet/global/schedule`
- `POST /api/v1/fleet/global/schedule`
- `PATCH /api/v1/fleet/global/schedule/{id}`
- `DELETE /api/v1/fleet/global/schedule/{id}`
2021-07-19 09:58:41 -04:00
noahtalerman
6c22965917
Update screenshots and verbiage in Configuring Single Sign On documentation (#1396)
- Add new example Okta configuration screenshot
- Add new example Fleet configuration screenshot
2021-07-15 15:55:12 -04:00
noahtalerman
2c277ba28a
Update documentation for auto table construction (#1353)
- Move auto table construction (ATC) docs into the "Organization settings" section.
2021-07-12 10:36:49 -04:00
gillespi314
099b26724e
Update 2-Testing.md
Correct commands for launching Cypress tests in interactive mode
2021-07-11 10:51:05 -05:00
Tomas Touceda
587f6166a8
Add changes files doc (#1311)
* Describe changes files

* Minor fixes
2021-07-06 18:50:42 -03:00
noahtalerman
498209614c
Update examples in documentation to use FleetDM where possible (#1310)
- Remove "Connecting a host" from fleetctl documentation
- Remove queries from REST API examples
- Point to Launcher documentation
- Update community projects
2021-07-06 12:14:20 -04:00
Zach Wasserman
fe230bb9f4
Add FAQ entries for common migration and TLS questions (#1307)
Closes #1303
2021-07-05 17:52:13 -07:00
noahtalerman
9fb1f9cac1
Add link to Loom video that walks through setting up dev environment (#1304) 2021-07-05 18:45:41 -04:00
Mike Thomas
27c3a6dcd8
Remove legacy images from docs (#1296) 2021-07-06 07:13:48 +09:00
Mike McNeil
77f5b60b52
Fix broken links to binaries in docs (#1277)
* Update 8-Updating-Fleet.md

* Update 8-Updating-Fleet.md

* Update 3-Example-deployment-scenarios.md
2021-07-03 11:36:27 -05:00
Zach Wasserman
8384034e04
Update create user validation and documentation (#1285)
Closes #1272
2021-07-02 08:35:26 -07:00
Mike Thomas
8ca5031071
Update standard-query-library.yml (#1284) 2021-07-01 19:16:00 -05:00
Mike McNeil
162d9fd892
Update 1-Installation.md 2021-07-01 15:57:35 -05:00
Martavis Parker
5d0c7e510e
New Cypress configs and commands (#1268)
* #1024 added configs and commands to run

* #1024 fixed github actions for e2e tests

* #1024 optimized test configs
2021-07-01 10:32:12 -07:00
noahtalerman
2f42c281f9
Move configuration examples out of fleetctl-CLI documentation (#1253)
- Move configuration files examples from 2-fleetctl-CLI.md into /configuration-files/README.md. 
- Update example configuration files with "agent options" and remove all references to "osquery options"
- Update numbering for documentation files
2021-06-29 13:59:54 -04:00
Mike Thomas
ba2bffd34c
Add supported browsers to Fleet docs (#1227) 2021-06-29 10:38:27 -04:00
noahtalerman
59e31911c9
Update REST API documentation in preparation for Fleet 4.0.0 (#1235)
- Add link and warning to REST API docs for Fleet v3
- Update various endpoints
2021-06-28 14:41:01 -04:00
noahtalerman
7a9e662f07
Add documentation for publishing a prerelease version of fleetctl to npm (#1236) 2021-06-28 13:58:33 -04:00
noahtalerman
6c03415dae
Update documentation structure (#1230)
- Remove `2-Orbit-osquery` directory
- Rename `3-Deployment` directory to `2-Deploying`
- Rename `4-Contribution` directory to `3-Contributing`
2021-06-28 11:15:22 -04:00
Zach Wasserman
b00df0929e
Fix URLs in documentation (#1218)
Fix URLs not caught in previous PR CI run.
2021-06-25 19:23:45 -07:00
Zach Wasserman
444a935404
Fix doc directories (#1217)
Erroneous merge required fixing of doc directory naming.
2021-06-25 19:02:57 -07:00
Zach Wasserman
5e26af701b Merge branch 'main' into teams 2021-06-25 18:48:20 -07:00
Zach Wasserman
07b89c4cbd
Implement release automation (#1215)
- Use goreleaser to automate release process.
- Add new dockerfiles for fleet (with fleetctl) and fleetctl (only).
- Add GitHub Action Workflow to run goreleaser on new tag.
- Update NPM to match new archive naming.
2021-06-25 18:40:26 -07:00
noahtalerman
7aa380b0f0
Add testing fleetctl to the manual QA doc and update example config files (#1213)
- Update enroll secret config file with updated fields for Fleet 4.0.0
- Remove agent options config file. In Fleet 4.0.0, agent options are part of the organization settings configuration
2021-06-25 17:56:00 -04:00
noahtalerman
9ca91e7db6
Add information about use of differential queries in Lambda documentation (#1195) 2021-06-25 10:23:35 -04:00
noahtalerman
bf4eb899c6
Add usage statistics documentation to Using-Fleet section (#1196)
- Add new `usage-statistics.md` file
- Update link in the Fleet UI to point towards new docs
2021-06-24 16:59:25 -04:00
RachelElysia
aeb852e168
Remove username from UI (#1168)
* Remove username from UI code
* Remove username from tests
* Remove username from database
* Modify server endpoints for removing username
* Implement backend aspects of removing username
* Update API docs
* Add name to fleetctl
2021-06-24 13:42:29 -07:00
noahtalerman
be2cf92b37
Add documentation for setting global and team agent options in Fleet UI (#1190)
- Add "Configuring agent options" section to `/1-Using-Fleet/1-Fleet-UI.md`
- Add 2 screenshots: 1. Global agent options form 2. Team agent options form
2021-06-24 13:59:41 -04:00
Zach Wasserman
1417d01407
Make naming of host columns consistent (#1183)
Adding consistency between API and DB helps to make it easier for users
and developers working with the API to correctly order things.

Closes #317
2021-06-23 17:32:19 -07:00
aggiechris
a5bf3d8099
Add hint for flag file on Windows (#1178) 2021-06-23 17:41:27 -04:00
William Theaker
7bd4f2d395
Update SSO token docs (#1180) 2021-06-23 16:03:34 -04:00
William Theaker
f3ef70358a
Replace Okta image, compress others. (#1166) 2021-06-23 08:27:45 -07:00
Zach Wasserman
879774e60c
Add documentation on new --dev_license flag (#1165)
This flag makes it easier for developers to run Fleet in Fleet Basic
tier.
2021-06-22 18:02:40 -07:00
Zach Wasserman
5ad1ad1ffd
Update development documentation for SSO testing (#1161) 2021-06-22 14:31:26 -07:00
noahtalerman
a63a0ab6f2
Add license section to configuration documentation (#1157) 2021-06-21 18:57:50 -04:00
noahtalerman
e02b88d010
Update links to documentation so that they use main branch (#1151)
* Update to main branch

* Update link to releasing Fleet
2021-06-21 16:40:15 -05:00
noahtalerman
17a6c21224
Restructure documentation in preparation for docs living on fleetdm.com (#1143)
* Remove Orbit top level folder and rename folders to Deploying and Contributing

* Update link in doc README
2021-06-18 15:58:21 -05:00
Zach Wasserman
2ad557e3b3 Merge branch 'main' into teams 2021-06-18 09:42:20 -07:00
noahtalerman
7fb6a36a49
Move testing email using Mailhog out of the FAQ (#1122)
- Move instructions for connecting to the Mailhog simulated server out of the FAQ
- Merge instructions found in FAQ with existing instructions in `Testing.md`
2021-06-17 15:25:42 -04:00
Zach Wasserman
6b59a40dbc
Add backend and fleetctl support for API-only user (#1119)
- Add api_only to users table.
- Pass api_only values through service.
- Allow setting api_only in `fleetctl user create`.

Backend part of #402
2021-06-16 18:11:28 -07:00
RachelElysia
dea20a96b2
Add team's enroll secret GET request to API docs 2021-06-16 18:09:49 -04:00
Mike McNeil
0455ee144b
prepare docs so that images work on website (#1103) 2021-06-15 18:16:16 -05:00
noahtalerman
f9ce8c9a0f
Add question and answer for missing column error in Using Fleet FAQ (#1076)
- Point users to the upgrading Fleet docs (running database migrations) to resolve `unknown column` error
2021-06-14 11:48:27 -04:00
William Theaker
543f7144d8
Update docs to reflect IDP-initiated SAML support (#1057) 2021-06-11 13:12:04 -07:00
Zach Wasserman
e7cffa221d
Update release documentation (#1060) 2021-06-10 17:08:43 -07:00
gillespi314
676f3f0bd5
Query library improvements -- Round 2 (#973)
-Modify build-static-content back-end script to implement GitHub Users API and build contributor profile information into query library pages
-Remove related functionality from client-side page scripts
-Add dropdown menu to select filters
-Refine html and css
2021-06-10 12:57:37 -05:00
Mike McNeil
fccc58536b
Update 3-REST-API.md (#1052) 2021-06-10 12:54:12 -05:00
noahtalerman
718c644471
Documentation for RBAC and teams (#472)
- Add permissions.md and teams.md
2021-06-09 19:12:45 -04:00
noahtalerman
9b6c8d36e4
Additions and changes to Fleet REST API for multiple teams (#383)
- Add API documentation for Teams and RBAC features support
2021-06-09 19:11:48 -04:00
Mike McNeil
afacdcff90
fingers crossed 2021-06-07 18:26:22 -05:00
noahtalerman
8b13e354f8
Add link to simulated host instructions in Testing docs (#997)
- Add link testing documentation that points to instructions for starting up containerized hosts in the development environment.
2021-06-07 19:07:18 -04:00
Zach Wasserman
f75a2fc739
Fix up test osquery tooling (#996)
- Update certificate paths.
- Update documentation to point to the appropriate docs.
2021-06-07 13:34:17 -07:00
Zach Wasserman
6013194c1d
Reduce default session duration to 4 hours (#981) 2021-06-06 18:28:47 -07:00
Zach Wasserman
0356115b03
Remove JWT in Fleet session management (#979)
See #978 for motivations for this change.

Closes #978.
2021-06-06 18:10:58 -07:00
Zach Wasserman
db459d3363
Continue to update names in backend code and docs (#976) 2021-06-06 16:58:23 -07:00
Zach Wasserman
fa01df79d5 Merge branch 'master' into teams 2021-06-05 06:27:38 -07:00
Zach Wasserman
08d57b40d1
Remove deprecated kolide names from API routes and configuration (#957)
Closes #260
2021-06-04 16:51:18 -07:00
Zach Wasserman
16a8e13f85
Fix tls_compatibility key in yaml config (#955)
Closes #271
2021-06-04 08:44:36 -07:00
Martavis Parker
cb2682c273
Remove detection for OS during contributor build (#922) (#933)
- No longer detecting for OS make commands
- Using the same internal commands for every OS
- go.sum auto-updated during build
- Document build process on Windows
2021-06-04 08:10:25 -07:00
Mike McNeil
8b04c0c634
make example work from root dir of repo 2021-06-04 01:35:59 -05:00
noahtalerman
fa09131a5c
Specify that Fleet does not support Redis Sentinel in Configuration docs (#925) 2021-06-02 12:34:51 -04:00
noahtalerman
2dca66c33d
Add Fleet Core and Fleet Basic user/team creation scripts for manual QA (#919)
- Add `teams/create_core` script
- Add `teams/create_basic` script
- Rename existing script to `teams/create_figma`
2021-06-01 14:50:07 -04:00
Zach Wasserman
417ef2c9b6
Refactor teams service methods (#910)
- Move team-related service methods to `ee/server/service`.
- Instantiate different service on startup based on license key.
- Refactor service errors into separate package.
- Add support for running E2E tests in both Core and Basic tiers.
2021-05-31 17:07:51 -07:00
Zach Wasserman
9876dbe6b6
Implement license loading and validation (#908)
- Load license from ES256 signed JWT key.
- Parse license claims into LicenseInfo struct.
- Update contribution documentation with sample license key.

Closes #816.
2021-05-31 11:35:15 -07:00
Zach Wasserman
a5bd03e5d7 Merge branch 'master' into teams 2021-05-31 10:56:50 -07:00
Zach Wasserman
64f2cfc9cd
Refactor enroll secrets to support Teams (#903)
- Add `team_id` field to secrets.
- Remove secret `name` and `active` fields (migration deletes inactive secrets).
- Assign hosts to Team based on secret provided.
- Add API for retrieving secrets by Team.
2021-05-31 09:02:05 -07:00
Mike McNeil
7bb202f961
Publish fleetdm.com/queries (#899)
* /sandbox/queries becomes /queries, etc

* Publish fleetdm.com/queries

Expose query library routes the rest of the way, move remediation data sanitization to the point of entry, and update query library to match (pairing w/ @gillespi314)

* Fix accidental commit of sailsrc (again)
2021-05-28 17:51:47 -05:00
Mike McNeil
1512089384
add contributors to a query 2021-05-28 16:46:33 -05:00