Commit Graph
2146 Commits
Author SHA1 Message Date
Eric 6dfd114cce Docs: Update heading links on "Hosting Fleet" page. (#25820)
Closes: #25797

Changes:
- Updated the HTML links on the "Hosting Fleet" documentation page so
they will be linkable by the "On this page" sidebar on the Fleet
website.
2025-01-28 11:59:38 -06:00
Noah Talerman 57b6ab1b4f Host vitals page: clarify that Fleet checks the default disk on Linux (#25778)
Update the description on this page:
https://fleetdm.com/vitals/disk-encryption-linux#linux

More context in Slack here.
2025-01-27 14:21:43 -06:00
Katheryn SatterleeandRachael Shaw 49231f19be Update agent-configuration.md (#25740)
- Updated the query suggested to view all osquery flags
- Added a note that running this query through osqueryi will not reflect
the settings in use by osqueryd.

# Checklist for submitter

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

Documentation only change

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2025-01-27 13:35:46 -06:00
Jordan Wright d074ba2b48 Fix incorrect source in device mapping REST API docs (#25641)
### Summary

This PR closes #25640 by fixing the incorrect `source` value in the
device mapping REST API docs.

The real value is `mdm_idp_accounts` which can be found
[here](https://github.com/fleetdm/fleet/blob/15ac79323858c7344677edd5eb01b9a0d548120f/server/fleet/hosts.go#L894).

### Test Plan

- [x] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
See [Changes
files](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/Committing-Changes.md#changes-files)
for more information.

I couldn't find any other references to `identity_provider`, so I think
these two were all of them.
2025-01-24 16:32:03 -06:00
Eric 5c0894ce0a Website: Create queries.yml, add vitals and query pages, move policies. (#25701)
Related to: https://github.com/fleetdm/confidential/issues/9096

Changes:
- Created docs/queries.yml. A YAML file that contains the queries from
the standard query library (`kind: query`) and the host vitals queries
(`kind: built-in`).
- Added the `vitals/*` page, a page that displays details about host
vital queries used to gather information about.
- Updated the /queries page to show queries from the new
`docs/queries.yml` file, and moved policies to a new page (/policies)
- Updated the view action for the query-detail page to look for/redirect
to a policy page with a matching slug before returning a 404 response if
a matching query is not found. This behavior will make it so all of the
old URLs for policy pages will redirect users to the new URL.
- Updated the website's "Docs" navigation menu to have links to the new
vitals and policies pages.
2025-01-22 21:10:17 -06:00
Harrison Ravazzolo 19947a0c08 Add support for post_install_script (#25683)
This is supported in gitops but not referenced in docu.
2025-01-22 18:02:42 -06:00
Konstantin Sykulev a1a43415d4 Removed filename from fleet maintained apps response (#25685)
This field was never implemented

<img width="876" alt="Screenshot 2025-01-21 at 8 33 56 PM"
src="https://github.com/user-attachments/assets/8b110375-e2e2-4805-b42b-676a3030e9d8"
/>
2025-01-22 18:00:54 -06:00
Harrison Ravazzolo a23c305e04 Typo in gitops yaml file (#25681)
Update `name` to proper syntax `org_name`
2025-01-22 18:00:28 -06:00
Rebecca Cowart fecc8bbc07 Update rest-api.md (#25670)
Fixed typo - misspelling of "endpoint"
2025-01-22 15:36:13 -06:00
Scott Gress 4ac1be34d9 Update docs for host_batch_size (#25632)
for #24967 

This PR updates the documentation for the `host_batch_size` for both the
failing policies webhook and the vulnerabilities webhook. The new
documentation matches the actual behavior when `host_batch_size` is set
to 0.
2025-01-22 13:15:31 -06:00
Mike ThomasandRachael Shaw a7acff4eda Updated anatomy and teams guide (#25629)
Closes https://github.com/fleetdm/fleet/issues/24615

Updated anatomy to:
- Include a more accurate definition of teams
- Updated out-of-date links. Specifically FleetUI that linked to the
queries guide. I updated to link directly to the FleetUI YouTube video.
- Consolidated osquery, Orbit, and Fleetd Chrome extension definitions
under "Fleetd."
- Updated Host vitals and Software definitions

Updated teams guide.
- Fixed some typos and re-phrased a couple of paragraphs for easier
readability
- I provided the missing instructions for adding hosts to teams
(probably should have PR'd this separately, but got carried away)

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2025-01-22 12:39:44 -06:00
Ian Littman 65f9ef4967 Bump Node version to 20.18.1 (#25591)
For #25590.

# Checklist for submitter

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

<!-- Note that API documentation changes are now addressed by the
product design team. -->

- [x] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
See [Changes
files](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/Committing-Changes.md#changes-files)
for more information.
- [x] Manual QA for all new/changed functionality
2025-01-20 15:50:28 -06:00
Ian Littman a3d83f47b9 Update endpoint docs for VPP app batch set (#25585)
Changes implemented in the VPP automation GitOps PR (for #23531); docs
split to another PR for easier review.
2025-01-20 11:23:29 -06:00
Rebecca Cowart 289e66a568 Update rest-api.md (#25527)
Added context to the `additional_info_filters` parameter.
2025-01-16 16:12:11 -06:00
Rebecca Cowart 2f20f13246 Update yaml-files.md (#25526)
Added ai_features_disabled to the list of server_settings. Fixed two
spelling issues. Made the grammar surrounding each "(default:...)" text
consistent within that section.
2025-01-16 16:04:53 -06:00
jacobshandlingandJacob Shandling 725ccf6ebc Docs: fix type (#25523)
This parameter should be a string

Co-authored-by: Jacob Shandling <jacob@fleetdm.com>
2025-01-16 15:52:37 -06:00
Marko Lisica 8b073d577c Update docs and guide about variables (#25445)
Related to:
- https://github.com/fleetdm/fleet/issues/23238#issuecomment-2591300093
2025-01-16 13:34:28 -05:00
Noah Talerman 498ddca753 API reference: clarify 10k character limit for arbitrary scripts (#25470) 2025-01-15 15:14:29 -06:00
Dante CatalfamoandScott Gress 39466cb644 Use webhooks settings from gitops even when empty (#25347)
#24958

---------

Co-authored-by: Scott Gress <scottmgress@gmail.com>
2025-01-15 11:31:48 -05:00
Ian Littman f1949ac2bf Add VPP policy automation support to backend (#25154)
For #23529, #23530.

# Checklist for submitter

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

<!-- Note that API documentation changes are now addressed by the
product design team. -->

- [x] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
See [Changes
files](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/Committing-Changes.md#changes-files)
for more information.
- [x] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements)
- [x] If database migrations are included, checked table schema to
confirm autoupdate
- For database migrations:
- [x] Checked schema for all modified table for columns that will
auto-update timestamps during migration.
- [x] Confirmed that updating the timestamps is acceptable, and will not
cause unwanted side effects.
- [x] Ensured the correct collation is explicitly set for character
columns (`COLLATE utf8mb4_unicode_ci`).
- [x] Added/updated automated tests
- [x] A detailed QA plan exists on the associated ticket (if it isn't
there, work with the product group's QA engineer to add it)
- [x] Manual QA for all new/changed functionality
2025-01-13 15:53:24 -06:00
Rachael Shaw d27d6796f7 Small formatting fix in API for contributors (#25336)
Fixed some curly brackets that should have been square brackets
2025-01-10 11:51:35 -06:00
Lucas Manuel Rodriguez 7e419f97cb Fix missing docs and yaml (#25333) 2025-01-10 11:42:55 -06:00
378b404421 Documentation changes for v4.62.0 (#25315)
Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
Co-authored-by: Konstantin Sykulev <konst@sykulev.com>
Co-authored-by: George Karr <georgekarrv@users.noreply.github.com>
Co-authored-by: Victor Lyuboslavsky <victor.lyuboslavsky@gmail.com>
Co-authored-by: Ian Littman <iansltx@gmail.com>
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Lucas Manuel Rodriguez <lucas@fleetdm.com>
Co-authored-by: Eric <eashaw@sailsjs.com>
2025-01-09 18:04:34 -06:00
Rachael Shaw 4f68dca1a3 Docs: Update get host example response (#25313)
Couple changes in advance of API design for #23235 (since certificates
will be available for macOS/iOS/iPadOS):
+ Update "Get host" example response to be a macOS host
+ Update "Get host by device token" example response to be a macOS host
& move weightier items to the bottom for readability
2025-01-09 16:46:24 -06:00
Eric 4980052f0b Website: Update policy details page, add controls to policies in standard query library. (#25309)
Related to: #23285


Changes:
- Updated the policy details page to have a controls section that
displays the `configuration_profile` and `script` values of policies
- Added configuration profiles and scripts from
https://github.com/ddribeiro/fleet-remediation-controls to macOS
policies in the standard query library.
2025-01-09 16:28:22 -06:00
Rachael Shaw d1a564e387 Docs: Update get host example (#25310)
+ Update "Get host" example response to be a macOS host (in advance of
API design for #23235, since certificates will be available for
macOS/iOS/iPadOS)
+ Update formatting of "Get host by identifier" to move weightier items
to the bottom
2025-01-09 15:52:34 -06:00
Noah Talerman 9cb59c2abd Reference docs: "Agent configuration" page cleanup (#25290)
This PR brings the "Agent configuration" format/organization closer to
the format we use for all other reference docs (YAML files, REST API,
and Fleet server configuration)

Changes:
- Update page headers so that the right-side navigation includes all the
top-level keys. Similar to the YAML files docs.
- Brings examples to the top of each section after a short description
(if necessary)
- Cut content
- Update "Learn more" links to more recent guides
2025-01-09 13:10:56 -06:00
Katheryn Satterlee 11f8e074e9 Restore stewardship commitment in FAQ (#25285)
The entry outlining Fleet's commitment to open source stewardship was
accidentally removed from the FAQ. Restoring it to its rightful place.

# Checklist for submitter

Docs only change.
2025-01-09 12:43:55 -06:00
Harrison RavazzoloandHarrison John ec2a866029 Update proxy doc in reference architecture (#25230)
Small change from a slack convo -
https://fleetdm.slack.com/archives/C019WG4GH0A/p1736282697358929

Co-authored-by: Harrison John <harrisonjohn@mac.lan>
2025-01-08 16:13:46 -06:00
Rebecca Cowart c0d63e9468 Update FAQ.md - Removals (#25223)
Removed questions scheduled to be removed
2025-01-08 11:56:27 -06:00
Katheryn Satterlee 6421a65326 Update Aurora RDS Versions (#25214)
Updated AWS Aurora versions to reflect MySQL requirements

# Checklist for submitter

Docs only change
2025-01-08 11:52:17 -06:00
Rachael Shaw a80466a93c Docs: More readability improvements to "Get host" response (#25228)
Moved weightier items to the bottom of the response and smaller items up
top.
2025-01-07 17:17:51 -06:00
Rachael Shaw edbba87d08 API docs: Make "Get host" example response more readable (#25227)
Moved software array further down in the response.
2025-01-07 17:11:50 -06:00
Scott Gress f2239e6a48 Merge docs changes around script exection and YARA (#25204)
This PR cherry-picks a couple of docs changes I added to the docs-4.63.0
branch. These changes were approved and merged in
https://github.com/fleetdm/fleet/pull/25181 and
https://github.com/fleetdm/fleet/pull/25189, before I belatedly asked
whether that was the correct process.
2025-01-07 11:17:21 -06:00
Gabriel Hernandez b193f2dc1c add software_title_id to added_app_store_app activity (#25119)
relates to #24120

adds the `software_title_id` to the `added_app_store_activity`

- [x] Added/updated automated tests
- [x] Manual QA for all new/changed functionality
2025-01-03 16:03:13 +00:00
Victor Lyuboslavsky 0b9f36ad03 Enable MySQL 9.1 Go tests (#25055)
Enable MySQL 9 tests in the nightly Go test run.

The tests passed in my run:
https://github.com/fleetdm/fleet/actions/runs/12552738253/job/34999129651
2025-01-02 15:36:10 -06:00
Victor Lyuboslavsky 4c463b6c2f Use Render Redis service (#23056)
Use Render's Redis service in `render.yaml`

Successfully deployed on Render:
<img width="1009" alt="image"
src="https://github.com/user-attachments/assets/fdb79286-3336-4747-97c0-b75c7578c0e8"
/>
2025-01-02 10:07:54 -06:00
Harrison RavazzoloandHarrison John 71c8467a28 Fix typos in server config documentation (#25036)
Co-authored-by: Harrison John <harrisonjohn@Harrisons-MacBook-Pro.local>
2024-12-30 13:00:43 +01:00
Noah TalermanandMarko Lisica 3881d0b9d6 macOS setup experience guide: end user authentication (#24990)
- Put "already configured SSO" message at the top b/c this scenario will
apply to most users
- Add missing permissions for IdP for end user auth and end user
migration
- Clean up language in docs
- Add redirects for the UI in case content moves later

---------

Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
2024-12-27 16:33:00 +01:00
Noah TalermanandMarko Lisica ec43ee288b SSO guide: best practice for email 2FA (#25005)
Fleet shipped email 2FA. User story is here (#22078)

- Add best practice to guides:
  - Email 2FA for "break-glass" user
  - SSO for all other users
- Update pricing page to link to feature request instead of the user
story.

---------

Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
2024-12-25 11:55:24 +01:00
Tim Lee f6f35be694 Remove homebrew app casks (#24593) 2024-12-24 13:25:53 -07:00
Ian Littman 7053731354 Move invite API endpoint docs from Fleet configuration heading to user heading, add missing mfa_enabled fields on invite endpoints (#24986)
For #24985. Also rewords rather verbose "these are authenticated
endpoints" descriptions for both subheadings.
2024-12-24 13:49:43 -05:00
Jahziel Villasana-Espinoza 3123324fe0 fix: add missing field (#24977)
> Related issue: #24970

# Checklist for submitter

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

<!-- Note that API documentation changes are now addressed by the
product design team. -->

- [x] Added/updated tests
- [x] Manual QA for all new/changed functionality
2024-12-24 12:30:46 -05:00
jacobshandlingandJacob Shandling 1a1ec72483 Docs: Add platform query param to GET queries API docs (#24999)
Addresses #23061

Co-authored-by: Jacob Shandling <jacob@fleetdm.com>
2024-12-23 14:40:24 -08:00
Noah Talerman e6b1f73846 API reference docs: Profiles & scripts in GET /config, PATCH /config,GET /teams/:id , and PATCH /teams/:id (#24972)
Discovered this gap in API reference docs here:
https://github.com/fleetdm/fleet/issues/24789#issuecomment-2555549128
2024-12-23 15:56:41 -05:00
gillespi314 c78002747f Merge branch 'main' into feat-labels-scoped-software 2024-12-20 17:06:48 -06:00
Janis Watts 6979fc128c Updated MailHog/Mailpit instructions for current UI and consistency (#24954)
Updated instructions to reflect the current UI options and changed
formatting in "MailHog SMTP server without authentication" to match the
more organized "Mailpit SMTP server with plain authentication" section.
2024-12-20 14:29:41 -06:00
Noah Talerman 5f9fcfc9f4 YAML files reference docs: windows_migration_enabled (#24891)
- Add missing reference docs for the following user story:
  - #22075
2024-12-19 14:37:49 -05:00
Katheryn Satterlee d5ce6fa5d1 Clarify automation reset (#24884)
Updated /automations/reset description to reflect that this endpoint
does not immediately trigger automations, but resets the status of hosts
so that they are seen as newly failing on the next automation run.
2024-12-19 11:46:55 -06:00
Gabriel Hernandez 9057bf62a3 Merge branch 'main' into feat-labels-scoped-software 2024-12-18 15:36:20 -06:00