Commit graph

2503 commits

Author SHA1 Message Date
Victor Lyuboslavsky
67977ad182
Added TPM-backed HTTP signing contributor docs. (#30337) 2025-06-26 14:53:58 -06:00
Ian Littman
57939c94ef
Document vuln feed cleanup option introduced in #28207 (#30328) 2025-06-26 14:25:56 -05:00
RachelElysia
05037f9ea0
Fleet Docs: Update /hosts/:id/software API docs to reflect available params (#30123)
## Description
- Copied verbatim from REST API docs for `GET /software` params
2025-06-25 17:44:50 -05:00
Juan Fernandez
b31d5f9bba
Misc feedback for new Windows doWipe cmd (#30252)
For #21979 

A couple of small items that came up during the first round of QA
2025-06-25 18:38:40 -04:00
Martin Angers
4994571c22
DCLK: add mechanism to verify user-scoped profiles (#30110) 2025-06-25 09:51:43 -04:00
Lucas Manuel Rodriguez
39dc7a3772
Add app_sso_platform table to orbit and use table in Entra ID query ingestion (#30140)
#28621

- [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/guides/committing-changes.md#changes-files)
for more information.
- [X] Added/updated automated tests
- [X] Manual QA for all new/changed functionality
- For Orbit and Fleet Desktop changes:
- [X] Make sure fleetd is compatible with the latest released version of
Fleet (see [Must
rule](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/workflows/fleetd-development-and-release-strategy.md)).
- [X] Orbit runs on macOS, Linux and Windows. Check if the orbit
feature/bugfix should only apply to one platform (`runtime.GOOS`).
- [X] Manual QA must be performed in the three main OSs, macOS, Windows
and Linux.
- [X] Auto-update manual QA, from released version of component to new
version (see [tools/tuf/test](../tools/tuf/test/README.md)).
2025-06-20 17:01:38 -03:00
Victor Lyuboslavsky
84363c28d6
ADR-0001: Pilot splitting service layer into separate Go packages 📦 (#29850) 2025-06-17 11:28:22 -05:00
Lucas Manuel Rodriguez
5251b99ca0
Fix auto generated documentation CI checks in main (#30065)
Last week we had to revert some doc changes because codeowners were OOO.
2025-06-17 11:26:50 -03:00
Rachael Shaw
8641657686
Revert #27457 API changes (default avatar for API-only user) (#30051)
https://github.com/fleetdm/fleet/issues/27457 did not make it into a
sprint and docs were not removed.
2025-06-16 12:18:01 -05:00
Sarah Gillespie
4ab8208231
Update documentation for custom SCEP proxy (#29971) 2025-06-16 12:00:27 -05:00
Rachael Shaw
ac16428f3c
4.69.0 doc changes (#28937) 2025-06-14 14:26:45 -05:00
Rachael Shaw
0f3c9fd068
Docs: Add spacing in labels note (#30014) 2025-06-13 17:45:26 -05:00
Marko Lisica
af2bdf024a
Labels section included twice in YAML files docs (#29859)
Related to:

- #29789

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2025-06-13 17:04:42 -05:00
Victor Lyuboslavsky
5a8f338a68
Documented Android fleetdm.com proxy endpoints. (#29901)
Fixes #26519
2025-06-13 16:56:15 -05:00
Janis Watts
ea7bad3863
Clarify behavior when hash is provided in GitOps but no package matching that hash exists in Fleet (#29866)
Updated documentation to be more clear on behavior if hash is provided
for software package in YAML.
2025-06-13 16:53:43 -05:00
Victor Lyuboslavsky
8d4bf5bbd2
Updating Android contributor docs. (#29880)
Fixes #26519
2025-06-13 15:59:48 -05:00
Ian Littman
6f772a4405
Clean up "here" link anchors for docs, ee, and frontend dirs (#29742)
More work to fix #29720.

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2025-06-13 15:05:52 -05:00
Martin Angers
4dfe95304b
Regenerate host vitals doc for osquery query change (#29915)
For #29323 , contributor docs changes only (follow-up to
https://github.com/fleetdm/fleet/pull/29555).
2025-06-13 14:49:59 -05:00
Lucas Manuel Rodriguez
5646062c85
Update go to 1.24.4 and add some automation (#29954)
Fixes CVE-2025-22874 reported by
https://github.com/fleetdm/fleet/actions/runs/15601368321/job/43941793647.

(IMO not a critical CVE, so it doesn't need to be cherry-picked into
v4.69.0.)

Added automation to make this easier next time.
2025-06-13 13:08:14 -05:00
Brock Walters
daca0e7b17
Update Hosts endpoint list in rest-api.md (#29972)
Added #resend-hosts-configuration-profile link in Host endpoint list.

Why are these in this order? What is the order scheme? Thanks.
2025-06-12 17:49:32 -04:00
Sarah Gillespie
9fcd2e15c2
Add one-time challenge support to custom SCEP proxy (#29832) 2025-06-12 08:56:13 -05:00
Ian Littman
7bfd675698
Add contributor docs for self-service uninstall results endpoint (#29835)
For #28846. Code merged in #29712.
2025-06-11 16:27:56 -05:00
Juan Fernandez
d847ec8ed4
21979: Extended wipe end-point to allow for doWipe Win CMD (#29770)
For #21979

Extended POST /api/v1/fleet/hosts/:id/wipe end-point to allow users to
specify an optional payload for specifying what type of remote wipe to
perform on Win hosts.

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2025-06-11 13:56:07 -04:00
Lucas Manuel Rodriguez
1c5700a8c4
Microsoft Compliance Partner backend changes (#29540)
For #27042.

Ready for review, just missing integration tests that I will be writing
today.

- [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/guides/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)
- [ ] Added support on fleet's osquery simulator `cmd/osquery-perf` for
new osquery data ingestion features.
- [X] If database migrations are included, checked table schema to
confirm autoupdate
- For new Fleet configuration settings
- [X] Verified that the setting can be managed via GitOps, or confirmed
that the setting is explicitly being excluded from GitOps. If managing
via Gitops:
- [X] Verified that the setting is exported via `fleetctl
generate-gitops`
- [X] Added the setting to [the GitOps
documentation](https://github.com/fleetdm/fleet/blob/main/docs/Configuration/yaml-files.md#L485)
- [X] Verified that the setting is cleared on the server if it is not
supplied in a YAML file (or that it is documented as being optional)
- [x] Verified that any relevant UI is disabled when GitOps mode is
enabled
- 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] Manual QA for all new/changed functionality

---------

Co-authored-by: jacobshandling <61553566+jacobshandling@users.noreply.github.com>
Co-authored-by: Jacob Shandling <jacob@fleetdm.com>
2025-06-11 14:22:46 -03:00
jacobshandling
c9ed0026d9
Refine query result webhook docs (#29884)
## Follow up for #29834

---------

Co-authored-by: Jacob Shandling <jacob@fleetdm.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2025-06-10 13:35:50 -07:00
Ian Littman
ecb1a51362
Add missing docs for updated_script activity (#29803)
Work was done in a previous release but (probably due to a merge
conflict resolution) the activity list update was missed, so docs were
missing this.
2025-06-06 16:38:58 -06:00
Noah Talerman
a3da8598aa
Add starter scripts for Fleet Free (#29740)
They'll show up in "No team" for Fleet Premium
2025-06-06 16:51:00 -05:00
Eric
feced94b77
Docs: Update number of hosts required for managed cloud in FAQ (#29768)
(Follow up PR to #29760) 

Changes:
- Updated the number of hosts required for managed cloud in the FAQ
2025-06-06 16:50:20 -05:00
Noah Talerman
8f86e4a73b
Building Fleet: Link to specific Node version (#29735) 2025-06-03 15:12:33 -06:00
Ian Littman
6eb6884c4f
Propagate self-service flag on uninstalls through to activity (#29691)
Fixes part of unreleased for #28846.

# 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] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements)
- [x] Added/updated automated tests
- [ ] Manual QA for all new/changed functionality
2025-06-03 09:09:43 -06:00
Ian Littman
502aa8bafb
When MDM SSO rate limit is supplied, split rate limit bucket (#29663)
Also adds some more rate limiter tests to make sure separate rate limit
buckets interact as expected.

Fixes #29614.

# 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/guides/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)
- For new Fleet configuration settings
- [x] Verified that the setting can be managed via GitOps, or confirmed
that the setting is explicitly being excluded from GitOps. (excluded;
env var or YAML)
- [x] Added/updated automated tests
- [ ] Manual QA for all new/changed functionality

---------

Co-authored-by: George Karr <georgekarrv@users.noreply.github.com>
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2025-06-02 16:18:58 -06:00
Jorge Falcon
27c37643bc
Fixing broken links for references to fleetctl-apply.md (#29661) 2025-06-01 21:48:12 -06:00
Luke Heath
3ef7caef9d
Apply starter library during new Fleet instance setup (#29564) 2025-05-30 16:27:33 -05:00
Rachael Shaw
213a5b082f
API docs: Miscellaneous minor formatting fixes (#29627)
+ For `order_direction`, use consistent `"asc"` and `"desc"` instead of
'asc', `asc`, etc.
+ Add a missing comma in an example
+ Add missing quotes for a string value in an example
2025-05-30 12:16:43 -05:00
Noah Talerman
afdfe94dd6
API docs: add missing parameters (#29446)
- Get host's software

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2025-05-30 11:05:01 -05:00
Noah Talerman
c96a40bb47
YAML reference: Auto resend macOS profiles (#29524)
- Fleet automatically resends macOS configuration profiles if
`$FLEET_VAR_` variables change
2025-05-30 10:58:04 -05:00
Noah Talerman
ea59a96b4e
YAML reference (#29465)
- Clarify which configuration profiles variables are available in Fleet
Premium
2025-05-27 17:57:56 -05:00
Noah Talerman
7cf2e2de47
[API design] Add a new timestamp for MDM check-in (#29467)
Original PR [here](https://github.com/fleetdm/fleet/pull/28940) was made
to 4.69.0 reference docs branch but the [user
story](https://github.com/fleetdm/fleet/issues/17710) was shipped in
4.68.
2025-05-27 17:33:48 -05:00
Dale Ribeiro
1eb957e165
Added example for macos_setup.enable_release_device_manually (#29479)
# 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. -->

- [ ] 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/guides/committing-changes.md#changes-files)
for more information.
- [ ] 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.
- [ ] If paths of existing endpoints are modified without backwards
compatibility, checked the frontend/CLI for any necessary changes
- [ ] If database migrations are included, checked table schema to
confirm autoupdate
- For new Fleet configuration settings
- [ ] Verified that the setting can be managed via GitOps, or confirmed
that the setting is explicitly being excluded from GitOps. If managing
via Gitops:
- [ ] Verified that the setting is exported via `fleetctl
generate-gitops`
- [ ] Added the setting to [the GitOps
documentation](https://github.com/fleetdm/fleet/blob/main/docs/Configuration/yaml-files.md#L485)
- [ ] Verified that the setting is cleared on the server if it is not
supplied in a YAML file (or that it is documented as being optional)
- [ ] Verified that any relevant UI is disabled when GitOps mode is
enabled
- For database migrations:
- [ ] Checked schema for all modified table for columns that will
auto-update timestamps during migration.
- [ ] Confirmed that updating the timestamps is acceptable, and will not
cause unwanted side effects.
- [ ] Ensured the correct collation is explicitly set for character
columns (`COLLATE utf8mb4_unicode_ci`).
- [ ] Added/updated automated tests
- [ ] Manual QA for all new/changed functionality
- For Orbit and Fleet Desktop changes:
- [ ] Make sure fleetd is compatible with the latest released version of
Fleet (see [Must
rule](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/workflows/fleetd-development-and-release-strategy.md)).
- [ ] Orbit runs on macOS, Linux and Windows. Check if the orbit
feature/bugfix should only apply to one platform (`runtime.GOOS`).
- [ ] 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)).
- [ ] For unreleased bug fixes in a release candidate, confirmed that
the fix is not expected to adversely impact load test results or alerted
the release DRI if additional load testing is needed.
2025-05-27 17:32:59 -05:00
Noah Talerman
8cd85ac5e4
Add research doc: account-driven user enrollment (#29469)
From the following research story:
- #27391
2025-05-27 15:19:56 -05:00
Dante Catalfamo
5789d3f3c9
Add macOS redis cluster support (#29433) 2025-05-27 11:38:59 -04:00
Eric
a69dfa5ee4
Update host vital queries in queries.yml (#29432)
Changes:
- Updated the host vital queries in queries.yml to have the changes from
https://github.com/fleetdm/fleet/pull/29360 and
https://github.com/fleetdm/fleet/pull/29280
2025-05-27 10:32:36 -05:00
Rachael Shaw
cbeb311b97
4.68.0 doc changes (#29393)
Documentation updates for v4.68.0

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
Co-authored-by: Scott Gress <scottmgress@gmail.com>
Co-authored-by: Ian Littman <iansltx@gmail.com>
Co-authored-by: Jahziel Villasana-Espinoza <jahziel@fleetdm.com>
Co-authored-by: Eugene <eugene@fleetdm.com>
Co-authored-by: dantecatalfamo <dante.catalfamo@gmail.com>
Co-authored-by: Konstantin Sykulev <konst@sykulev.com>
Co-authored-by: Luke Heath <luke@fleetdm.com>
2025-05-22 16:20:56 -05:00
Jordan Montgomery
149cd9daca
Tweak MDM detection query to return the proper enrollment when there are multiple entries (#29360)
This change is deceptively simple but helps us choose the right one in
cases like #29042 where there are multiple enrollments in the registry.
In this case the customer seems to have been using something like
co-management(though even using their MDM we have not repro'd
internally) which leads to 2 registry keys in the registry with a UPN
node. I believe the way some MDM services handle unenroll can also leave
the registry keys in this state. Either way, because of this, and the
fact that we have a LIMIT 1 in the query, we were, in 50% of the cases
where we had multiple keys, returning the less useful of the nodes from
the query and because no Server URL was coming back we were treating it
as if the host was not MDM enrolled and thus, not unenrolling it, and
leading to enrollment failing.

With this change we'll return the proper registry key which should allow
us to, in the case of migration, properly unenroll the host and even in
the case where a customer isn't using Fleet MDM will allow us to display
the correct information from the registry.

# 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/guides/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] Manual QA for all new/changed functionality
2025-05-22 14:08:05 -04:00
Janis Watts
8b64e498de
Update Kinesis testing steps (#29370) 2025-05-22 12:07:06 -05:00
Rachael Shaw
97bb6a124b
API docs: Clarify software install statuses (#29203)
Clarify options for software install status filters on "List hosts"
endpoint.

---------

Co-authored-by: Ian Littman <iansltx@gmail.com>
2025-05-21 10:21:54 -05:00
Konstantin Sykulev
a42167462f
Added SHA256 hash from mac apps on install paths (#29280)
https://github.com/fleetdm/fleet/issues/25545

- [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/guides/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)
- [ ] Added support on fleet's osquery simulator `cmd/osquery-perf` for
new osquery data ingestion features.
- [x] Added/updated automated tests
- [x] Manual QA for all new/changed functionality
- For Orbit and Fleet Desktop changes:
- [ ] Make sure fleetd is compatible with the latest released version of
Fleet (see [Must
rule](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/workflows/fleetd-development-and-release-strategy.md)).
- [x] Orbit runs on macOS, Linux and Windows. Check if the orbit
feature/bugfix should only apply to one platform (`runtime.GOOS`).
- [x] 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)).
2025-05-20 23:38:59 -05:00
Dale Ribeiro
168d41a773
Update rest-api with additional_queries correction.md (#29184)
The additional_queries property in the modify configuration endpoint is
not a boolean. It should be an object that contains a key/value pair
with the name of the query and the query itself. I updated the
description and example to reflect this and match what we have in our
GitOps docs: https://fleetdm.com/docs/configuration/yaml-files#features

# 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. -->

- [ ] 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.
- [ ] 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.
- [ ] If paths of existing endpoints are modified without backwards
compatibility, checked the frontend/CLI for any necessary changes
- [ ] If database migrations are included, checked table schema to
confirm autoupdate
- For database migrations:
- [ ] Checked schema for all modified table for columns that will
auto-update timestamps during migration.
- [ ] Confirmed that updating the timestamps is acceptable, and will not
cause unwanted side effects.
- [ ] Ensured the correct collation is explicitly set for character
columns (`COLLATE utf8mb4_unicode_ci`).
- [ ] Added/updated automated tests
- [ ] Manual QA for all new/changed functionality
- For Orbit and Fleet Desktop changes:
- [ ] Make sure fleetd is compatible with the latest released version of
Fleet (see [Must
rule](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/fleetd-development-and-release-strategy.md)).
- [ ] Orbit runs on macOS, Linux and Windows. Check if the orbit
feature/bugfix should only apply to one platform (`runtime.GOOS`).
- [ ] 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)).
- [ ] For unreleased bug fixes in a release candidate, confirmed that
the fix is not expected to adversely impact load test results or alerted
the release DRI if additional load testing is needed.
2025-05-20 13:13:25 -05:00
Luke Heath
030c61ca17
Update contrib docs headers to sentence case (#29276) 2025-05-20 11:26:35 -05:00
Victor Lyuboslavsky
396a3f2edc
Fixed/updated SCIM contributor guide. (#29257) 2025-05-19 11:29:36 -05:00
Luke Heath
7380919dc3
Organize contributor docs and establish ADR process and template (#29101) 2025-05-17 15:03:52 -05:00
Gabe Lopez
9132627c89
Update Testing-and-local-development.md (#28892) 2025-05-16 10:15:21 -05:00
Eric
27b8dbd585
Docs: Update macOS software host vital query (#29139)
Changes:
- Updated the macOS software host vital query
2025-05-15 18:26:35 -05:00
Harrison Ravazzolo
2d5219b447
clarifying section of webhooks (#29168)
Adding a clarification note to the documentation for gitops

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2025-05-15 16:49:46 -05:00
Jordan Moore
503a6b5e76
Documentation updates to Gitops sso_settings section (#29110)
Documentation updates to flip-flop the descriptions for
`enable_jit_provisioning` and `enable_sso_idp_login`
2025-05-15 15:09:02 -05:00
Victor Lyuboslavsky
7c8710996e
Research doc for Apple user channel. (#29016) 2025-05-14 11:20:02 -05:00
Ian Littman
3edf684db1
Add backend for uninstalls in My device UI (#29035)
For #28846. Intentionally not limited to self-service/in-scope apps,
though we don't have any software listing changes in this PR to show
more titles in the self-service list.

QA plan is a bit light due to ticket being underspec'd. Can figure out
how we deal with that later.

# 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] Added/updated automated tests
- [ ] 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-05-13 12:14:45 -05:00
Katheryn Satterlee
9ea5ecde68
Add neon to Linux platform list (#28977)
Added `neon` to list of Linux platforms associated with hosts so that
Linux-specific detail queries and policies will be sent to hosts running
the XDE Neon operating system.

This does not guarantee full compatibility with Neon, but will improve
telemetry.

Resolves #28560 


# 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] Added/updated automated tests
- [ ] 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)
- [ ] Manual QA for all new/changed functionality
2025-05-12 17:37:21 -05:00
Eric
1f0c723589
Docs: Fix urls of two images on SSO page (#28990)
Closes: #28972

Changes:
- Fixed two broken image URLs on the SSO documentation page.
2025-05-08 17:30:28 -05:00
Victor Lyuboslavsky
6f9030ee3c
SCIM Entra ID support (#28832)
For #28196

This PR adds full patching for SCIM Users and Groups, and adds the
ability to filter Groups by displayName.

The changes have been tested with [Entra ID SCIM
Validator](67dfd91c0c/docs/Contributing/SCIM-integration.md (entra-id-integration))
and Okta SCIM 2.0 SPEC Test (to make sure we didn't break Okta).

# Checklist for submitter
- [x] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
- [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-05-08 13:02:49 -05:00
Martin Angers
48de857dca
BRP: add batch-resend profile to hosts endpoint based on status (#28871) 2025-05-07 16:48:18 -04:00
Mike Thomas
e92feb17b7
Update single-sign-on-sso.md (#28193)
I've updated this section to include information about SCIM as per this
[website request](https://github.com/fleetdm/fleet/issues/27971) from a
Fleet contributor.

Please confirm that I have understood correctly and that this is
accurate.

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2025-05-07 15:47:12 -05:00
Mike Thomas
a91042ae02
Update queries.yml (#28897)
uppercase 'S' was breaking the query.
2025-05-07 14:48:08 -05:00
Noah Talerman
7262c6ed0a
GitOps reference (#28877)
- Learned during NYC GitOps training that it's more intuitive to
explicitly set `macos_updates.deadline` to a string
- I think let's pick one of single quotes or double quotes and be
consistent: let's go with double quotes
2025-05-06 16:44:53 -05:00
jacobshandling
55bacd830c
Add link to mocks README (#28382) 2025-05-06 15:58:21 -05:00
Victor Lyuboslavsky
3d3d43864a
Bumping MySQL 8.4.3->8.4.5 and 9.1.0->9.3.0 in tests. (#28767)
I forced a test run on 9.3.0 (which only runs nightly be default).
2025-05-02 13:40:11 -05:00
Marko Lisica
64152febc9
[Docs update] Call out that mdm.macos_setup in config and team endpoint is set only by GitOps (#28695)
Called out that `mdm.macos_setup` in GET config and GET team is only set
by YAML files.

Related to: 

- #28497
2025-05-01 13:59:09 -04:00
Victor Lyuboslavsky
f831318c85
Documenting POC investigation for account-driven user enrollment (#28661)
For #27391
2025-04-30 13:08:25 -05:00
Noah Talerman
e4bbe185a8
Update reference docs/guides: reset automations (#28677)
Update guides to clarify current behavior and best practice.

More context here:
https://github.com/fleetdm/fleet/issues/28611#issuecomment-2841952742
2025-04-30 13:00:00 -05:00
Dale Ribeiro
d51c8324fb
Added update custom device mapping (#28654)
# 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. -->

- [ ] 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.
- [ ] 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.
- [ ] If paths of existing endpoints are modified without backwards
compatibility, checked the frontend/CLI for any necessary changes
- [ ] If database migrations are included, checked table schema to
confirm autoupdate
- For database migrations:
- [ ] Checked schema for all modified table for columns that will
auto-update timestamps during migration.
- [ ] Confirmed that updating the timestamps is acceptable, and will not
cause unwanted side effects.
- [ ] Ensured the correct collation is explicitly set for character
columns (`COLLATE utf8mb4_unicode_ci`).
- [ ] Added/updated automated tests
- [ ] 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)
- [ ] Manual QA for all new/changed functionality
- For Orbit and Fleet Desktop changes:
- [ ] Make sure fleetd is compatible with the latest released version of
Fleet (see [Must
rule](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/fleetd-development-and-release-strategy.md)).
- [ ] Orbit runs on macOS, Linux and Windows. Check if the orbit
feature/bugfix should only apply to one platform (`runtime.GOOS`).
- [ ] 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)).
- [ ] For unreleased bug fixes in a release candidate, confirmed that
the fix is not expected to adversely impact load test results or alerted
the release DRI if additional load testing is needed.

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2025-04-30 12:59:08 -05:00
Rachael Shaw
ba89eca450
Docs: Update note about human-device mapping endpoints (#28665)
We added the "Edit" endpoint back to the docs.
2025-04-29 16:28:43 -05:00
Dale Ribeiro
d3cab6fa7c
Updated human-device mapping deprecation info (#28653)
# 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. -->

- [ ] 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.
- [ ] 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.
- [ ] If paths of existing endpoints are modified without backwards
compatibility, checked the frontend/CLI for any necessary changes
- [ ] If database migrations are included, checked table schema to
confirm autoupdate
- For database migrations:
- [ ] Checked schema for all modified table for columns that will
auto-update timestamps during migration.
- [ ] Confirmed that updating the timestamps is acceptable, and will not
cause unwanted side effects.
- [ ] Ensured the correct collation is explicitly set for character
columns (`COLLATE utf8mb4_unicode_ci`).
- [ ] Added/updated automated tests
- [ ] 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)
- [ ] Manual QA for all new/changed functionality
- For Orbit and Fleet Desktop changes:
- [ ] Make sure fleetd is compatible with the latest released version of
Fleet (see [Must
rule](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/fleetd-development-and-release-strategy.md)).
- [ ] Orbit runs on macOS, Linux and Windows. Check if the orbit
feature/bugfix should only apply to one platform (`runtime.GOOS`).
- [ ] 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)).
- [ ] For unreleased bug fixes in a release candidate, confirmed that
the fix is not expected to adversely impact load test results or alerted
the release DRI if additional load testing is needed.
2025-04-29 14:27:23 -05:00
Victor Lyuboslavsky
eac6ccb4e4
Contributor docs for bootstrap pkg (#28609) 2025-04-28 15:36:38 -05:00
Jordan Montgomery
a7967a398c
Update DigiCert integration contributor doc for renewal (#28517)
Updates contributor doc based on recently merged DigiCert renewal
changes

I'm not sure if leaving the "admin" on that last mermaid doc was the
right thing to do but I wanted to make it clear this all happens
automatically without admin intervention once setup
2025-04-28 11:30:56 -04:00
Ian Littman
94b3761bfb
Sync docs (#28582) 2025-04-28 10:08:30 -05:00
Rachael Shaw
7ae8b9a3da
Documentation changes for v4.67.0 (#28528)
Docs for the 4.67.0 release.

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
Co-authored-by: Eugene <eugene@fleetdm.com>
Co-authored-by: Ian Littman <iansltx@gmail.com>
Co-authored-by: Drew Baker <89049099+Drew-P-drawers@users.noreply.github.com>
Co-authored-by: Scott Gress <scottmgress@gmail.com>
Co-authored-by: Lucas Manuel Rodriguez <lucas@fleetdm.com>
Co-authored-by: Martin Angers <martin.n.angers@gmail.com>
2025-04-24 16:10:41 -05:00
Ian Littman
49c49c7433
Implement self-service install status endpoints (#28424)
For #28411.

# 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] 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-04-24 12:20:21 -05:00
Rachael Shaw
0c95e92b5a
Revert changes to batch-run script docs
Merged into wrong branch; for 4.68
2025-04-22 18:08:32 -05:00
Rachael Shaw
13b9b885c1
Bulk script doc spruce up (#28471)
Move around some parameters and mark `script_id` required

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
Co-authored-by: Scott Gress <scottmgress@gmail.com>
Co-authored-by: Ian Littman <iansltx@gmail.com>
Co-authored-by: Jahziel Villasana-Espinoza <jahziel@fleetdm.com>
2025-04-22 18:02:54 -05:00
Rachael Shaw
b1ea8dd757
Rename "Get host's scripts" -> "List host's scripts" (#28470)
Keeps the naming consistent.
2025-04-22 17:42:21 -05:00
Rachael Shaw
39ca7a1856
REST API docs: Move "Get host's scripts" under "Scripts" heading (#28469) 2025-04-22 17:38:55 -05:00
Noah Talerman
c4bf51e9a1
API docs: Bulk => batch (#28460)
Batch run script API coming soon...

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2025-04-22 17:32:30 -05:00
Rachael Shaw
9404dafbea
Docs: Update bulk transfer/delete hosts formatting (filters in a separate table) (#28457)
Move `filters` parameter into its own table to make it easier to
understand what the available filters are.
2025-04-22 15:49:56 -05:00
Raiven
42a847d076
docs: Update Adding-new-endpoints.md (#28377)
# 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. -->

- [ ] 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.
- [ ] 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.
- [ ] If paths of existing endpoints are modified without backwards
compatibility, checked the frontend/CLI for any necessary changes
- [ ] If database migrations are included, checked table schema to
confirm autoupdate
- For database migrations:
- [ ] Checked schema for all modified table for columns that will
auto-update timestamps during migration.
- [ ] Confirmed that updating the timestamps is acceptable, and will not
cause unwanted side effects.
- [ ] Ensured the correct collation is explicitly set for character
columns (`COLLATE utf8mb4_unicode_ci`).
- [ ] Added/updated automated tests
- [ ] 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)
- [ ] Manual QA for all new/changed functionality
- For Orbit and Fleet Desktop changes:
- [ ] Make sure fleetd is compatible with the latest released version of
Fleet (see [Must
rule](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/fleetd-development-and-release-strategy.md)).
- [ ] Orbit runs on macOS, Linux and Windows. Check if the orbit
feature/bugfix should only apply to one platform (`runtime.GOOS`).
- [ ] 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)).
- [ ] For unreleased bug fixes in a release candidate, confirmed that
the fix is not expected to adversely impact load test results or alerted
the release DRI if additional load testing is needed.
2025-04-21 10:11:02 -05:00
Noah Talerman
1393d7bcd9
Puppet module: remove guide and update docs (#28335)
We don't think anyone is using it so we want to remove it in Fleet 5
(next major version).

- More context here: https://github.com/fleetdm/fleet/issues/28334
2025-04-18 16:47:11 -04:00
Mike Thomas
3d9958df66
add-button-ids-to-deploy-docs (#28319)
I'm testing out user behavior in HotJar. Need to add some IDs to buttons
to properly track and test.
2025-04-18 11:19:56 -05:00
Victor Lyuboslavsky
ce9467070e
Move backend patterns.md to docs/Contributing (#28243)
As discussed in a recent Backend sync, moving patterns.md to
docs/Contributing
2025-04-16 13:36:14 -05:00
Noah Talerman
f4ffaf0d07
GitOps reference: add links for configuration profile variables (#28260)
Link to GitLab and Apple docs
2025-04-15 14:39:01 -05:00
Marko Lisica
57d73fcd6c
End user authentication wasn't documented as subsection of MDM under PATCH /config endpoint (#28244)
`end_user_authentication` isn't documented as all other endpoints under
`mdm` in `PATCH /config` endpoint.

I also removed `issuer_uri` as this isn't implemented to this endpoint.

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2025-04-15 20:00:05 +02:00
Jahziel Villasana-Espinoza
fa8c087abf
fix: change how macOS software names are calculated to avoid erroneous duplicates (#28037)
> For #24087 

# 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] Added support on fleet's osquery simulator `cmd/osquery-perf` for
new osquery data ingestion features.
- [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] 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-04-11 19:19:07 -04:00
Katheryn Satterlee
801d97f496
Update Upgrading-Fleet.md (#28112)
Add clear language around the requirement for Fleet to be offline during
the upgrade process.
2025-04-11 17:32:08 -05:00
Adam Anklewicz
c8d9dd81dc
Update yaml-files.md (#28028)
Received an error from GitHub Actions stating it was expecting a string
and got a number. Added quotes and it worked. Changing the documentation
to match.
2025-04-11 17:31:12 -05:00
Noah Talerman
dce7bbe48b
API reference: add missing yara_rules to PATCH /config (#27976)
Based on community feedback here:
https://github.com/fleetdm/fleet/issues/27569#issuecomment-2775322232
2025-04-11 17:10:56 -05:00
Jordan Montgomery
0ffdc14596
Update Autopilot testing info (#28125)
Updates the relevant Contributing doc based on what Gabe and I learned
while testing Autopilot
2025-04-11 14:31:02 -04:00
Rachael Shaw
06f8ed8f3b
Update labels API docs (#28119)
Improvements/fixes for manual label documentation.

Follow-up from this old draft PR:
https://github.com/fleetdm/fleet/pull/23589

---------

Co-authored-by: gillespi314 <73313222+gillespi314@users.noreply.github.com>
2025-04-11 09:17:13 -05:00
jacobshandling
bc6dc21ac9
Add host id to fleet enrolled activity (#28068)
## For #26695 

<img width="1795" alt="Screenshot 2025-04-09 at 7 25 25 PM"
src="https://github.com/user-attachments/assets/edeb5c51-9643-4fe0-8171-0400f513373f"
/>


- [x] Changes file added for user-visible changes in `changes/`
- [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

---------

Co-authored-by: Jacob Shandling <jacob@fleetdm.com>
2025-04-10 13:50:14 -07:00
Eric
747af2247b
Update query for "Software codesign" vital (#28092)
Changes:
- Updated the query for the "Software codesign" host vital. (The vital
was incorrectly using the same query as the "Software (macOS)" host
vital)
2025-04-10 15:02:05 -05:00
Martin Angers
00149cb5a9
Cancel upcoming activities: create past canceled activities (#27956) 2025-04-09 16:08:51 -04:00
Rachael Shaw
4cff3790be
Mark DigiCert and custom SCEP CA experimental (#27988)
@marko-lisica's previous PR: https://github.com/fleetdm/fleet/pull/27724
(needed to change base branch to `main` because `docs-v4.66.0` was
merged).
2025-04-09 16:08:40 -04:00
Victor Lyuboslavsky
087d7209fe
Updated SSO user contributing docs. (#27981)
For #27284
2025-04-08 10:53:58 -05:00
Victor Lyuboslavsky
3d0025c570
SCIM + host integration (#27880)
For #27284

This PR:
- Adds SCIM as a fallback for username during macOS end user
authentication during setup experience
- Adds SCIM/endUsers details to host details

# Checklist for submitter
- [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] 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-04-08 09:35:06 -05:00
Allen Houchins
c57fc2d03e
Fixed policy check for macOS - Disable guest account (#27531)
I created and tested the fix before seeing the [comment in this
issue](https://github.com/fleetdm/fleet/issues/24417).

Feel free to merge the fix or close this out but I made this pull
request since we had another customer report this issue today.
2025-04-08 08:52:05 -05:00
Rachael Shaw
76cab7fdba
Add missing commas in example response (#27964) 2025-04-07 20:04:32 -05:00
Victor Lyuboslavsky
0f65252517
Fixed wrong API verb. (#27954)
For #27284
2025-04-07 18:47:11 -05:00
Mike McNeil
8452eff7f0
Apple Intelligence enabled? (#27866)
Add Allen's Apple Intelligence check to the policy library so that any
user can import/copy+paste and use it directly without writing SQL.


https://www.linkedin.com/posts/allenhouchins_fleet-it-infosec-activity-7257454593012322304-yvek

---------

Co-authored-by: Allen Houchins <allenhouchins@mac.com>
Co-authored-by: Eric <eashaw@sailsjs.com>
2025-04-07 18:40:37 -05:00
Dale Ribeiro
33eb54d013
Update single-sign-on-sso.md (#27784)
# 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. -->

- [ ] 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.
- [ ] 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.
- [ ] If paths of existing endpoints are modified without backwards
compatibility, checked the frontend/CLI for any necessary changes
- [ ] If database migrations are included, checked table schema to
confirm autoupdate
- For database migrations:
- [ ] Checked schema for all modified table for columns that will
auto-update timestamps during migration.
- [ ] Confirmed that updating the timestamps is acceptable, and will not
cause unwanted side effects.
- [ ] Ensured the correct collation is explicitly set for character
columns (`COLLATE utf8mb4_unicode_ci`).
- [ ] Added/updated automated tests
- [ ] 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)
- [ ] Manual QA for all new/changed functionality
- For Orbit and Fleet Desktop changes:
- [ ] Make sure fleetd is compatible with the latest released version of
Fleet (see [Must
rule](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/fleetd-development-and-release-strategy.md)).
- [ ] Orbit runs on macOS, Linux and Windows. Check if the orbit
feature/bugfix should only apply to one platform (`runtime.GOOS`).
- [ ] 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)).
- [ ] For unreleased bug fixes in a release candidate, confirmed that
the fix is not expected to adversely impact load test results or alerted
the release DRI if additional load testing is needed.

---------

Co-authored-by: Brock Walters <153771548+nonpunctual@users.noreply.github.com>
2025-04-04 18:04:18 -05:00
Allen Houchins
97c9b651e1
Update fleet-server-configuration.md (#27868)
Fixed typo
2025-04-04 17:44:19 -05:00
Lucas Manuel Rodriguez
5c7599764d
Run make generate-doc (#27911)
This will fix CI on `main`.
2025-04-04 16:27:09 -05:00
Ian Littman
65ba89e60c
Update FMA docs to include Windows + current instructions/impl details (#27828)
For #26716.

Also moves the article to an OS-independent URL, updates links from
elsewhere, and adds a bit more internal-link juice for install
automation.

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2025-04-04 14:55:27 -05:00
Rachael Shaw
c592c2b24e
Docs v4.66.0 (#27844)
Documentation changes for the 4.66.0 release.

---------

Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
Co-authored-by: Marko Lisica <markol.lisica@gmail.com>
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Victor Lyuboslavsky <victor@fleetdm.com>
Co-authored-by: George Karr <georgekarrv@users.noreply.github.com>
Co-authored-by: RachelElysia <71795832+RachelElysia@users.noreply.github.com>
Co-authored-by: Ian Littman <iansltx@gmail.com>
Co-authored-by: Eugene <eugene@fleetdm.com>
Co-authored-by: Victor Lyuboslavsky <victor.lyuboslavsky@gmail.com>
Co-authored-by: Scott Gress <scottmgress@gmail.com>
Co-authored-by: Dante Catalfamo <43040593+dantecatalfamo@users.noreply.github.com>
2025-04-04 14:28:09 -05:00
Victor Lyuboslavsky
61a7b70b5d
SCIM integration tests (#27750)
For #27287

This PR adds integration tests for SCIM API endpoints as well as some
bug fixes found by these tests.

# Checklist for submitter

- [x] Added/updated automated tests
- [x] Manual QA for all new/changed functionality
2025-04-04 11:00:46 -05:00
Luke Heath
28232b5c11
Update API-Versioning.md (#27855) 2025-04-04 10:34:27 -05:00
George Karr
28a82b19c9
Create certs.md (#27013) 2025-04-03 14:19:00 -05:00
Eric
dd06b2a414
Docs: Remove "Time and date are configured to be updated automatically (macOS)" policy (#27788)
Closes: #27460

Changes:
- Removed the "Time and date are configured to be updated automatically
(macOS)" policy from the standard query library yaml. The policy checks
a value that can only be set on iOS devices
(https://developer.apple.com/documentation/devicemanagement/restrictions#:~:text=forceAutomaticDateAndTime).
2025-04-02 16:30:49 -05:00
Scott Gress
fc3cd3b33f
Add docs for upgrading Go (#27693)
For #27605 

Adds a guide to the contributor docs about how to upgrade the Go version
used to build Fleet.
2025-04-02 15:30:32 -05:00
Victor Lyuboslavsky
15c84b67f7
Added contributing docs for end user authentication. (#27690)
For #23236
2025-04-02 13:03:52 -05:00
Victor Lyuboslavsky
2801eab201
Tweaks to high level Fleet diagram. (#27749) 2025-04-02 11:34:51 -05:00
Victor Lyuboslavsky
2198fd8d65
Add SCIM Users (#27551)
For #27287

Video explaining the PR: https://www.youtube.com/watch?v=ZHgFUAvrPEI

This PR adds SCIM Users support for Okta. The goal is to first add
Users/Groups support so that the remaining backend SCIM work can be done
in parallel.

This PR does not include the following, which will be added in later PRs
- Changes file
- Groups support for Okta
- Full support for Entra ID
- Integration tests

# Checklist for submitter

- [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-04-01 11:02:24 -05:00
Victor Lyuboslavsky
ea8b81993e
Updating DigiCert/SCEP contributor docs. (#27625) 2025-03-31 13:50:05 -05:00
Scott Gress
59f96651b6
Update to Go 1.24.1 (#27506)
For #26713 

# Details

This PR updates Fleet and its related tools and binaries to use Go
version 1.24.1.

Scanning through the changelog, I didn't see anything relevant to Fleet
that requires action. The only possible breaking change I spotted was:

> As [announced](https://tip.golang.org/doc/go1.23#linux) in the Go 1.23
release notes, Go 1.24 requires Linux kernel version 3.2 or later.

Linux kernel 3.2 was released in January of 2012, so I think we can
commit to dropping support for earlier kernel versions.

The new [tools directive](https://tip.golang.org/doc/go1.24#tools) is
interesting as it means we can move away from using `tools.go` files,
but it's not a required update.

# 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`.
- [x] Manual QA for all new/changed functionality
- For Orbit and Fleet Desktop changes:
- [X] Make sure fleetd is compatible with the latest released version of
Fleet
   - [x] Orbit runs on macOS  , Linux   and Windows. 
- [x] Manual QA must be performed in the three main OSs, macOS ,
Windows and Linux .
2025-03-31 11:14:09 -05:00
Eric
ac390757f9
Docs: update title meta tag & h1 on yaml-files page (#27519)
Closes: #26503

Changes:
- Updated the heading and `<meta>` title of the yaml-files.md
documentation page to be "GitOps" (Note: the URL will not change)
2025-03-27 10:45:30 -05:00
Eric
f351cb2820
Docs: Break tutorials and guides page into two sections (#27521)
Closes: #27261

Changes:
- Updated the tutorials-and-guides docs page to have two lists of
guides: "Get set up" and "Further learning"
2025-03-26 16:46:13 -05:00
RachelElysia
c7e243d618
Fleet docs: Fix spelling and grammar (#27528)
## Description
- Documentation spelling and grammar fixes
2025-03-26 16:45:23 -05:00
Victor Lyuboslavsky
23a55cc1aa
Update MDM-Android.md -- improve class diagram display (#27538) 2025-03-26 13:09:49 -05:00
Eric
11d7f51b7f
Docs: Update vitals in queries.yml (#27373)
Closes: https://github.com/fleetdm/confidential/issues/10005

Changes:
- Updated the vitals in docs/queries.yml to have the latest changes from
docs/contributing/understanding-host-vitals.md (updated the software
vitals for Windows and macOS, added the host certificate vital, added
two python packages vitals)
2025-03-24 11:41:05 -05:00
Benjamin Edwards
c6178c64cd
add configuration setting for forcing h2c (#26799) 2025-03-21 09:38:21 -04:00
Lucas Manuel Rodriguez
e6cb16453e
Added more logging for troubleshooting of software package installation (#27291)
For #27234.

- Improved logging in orbit to help us during troubleshooting.
- Added some documentation on how to grep for errors related to software
package installation in orbit.
- Added `took` to server request error logs (it was only present when
the request succeeds).

---

- [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] 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
- For Orbit and Fleet Desktop changes:
- [x] Make sure fleetd is compatible with the latest released version of
Fleet (see [Must
rule](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/fleetd-development-and-release-strategy.md)).
- [x] Orbit runs on macOS, Linux and Windows. Check if the orbit
feature/bugfix should only apply to one platform (`runtime.GOOS`).
- [x] Manual QA must be performed in the three main OSs, macOS, Windows
and Linux.
- [x] Auto-update manual QA, from released version of component to new
version (see [tools/tuf/test](../tools/tuf/test/README.md)).
2025-03-20 11:09:57 -03:00
Mike McNeil
21dfccc655
Update fleet-server-configuration.md (#27313) 2025-03-19 15:09:34 -05:00
Mike McNeil
aa73c0dfd2
Update deploy-fleet.md (#27311) 2025-03-19 15:09:05 -05:00
Marko Lisica
84892741dd
Merge Android docs changes (#27221)
Related to: 

- #23231
2025-03-19 10:03:02 -05:00
Victor Lyuboslavsky
6b7d232522
Additional CA validation (#27169)
For #26623

- Updated `github.com/groob/plist` to `github.com/micromdm/plist` -- it
was renamed
- Added validation that restricts DigiCert Fleet variables to
`com.apple.security.pkcs12` payloads plus additional restrictions
- Added validation that restricts Custom SCEP Fleet variables to
`com.apple.security.scep` payloads plus additional restrictions
- Enabled multiple CAs (Fleet variables) to be present in an Apple MDM
profile. But each CA can only be used once. For example, we can have
DigiCert CA and Custom SCEP CA in one Apple profile.

# Checklist for submitter
- [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-03-19 08:27:55 -05:00
Noah Talerman
ac9072ab95
API reference (#27197)
Do we need the “by ID”? I wonder if we could pull that out (less words
and it’s consistent with other endpoints)
2025-03-17 13:44:48 -05:00
Jorge Falcon
9affceb6d1
Typo fix in agent-configuration.md (#27148)
Fixing typo on L3. 
- "fleed" -> "fleetd"
2025-03-17 12:33:17 -05:00
Victor Lyuboslavsky
131a52695b
Custom SCEP integration (#27121)
For #26623 

This PR enables deploying an Apple configuration profile with Fleet
proxying a custom SCEP server.

# Checklist for submitter

- [x] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
- [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-03-17 10:59:07 -05:00
Jahziel Villasana-Espinoza
d0f70c5980
fix: report a failure in setup experience if a VPP app installation fails due to lack of licenses (#27163)
> For #26345

# 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] 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-03-17 09:43:51 -04:00
Rachael Shaw
3679471a99
API docs: Combine policies and team policies (#27167)
Document all policies API endpoints under "Policies" instead of having 2
separate sections:

![Screenshot 2025-03-14 at 4 51
44 PM](https://github.com/user-attachments/assets/96546c23-dea9-41cd-8ef9-ad692a6667fb)


Also renamed "Remove policy" to "Delete policy" to make language more
consistent w/ other endpoints.
2025-03-14 16:54:03 -05:00
Lucas Manuel Rodriguez
46c9f9a37b
Fix auto generated docs on main (#27165)
Ran `make generate-doc`.
2025-03-14 17:41:57 -03:00
Rachael Shaw
990322321d
Documentation changes for v4.65.0 (#27108)
Documentation changes for the 4.65.0 release

---------

Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Sarah Gillespie <73313222+gillespi314@users.noreply.github.com>
Co-authored-by: Ian Littman <iansltx@gmail.com>
Co-authored-by: Eric <eashaw@sailsjs.com>
Co-authored-by: Janis Watts <184028114+jmwatts@users.noreply.github.com>
Co-authored-by: Victor Lyuboslavsky <victor@fleetdm.com>
2025-03-14 14:54:48 -05:00
Rachael Shaw
3333139496
Small indentation fix in API docs (#27158) 2025-03-14 14:31:10 -05:00
Ian Littman
1537eb710f
Revise discovery queries for Python software inventory to be compatible with earlier versions of osquery (#27130) 2025-03-13 17:32:06 -06:00
Noah Talerman
76071505ff
YAML reference docs: custom targets (labels) is Premium only (#27109) 2025-03-13 16:51:54 -05:00
Teffen Ellis
f61c8e8800
Add instructions for single sign-on via authentik. (#27079)
Hi Fleet team!

I'm an engineer at authentik and I've been working on a guide to help
our users integrate Fleet with authentik as an identity provider. While
our own documentation is still in progress, I wanted to contribute this
guide to the Fleet documentation to help our users get started with SSO.

This PR expands Fleet's Single Sign-on guide to include a section for
[authentik](https://goauthentik.io) as an identity provider.

Please let me know if I can provide any additional information or make
any changes to this PR.

Thank you for considering this contribution!
2025-03-12 13:55:12 -05:00
Martin Angers
e7d6a36c2c
Add contributor doc explaining the upcoming activities queue (#27071) 2025-03-12 11:55:56 -04:00
Mike McNeil
97696ccdca
Update deploy-fleet.md (#26935)
Remove settings that aren't minimally required to make it simpler to
follow along


@rfairburn @edwardsb @lukeheath Y'all, please stop me if this is a bad
idea.
2025-03-11 15:35:51 -05:00
Marko Lisica
17904525ab
Remove GET /api/v1/fleet/vpp (deprecated and not working) (#27023)
I found that `GET /api/v1/fleet/vpp` isn't working, but is still
documented. I believe we moved to new endpoint to manage VPP tokens:
`GET /api/v1/fleet/vpp_tokens`
2025-03-11 15:34:44 -05:00
Victor Lyuboslavsky
0f3a76dd27
Add DigiCert integration dev docs. (#27039)
For #25822
2025-03-11 15:33:44 -05:00
Mike Thomas
5c8c0422fe
Add license key details to deploy docs (#26985)
Closes https://github.com/fleetdm/confidential/issues/9461

- Add license key details to deploy docs.

Co-authored-by: Brock Walters <153771548+nonpunctual@users.noreply.github.com>
2025-03-11 07:06:52 +09:00
Noah Talerman
e4ef8cc6db
YAML reference docs (#27000)
- Fix quotes
- `macos_settings` is for all Apple platforms Fleet supports: #26096
2025-03-10 13:43:23 -05:00
Noah Talerman
273601d695
Agent configuration reference docs (#26999)
- Remove rotate enroll secret instructions because they're wrong: #25755
- Update contributor docs to simplify: #24309

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2025-03-10 13:36:44 -05:00
Victor Lyuboslavsky
683c93f99f
Android architecture docs (#26975)
For #23231

---------

Co-authored-by: Martin Angers <martin.n.angers@gmail.com>
2025-03-10 13:01:57 -05:00
jacobshandling
1268036c1f
23971 Proposed API and schema changes (#25013)
## For #25034

### API changes:
[this PR diff](https://github.com/fleetdm/fleet/pull/25013/files)
("available_teams" change is adding missing documentation for current
API behavior)

### schema changes:
- new col in `users` table, `settings`, type `json`. Defaults to `{}`.
New setting, `hidden_host_columns`, added or updated on first relevant
API call per user.

### semantics

- **null** `"hidden_host_columns"` field means "not yet set, use
defaults": `{"settings":{"hidden_host_columns": null}}`
- **included and empty** `"hidden_host_columns"` field means "no columns
hidden, show all columns in the UI":
`{"settings":{"hidden_host_columns": []}}`

### Updates 1/7/25 per discussion with @rachaelshaw @lucasmrod
@sgress454:
- Optional query param `include_ui_settings=true` included with `GET`s
to `/me` or `/users/:id` will trigger considering the API call to be a
contributor API call, giving more flexibility for future changes. Note
that this is the first time we have one endpoint that can be
conditionally considered a contributor endpoint depending on how it is
called.

---------

Co-authored-by: Jacob Shandling <jacob@fleetdm.com>
2025-03-10 10:17:57 -07:00
George Karr
4b3e2a0f69
Create design-qa-considerations.md (#26774)
Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Sam Pfluger <108141731+Sampfluger88@users.noreply.github.com>
2025-03-07 15:32:41 -06:00
Ian Littman
014f10fb46
Add experimental software title name update endpoint for titles with a bundle ID (#26938)
For #26933.

# 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] 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

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2025-03-07 11:36:17 -06:00
Eugene
31191689e8
Update yaml-files.md (#26781)
Cleaning up and standardizing use of quotations in YAML.

1. Updated to use single quotes
2. Updated to use double quotes to enclose single quote references.
3. Removed extraneous quotes around strings.
2025-03-06 17:34:44 -06:00
Rachael Shaw
f229230ada
API docs: Indentation fix in get config example (#26916) 2025-03-06 14:00:33 -06:00
Rachael Shaw
4c5aa74434
Update license in GET /config example (#26915)
Include premium license fields
2025-03-06 13:53:33 -06:00
Gabe Lopez
f51bb7c7ea
Add files via upload to replace old screenshot for SSO config (#26841)
Replacing an old screenshot for SSO-Setup that removes the `issuer URI`
field that is no longer needed nor available in Fleet

---------

Co-authored-by: Eric <eashaw@sailsjs.com>
2025-03-06 13:28:57 -06:00
Drew Baker
72b7c59545
Update tutorials-and-guides.md (#26900)
Adjusting the order to test the performance change of
https://fleetdm.com/guides/mdm-migration if it is moved to the top of
/guides

Context:

https://app.zenhub.com/workspaces/help-marketing-64e6c8e2d35c7f001a457b7f/issues/gh/fleetdm/confidential/9855
2025-03-06 10:57:11 -06:00
Rachael Shaw
b769d946bc
Update formatting for "Modify team" API docs (#26840)
Match the format of [Modify
configuration](https://fleetdm.com/docs/rest-api/rest-api#modify-configuration)
2025-03-05 12:35:25 -06:00
Allen Houchins
3540b631c0
Update yaml-files.md (#26836)
Discovered `calendar_event_enabled` does not work but going through the
API documentation shows `calendar_events_enabled` does work. I verified
this in dogfood.

https://fleetdm.slack.com/archives/C019WG4GH0A/p1741118773584829
2025-03-04 15:56:45 -06:00
Victor Lyuboslavsky
488efd144e
Added DigiCert/SCEP activity structs. (#26786)
For #26603

Splitting this change from the rest of the DigiCert/SCEP config work
since it requires documentation signoff.
2025-03-04 11:02:44 -06:00
Rachael Shaw
ddd2834dc8
Sentence case fix in SMTP options form (#26730)
"Username and Password" -> "Username and password"
2025-02-28 15:29:39 -06:00
Mike McNeil
78b2a6f12f
Update Reference-Architectures.md (#26702) 2025-02-28 14:35:05 -06:00
Swapnil Surendra Jangam
36a3434e47
Update queries.yml (#26682)
Softwares query for macOS corrected in Vitals. Was showing query for
linux.

# 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. -->
- [ ] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements)
- [ ] Manual QA for all new/changed functionality

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2025-02-27 18:16:46 -06:00
Lucas Manuel Rodriguez
df5461cb4c
Remove unused code (from Fleet's sandbox implementation) (#26645)
Removing unused code and APIs (these APIs and code were used by "Fleet
Sandbox" which doesn't exist anymore).
2025-02-27 17:37:56 -03:00
Victor Lyuboslavsky
67b72764c5
Added Android activity and better handling of deleted users. (#26640)
For #26218

- Added `users_deleted` table to track user actions if the user was
actually deleted.
- Added enable/disable Android MDM activities

Note: I could not auto-generate fleet.Service mock because it has issues
with methods that don't return anything. I ended up using testify mock
instead.

# Checklist for submitter

- [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] Manual QA for all new/changed functionality
2025-02-27 14:19:15 -06:00
George Karr
b47e4a51ce
Drop support for macOS 13 (#26525)
Drop support for macOS 13 and no longer need to validate nudge updates
2025-02-27 13:34:59 -06:00
Sarah Gillespie
f43fb9538a
Merge branch 'main' into feat-23235-host-certificates 2025-02-27 11:41:34 -06:00
Jordan Moore
7df866754e
Correct a URL in the documentation so it doesn't 404 (#26651)
The URL was pointing to a file in the fleet-terraform repo that didn't
exist causing it to 404.
2025-02-27 09:27:15 -06:00
Konstantin Sykulev
124fc44a3e
Updated python_packages osquery query (#26434)
A new feature in osquery `5.16` was created to allow for scanning of
user directories for python packages. If the new version of osquery is
detected use the new query, otherwise use the old query.

https://github.com/fleetdm/fleet/issues/26423

- [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] 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-02-26 14:15:41 -06:00
Martin Angers
0adf67e538 Fix conflicts 2025-02-25 14:39:35 -05:00
Noah Talerman
a14fd0d263
Terraform cleanup (#26379)
- Remove `dogfood/aws/` folder
- Update links in docs and guides
2025-02-24 17:35:50 -05:00
Eugene
9ef382389e
Update yaml-files.md intro section for legibility and to call out missing or mispelled settings. (#26459)
Updated top text area for legibility and to call out what happens to
missing or mispelled settings.

These changes were prompted by
https://github.com/fleetdm/fleet/issues/26450

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2025-02-24 15:44:43 -06:00
Noah Talerman
f9a8910919
Agent configuration: small clarification (#26498)
`script_execution_timeout` is in seconds
2025-02-24 15:31:51 -06:00
Noah Talerman
b3dd8e58a3
YAML reference docs: fix indenting (#26566)
Fix example
[here](https://fleetdm.com/docs/configuration/yaml-files#example5):

![Screenshot 2025-02-24 at 3 18
38 PM](https://github.com/user-attachments/assets/64524043-190a-4194-af3a-b2ad2fb47358)
2025-02-24 15:23:02 -06:00
Martin Angers
8477856886 FIx conflicts 2025-02-24 14:28:34 -05:00
Lucas Manuel Rodriguez
eede554a79
Update Wayland docs (#26446)
For #25998
2025-02-21 09:24:03 -05:00
Eric
7dd2f8557c
Website: add bash commands for macOS vitals, queries, and policies (#26327)
Changes:
- Updated the query-detail, vital-detail, and policy-detail pages to
have a tab for bash commands.
- Updated queries, vitals, and policies to have a bash command that
returns the same results as the SQL query.
2025-02-20 18:16:16 -06:00
jacobshandling
c22f575150
Add gitops app config fields, API access, activities, tests (#26282)
## For #26230 

- Add `gitops` settings to app config
- GET and PATCH endpoint functionality to retrieve and modify these
settings
- generate activities for enabling and disabling GitOps mode
- Premium only
- Update tests

<img width="1355" alt="Screenshot 2025-02-17 at 9 22 13 AM"
src="https://github.com/user-attachments/assets/e03d7fd6-8795-4df2-9c8f-ffbcabd2d212"
/>

<img width="1575" alt="Screenshot 2025-02-17 at 9 24 33 AM"
src="https://github.com/user-attachments/assets/5bf963d4-6fb7-4586-8f6f-9e605c25bf06"
/>

## Checklist for submitter

- [x] Added/updated automated tests
- [ ] 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

---------

Co-authored-by: Jacob Shandling <jacob@fleetdm.com>
2025-02-20 08:40:46 -08:00
Sarah Gillespie
351f40230a
Add osquery ingestion for host certificates feature (#26426) 2025-02-19 14:44:01 -06:00
Noah Talerman
b682ee1b07
Docs v4.64.0 (#26393)
Reference doc changes for Fleet 4.64.0

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
Co-authored-by: Ian Littman <iansltx@gmail.com>
Co-authored-by: Eric <eashaw@sailsjs.com>
2025-02-18 16:31:55 -06:00
Mike Thomas
b23d331227
Update standard-query-library.yml (#26346)
closes:
https://github.com/fleetdm/fleet/issues/24415#issuecomment-2657863048

- Updated policy to the suggestion from @jmwatts in the linked bug
report.
- Added caveat note.

@ddribeiro, please can you confirm that the suggested policy edit is
good to go?

Co-authored-by: Eric <eashaw@sailsjs.com>
2025-02-18 07:33:41 +09:00
Dale Ribeiro
56b3a4bbef
Added DisableFDEAutoLogin key to support new policy (#26353)
# 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. -->

- [ ] 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.
- [ ] 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.
- [ ] If paths of existing endpoints are modified without backwards
compatibility, checked the frontend/CLI for any necessary changes
- [ ] If database migrations are included, checked table schema to
confirm autoupdate
- For database migrations:
- [ ] Checked schema for all modified table for columns that will
auto-update timestamps during migration.
- [ ] Confirmed that updating the timestamps is acceptable, and will not
cause unwanted side effects.
- [ ] Ensured the correct collation is explicitly set for character
columns (`COLLATE utf8mb4_unicode_ci`).
- [ ] Added/updated automated tests
- [ ] 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)
- [ ] Manual QA for all new/changed functionality
- For Orbit and Fleet Desktop changes:
- [ ] Orbit runs on macOS, Linux and Windows. Check if the orbit
feature/bugfix should only apply to one platform (`runtime.GOOS`).
- [ ] 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)).
2025-02-17 08:36:55 +09:00
Rachael Shaw
26a18d1f90
Update agent-configuration.md (#26371)
Fix unnecessary backticks and capitalization.
2025-02-15 11:29:59 -06:00
Joel Hermanns
ba8b94c1c0
docs: fix example response of Create Teams endpoint (#25974)
Previously the docs suggested that an array of teams is returned when
creating a new team. This is not the case.

This commit fixes the api docs and clarifies the example response.
2025-02-13 10:03:12 -06:00
Nathaniel Strauss
1a7f421582
Update YAML docs to support idp_image_url (#26104)
Supported with `fleetctl gitops` but not included in the YAML docs at
https://fleetdm.com/docs/configuration/yaml-files#sso-settings.

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2025-02-13 06:31:43 -06:00
Dale Ribeiro
cc3de47681
Add software to required keys example (#26261)
# 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. -->

- [ ] 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.
- [ ] 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.
- [ ] If paths of existing endpoints are modified without backwards
compatibility, checked the frontend/CLI for any necessary changes
- [ ] If database migrations are included, checked table schema to
confirm autoupdate
- For database migrations:
- [ ] Checked schema for all modified table for columns that will
auto-update timestamps during migration.
- [ ] Confirmed that updating the timestamps is acceptable, and will not
cause unwanted side effects.
- [ ] Ensured the correct collation is explicitly set for character
columns (`COLLATE utf8mb4_unicode_ci`).
- [ ] Added/updated automated tests
- [ ] 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)
- [ ] Manual QA for all new/changed functionality
- For Orbit and Fleet Desktop changes:
- [ ] Orbit runs on macOS, Linux and Windows. Check if the orbit
feature/bugfix should only apply to one platform (`runtime.GOOS`).
- [ ] 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)).
2025-02-11 11:52:44 -06:00
Noah Talerman
6e5b5085d6
YAML files: add missing example (#26101) 2025-02-11 10:59:13 -06:00
Robert Fairburn
94e6b972ce
Change documentation to point to new terraform repo (#26200) 2025-02-10 17:42:28 -06:00
Jordan Moore
d651a7ea49
Minor Documentation Updates (#26236)
I came across these changes while getting my gitops flow setup.

1. Changed `logo_url` to `org_logo_url`
2. Fixed indenting on `server_settings` so it's nested under
`org_settings`
2025-02-10 17:30:42 -06:00
Victor Lyuboslavsky
77daed1909
[YAML files] Fixed link and reorganized end_user_authentication for clarity. (#26173)
Link to current doc:
https://fleetdm.com/docs/configuration/yaml-files#end-user-authentication

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2025-02-07 17:43:11 -06:00
Noah Talerman
b38af05404
Serve software with CloudFront is Fleet Premium (#26131) 2025-02-07 17:41:04 -06:00
Katheryn Satterlee
5d5c7bdeed
Add example for mdm.end_user_authentication (#26120)
# 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. -->

Docs only change.
2025-02-07 17:35:12 -06:00
Victor Lyuboslavsky
a51ecf18ec
Clarify how Fleet GitOps is supposed to work (#26184) 2025-02-07 15:02:20 -06:00
Dante Catalfamo
f8de2d9e50
Follow redis redirects by default (#26043)
#22791

This will prevent the occasional redirect from breaking live queries.
Customers can still disable the redirects by setting
`redis.cluster_follow_redirections` to `false`.
2025-02-06 13:32:31 -05:00
Noah Talerman
9fabf367e4
YAML reference: remove duplicate section (#26100) 2025-02-05 13:54:50 -06:00
Gabriel Hernandez
2b9e19fcef
generate new docs for activities (#26066)
generates new docs for activities
2025-02-05 16:35:30 +00:00
Rachael Shaw
33b481fdc8
Docs v4.63.0 (#26019)
Documentation changes for 4.63.0

---------

Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
Co-authored-by: Eugene <eugene@fleetdm.com>
Co-authored-by: Ian Littman <iansltx@gmail.com>
Co-authored-by: Scott Gress <scottmgress@gmail.com>
Co-authored-by: Victor Lyuboslavsky <victor.lyuboslavsky@gmail.com>
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2025-02-04 12:38:54 -06:00
Noah Talerman
f6b06a9578
Audit logs: missing status (#25906)
- Add missing `status` for `installed_app_store_app`
- @noahtalerman: @iansltx and I tested the `installed_app_store_app`
activity and saw that the docs are missing `status`
- Clarify that `_software` activities are for Fleet-maintained apps and
custom packages
2025-02-03 16:16:58 -05:00
Tim Lee
d38d180357
Add labels and editing for VPP apps (#25979)
For #24609

---------

Co-authored-by: Jahziel Villasana-Espinoza <jahziel@fleetdm.com>
Co-authored-by: Jahziel Villasana-Espinoza <jahzielv@gmail.com>
2025-02-03 11:16:21 -06:00