Commit Graph

1556 Commits

Author SHA1 Message Date
Rachael Shaw
7ff7c2dc0f
Docs: tiny formatting fix (#15036)
"true" to `true` in boolean parameter description
2023-11-08 12:04:37 -06:00
Victor Lyuboslavsky
9cd4b9e770
Adding details for /queries/run endpoint. (#14956)
From discussions on PR https://github.com/fleetdm/fleet/pull/14909
2023-11-07 17:22:55 -06:00
Victor Lyuboslavsky
aa96caa8eb
Adding REST API example how to delete all hosts. (#14952) 2023-11-06 12:29:43 -06:00
Mike McNeil
15dbc1b3af
Update FAQ.md (#14951)
Does this get folks to the right place?  The other link was broken
2023-11-06 12:34:56 +09:00
Mike McNeil
88e7cd243d
Fix fleetdm.com/docs (#14950)
caused by a typo introduced during a live @mike-j-thomas + Mike M
product marketing session on Zoom:
22af47aa92 (r131737251)
2023-11-05 00:47:14 -05:00
Mike McNeil
6d029cf2a4
Docs: Update FAQ.md (#14948) 2023-11-05 00:20:20 -05:00
Mike Thomas
22af47aa92
Update heading position on why-fleet.md (#14884)
I moved the "What's it for?" heading. After seeing it on the site
(rather than Markdown) I feel that placing it between the new paragraphs
disrupts the message.

I also addressed some grammar and formatting issues. Removed some
redundant words and rephrased a couple of sentences to give a more
personable tone.

### Original

<img width="541" alt="image"
src="https://github.com/fleetdm/fleet/assets/78363703/1e67d9f2-4912-43db-846e-1f9b8d5803f6">

### vs this PR

<img width="741" alt="image"
src="https://github.com/fleetdm/fleet/assets/78363703/4a362eec-f871-4612-a46e-1fbdfe72f21e">
2023-11-04 22:50:00 -05:00
Eric
02f2e5a661
Docs: update backticks in parameter description (#14943)
Changes:
- added backticks to a parameter description ("`"differential", or
"differential_ignore_removals"`" » "`"differential"`, or
`"differential_ignore_removals"`")...
2023-11-03 20:34:00 -05:00
Rachael Shaw
05695a0928
Docs: Config file changes for #7766 (#14946)
Add `discard_data` to query covfig example and `query_reports_disabled`
to org settings.
2023-11-03 18:00:35 -05:00
George Karr
93a4e9cc2b
Update Building-Fleet.md (#14761)
Fixing build instructions for Ubuntu as the previous instructions
install an incompatible version of npm / nodejs
2023-11-03 14:53:02 -05:00
Dustin Gerdes
2cc20ab259
Docs: removed fleet vs fleet sandbox (#14503)
If some of the following don't apply, delete the relevant line.
...

---------

Co-authored-by: Sampfluger88 <108141731+Sampfluger88@users.noreply.github.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-11-03 14:30:00 -05:00
Katheryn Satterlee
62d758762a
Fix broken link to configuration documentation (#14292) 2023-11-03 13:26:03 -05:00
RachelElysia
bdb2c4c5b7
Fleet UI: Observer+ can run policies in the UI, update docs accordingly (#14796) 2023-11-03 07:42:11 -04:00
Charles Z
a13baca0c5
Update ATC docs for TCC.db example (#14914)
I've updated the ATC example that uses TCC.db to be cross-compatible
with as many MacOS versions as possible. This is still useful as-is.

I've also added a chunk for folks to copy/paste directly into their team
settings in the UI for those not using GitOps.

Hopefully others find this helpful!
...

---------

Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
2023-11-02 21:44:53 -05:00
Isabell Reedy
95bcc0c80e
Docs: how the product sets the name attribute of the scheduled query (#14307)
@ksatter I haven't included an example of the audit logs because we
already have it elsewhere in the docs, so have just linked.

Reference: #13646 & #13648

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2023-11-02 14:57:42 -05:00
George Karr
970854e078
Switching systray dependency to one without glibc requirements (#14197) 2023-11-02 14:40:21 -05:00
Mike Thomas
5fc79b8e23
Update FAQ.md (#14844)
Fixed heading from h3 to h2.
2023-11-01 21:37:57 -05:00
Mike Thomas
9363bfd302
Update why-fleet.md (#14819)
Changes:

- Added "Why Fleet" section to incorporate Fleet's point of view.
- Updated the "What's it for" section
- Lit up some useful links
- Updated some out-of-date links

.
2023-11-01 21:36:37 -05:00
Marko Lisica
e4e11e9ea4
MDM commands API changes (#14239)
API changes for the Windows MDM command story: #13069 

Changes:
- Add cross platform endpoints used for macOS and Windows MDM commands
- Deprecate `/apple` endpoints.

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2023-11-01 18:39:34 +01:00
Mike McNeil
a3399984e1
Docs: Update FAQ.md (#14818) 2023-10-31 04:11:32 -05:00
Mike Thomas
9c6003dc12
FAQ update (#14813)
Closes https://github.com/fleetdm/fleet/issues/14814

Changes:

- moved the FAQs from the pricing page to the FAQs in the docs. The
theory is that these questions are a long way down the page and likely
being missed.
- Added five more questions and answers to the FAQ from questions that
come up during customer calls.
- Commented out existing questions. Some are out of date, and some have
been dumped into the FAQ for lack of a better place to put them. We will
continue to add to this list with stronger content from talking with
users and customers.
- added a link to the FAQ on the pricing page.
2023-10-31 00:32:48 -05:00
Rachael Shaw
0e99f5a660
Docs: Change order of query API endpoints (#14803)
Moved "List queries" to the top, to match the order of other sections of
the API. (We usually start with the endpoint to get a list of things,
_then_ the endpoint to get one thing by ID.)
2023-10-30 15:21:43 -05:00
Noah Talerman
581724809d
REST API docs (#14793)
- Update link
- Update instructions
2023-10-30 15:41:02 -04:00
Victor Lyuboslavsky
1e0fa92428
13998 host options validation (#14539)
#13998 

Cleaned up REST API input validation for hosts, carves, users endpoints.

rest-api.md changes explained:
https://www.loom.com/share/9cd82653bacb4528bdaac117ec85a976

For the following endpoints:
/api/v1/fleet/hosts
/api/v1/fleet/hosts/count
/api/v1/fleet/hosts/report
  - converted validation errors from 500 to 400 HTTP status code
- added validation that policy_id must be present when policy_response
is specified
  - added validation that policy_response must be `passing` or `failing`
  - added validation that `os_name` must be specified with `os_version`

For the following endpoint:
/api/v1/fleet/users
  - converted team_id validation error from 500 to 400 HTTP status code

For the following endpoint:
/api/v1/fleet/carves
- added rest-api.md documentation for `page`, `per_page`, `order_key`,
`order_direction`, and `expired`
- converted `expired` validation error from 500 to 400 HTTP status code

# Checklist for submitter
If some of the following don't apply, delete the relevant line.

- [x] Changes file added for user-visible changes in `changes/` or
`orbit/changes/`.
See [Changes
files](https://fleetdm.com/docs/contributing/committing-changes#changes-files)
for more information.
- [x] Documented any API changes (docs/Using-Fleet/REST-API.md or
docs/Contributing/API-for-contributors.md)
- [x] Added/updated tests
- [x] Manual QA for all new/changed functionality

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-10-27 15:13:20 -05:00
RachelElysia
386f2c6171
ChromeOS: [bug] Surface chrome extensions as software for ChromeOS hosts (#14624) 2023-10-27 13:04:07 -04:00
Jahziel Villasana-Espinoza
c570ef1e21
feat: make analytics always true for premium customers (#14607)
# Checklist for submitter

If some of the following don't apply, delete the relevant line.

- [x] Changes file added for user-visible changes in `changes/` or
`orbit/changes/`.
See [Changes
files](https://fleetdm.com/docs/contributing/committing-changes#changes-files)
for more information.
- [x] Added/updated tests
- [x] Manual QA for all new/changed functionality
2023-10-27 11:41:18 -04:00
Roberto Dip
5dfc72b2a1
allow to use --context in fleetctl mdm run-command (#14665)
for #13712
2023-10-26 19:09:31 -03:00
Lucas Manuel Rodriguez
2fd6fa4e04
Vulnerability processing should ignore software without version (#14612)
#13615

- [X] Changes file added for user-visible changes in `changes/` or
`orbit/changes/`.
See [Changes
files](https://fleetdm.com/docs/contributing/committing-changes#changes-files)
for more information.
- ~[ ] Documented any API changes (docs/Using-Fleet/REST-API.md or
docs/Contributing/API-for-contributors.md)~
- ~[ ] Documented any permissions changes (docs/Using
Fleet/manage-access.md)~
- ~[ ] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements)~
- ~[ ] Added support on fleet's osquery simulator `cmd/osquery-perf` for
new osquery data ingestion features.~
- [X] Added/updated tests
- [X] Manual QA for all new/changed functionality
  - ~For Orbit and Fleet Desktop changes:~
- ~[ ] Manual QA must be performed in the three main OSs, macOS, Windows
and Linux.~
- ~[ ] Auto-update manual QA, from released version of component to new
version (see [tools/tuf/test](../tools/tuf/test/README.md)).~
2023-10-26 18:28:08 -03:00
Roberto Dip
001120274c
adjust response status code for mdm/apple/enqueue (#14666)
For #14529
2023-10-26 18:20:11 -03:00
Marko Lisica
de5695659a
Batch-apply scripts: parameters documented incorrectly (#14653)
# Checklist for submitter

If some of the following don't apply, delete the relevant line.

- [ ] Changes file added for user-visible changes in `changes/` or
`orbit/changes/`.
See [Changes
files](https://fleetdm.com/docs/contributing/committing-changes#changes-files)
for more information.
- [ ] Documented any API changes (docs/Using-Fleet/REST-API.md or
docs/Contributing/API-for-contributors.md)
- [ ] Documented any permissions changes (docs/Using
Fleet/manage-access.md)
- [ ] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements)
- [ ] Added support on fleet's osquery simulator `cmd/osquery-perf` for
new osquery data ingestion features.
- [ ] Added/updated tests
- [ ] Manual QA for all new/changed functionality
  - For Orbit and Fleet Desktop changes:
- [ ] Manual QA must be performed in the three main OSs, macOS, Windows
and Linux.
- [ ] Auto-update manual QA, from released version of component to new
version (see [tools/tuf/test](../tools/tuf/test/README.md)).
2023-10-26 10:59:10 +02:00
Noah Talerman
f50243fe20
Windows MDM article (#14566)
Addresses: https://github.com/fleetdm/confidential/issues/3914

- Consolidate changes from #13943, #14184, and #14249 into article
- Remove "Window setup" doc page.

TODO: @spokanemac to add an image for the article and appropriate meta
tags so that the article shows up on fleetdm.com/guides

---------

Co-authored-by: spokanemac <jack@jdstrong.com>
Co-authored-by: JD <spokanemac@users.noreply.github.com>
Co-authored-by: Eric <eashaw@sailsjs.com>
2023-10-24 08:19:18 -07:00
Rachael Shaw
782d71481f
Reframe note about scheduled queries not returning errors (#14683)
Move content into a blockquote (since h3s on this page are reserved for
API endpoints), and point users toward how to get errors for a
particular query via the REST API.
2023-10-20 17:34:42 -05:00
Eric
4a6bf0d447
2023-10-24 Website: Update /try-fleet (#14638)
Closes: https://github.com/fleetdm/confidential/issues/4015

Changes:
- Changed the url for `/fleetctl-preview` to
`/try-fleet/fleetctl-preview`
- Updated the controller for the `/fleetctl-preview` page to redirect
non-logged-in users to `/try-fleet/login`
- Removed the route for `/try-fleet/sandbox-expired`, and added a
redirect going to `/try-fleet/fleetctl-preview`.
- Updated the controller for `/try-fleet/sandbox` to redirect the users
without a non-expired Sandbox instance to `/try-fleet/fleetctl-preview`.
- Updated `signup.js` to not provision Fleet sandbox instances for
users.
- Updated the `User` model to support a third `signupReason`: "Try
Fleet"
- Updated `/try-fleet/register` to submit "Try Fleet" as a
`signupReason` when users sign up.
- Renamed the files for the `/fleetctl-preview` page (`get-started` »
`fleetctl-preview`)
- Updated/removed Fleet Sandbox related handbook sections.
- Replaced the "Fleet vs Fleet Sandbox" section in the deploying
documentation with a note about `fleetctl preview`.
- Updated links to Fleet Sandbox in articles.

---------

Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
2023-10-20 13:59:18 -05:00
gillespi314
d470127352
Update docs for host disk encryption detail API response (#14628) 2023-10-20 13:55:49 -05:00
Roberto Dip
2f589ff37c
document flags required for fleetd error reporting (#14656)
For #13189, this documents the server config flag required to report
errors.
...
2023-10-19 23:49:18 -05:00
Eric
ab1d055cd4
Remove navSection meta tags from configuration documentation pages (#14646)
Closes: https://github.com/fleetdm/fleet/issues/14467
2023-10-19 17:05:08 -05:00
pacamaster
cedf1d1ebb
add line about offline (#14271)
Docs only change...

...
2023-10-19 12:23:16 -05:00
Robert Fairburn
f52a6f3070
initial byo-vpc module article (#13665) 2023-10-18 11:23:52 -05:00
Pratham
9ec2efb979
docs/MDM-Windows-setup: fixup environment variable (#14593)
The correct variable to use seems to be `FLEET_DEV_MDM_ENABLED`,
`FLEET_MDM_WINDOWS_ENABLED_AND_CONFIGURED` is not present in the
codebase
2023-10-17 21:43:41 -05:00
Mike Thomas
82534168d9
Updated grammar and typos on FAQ.md (#14587)
I was in this file and got sucked into fixing up a bunch of typos and
grammar issues. (I just had to clear all the Grammarly red marks 😵‍💫)

- Added missing punctuation
- Removed unnecessary punctuation
- Fixed some typos
- Hypenated some compound adjectives 
- Removed some unnecessary hyphens

.
2023-10-16 23:36:23 -05:00
Rachael Shaw
10ed97e570
Docs: API changes for #7766 (#13484)
Draft PR to show API changes for #7766

#13469

---------

Co-authored-by: Lucas Rodriguez <lucas@fleetdm.com>
Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
2023-10-16 23:34:32 -05:00
Lucas Amorim
637430f442
Fixing typo on the proxies page (#14576)
Fixing typos - replacing capital case with lower case.

Removed all the checklist because it doesn't apply to changes in the
documentation....
...
...

Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
Co-authored-by: Sampfluger88 <108141731+Sampfluger88@users.noreply.github.com>
2023-10-16 21:03:10 -05:00
Mike Thomas
37cacac1d8
Update to "Can you host Fleet for me?" in FAQ.md (#14585)
I added a link to the license dispenser in the "Can you host Fleet for
me?" section.

# Checklist for submitter
- [x] Manual QA for all new/changed functionality
2023-10-16 17:24:23 -05:00
Noah Talerman
fb64a9ee73
Configuration reference docs: WSTEP cert/key (#14567)
- Inform user that they will have to turn disk encryption on/off again
if they change their WSTEP cert/key pair
2023-10-16 18:08:07 -04:00
Gabriel Hernandez
db580e4eba
update broken link for mdm macOS setup assistant docs (#14530)
fix broken link for mdm macos setup docs
2023-10-16 17:03:48 -05:00
Rachael Shaw
283e694e06
Fix link formatting (#14541)
Fixed markdown syntax for links in a couple places where it was
formatted incorrectly (`(…)[…]` instead of `[…](…)`)

(Fixed one earlier and just searched the docs folder for `)[` to find
these; hopefully this PR nabs the rest.)
2023-10-16 16:52:58 -05:00
Luke Heath
1b428aff94
Fix typo on MDM-Windows-setup.md (#14552)
......
2023-10-16 16:52:28 -05:00
Lucas Manuel Rodriguez
87e2cfca71
Add query report to manage-access.md (#14542)
Adding the permissions docs change for #7766.

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-10-16 14:18:42 -03:00
Rachael Shaw
8f4ae0c50a
Small formatting fix (#14553)
Added some missing backticks where we had a larger-than-intended block
of text highlighted as code.
2023-10-14 17:03:04 -05:00
Tim Lee
148386e956
Docs: Query Report API (#14204) 2023-10-12 14:17:41 -06:00