Commit Graph
216 Commits
Author SHA1 Message Date
+5 25191f3054 Preview of v4.77.0 doc changes (#35924)
This PR will remain in draft as a preview of upcoming documentation
changes for 4.77.0

---------

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: Victor Lyuboslavsky <2685025+getvictor@users.noreply.github.com>
Co-authored-by: Ian Littman <iansltx@gmail.com>
Co-authored-by: Noah Talerman <noahtal@umich.edu>
Co-authored-by: Lucas Manuel Rodriguez <lucas@fleetdm.com>
Co-authored-by: Magnus Jensen <magnus@fleetdm.com>
Co-authored-by: Jordan Montgomery <elijah.jordan.montgomery@gmail.com>
Co-authored-by: Janis Watts <184028114+jmwatts@users.noreply.github.com>
Co-authored-by: Allen Houchins <32207388+allenhouchins@users.noreply.github.com>
Co-authored-by: Gabriel Hernandez <ghernandez345@gmail.com>
Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
Co-authored-by: Scott Gress <scottmgress@gmail.com>
Co-authored-by: Carlo <1778532+cdcme@users.noreply.github.com>
2025-12-02 17:24:15 -06:00
Rachael Shaw cb621bdfef [UPDATED] #31719 API/YAML design (Add custom package that only contains a script) (#33648) 2025-11-26 16:43:31 -06:00
Harrison Ravazzolo 22034d7983 remove duplicate smallstep section from yaml reference (#36339)
Dupe blocks of code
2025-11-26 12:23:24 -06:00
George Karr 8ab356a666 Fix links in Configuration README (#35538) 2025-11-24 17:11:16 -06:00
Noah Talerman 85cca255bf Add setup_experience to example YAML (#35780)
- Clarify that `setup_experience` can be used for `app_store_apps` and
`fleet_maintained_apps`
2025-11-15 13:01:51 -05:00
Jordan MontgomeryandNoah Talerman 98452d4827 [API/YAML] Docs for new setup experience script PUT endpoint (#35736)
API changes for #35309 

Also updates bug notes to call out fixed version.

Related PR #35651

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2025-11-14 17:47:34 -05:00
Janis Watts ecf5c789aa Update yaml-files.md (#35765)
Proposing that we update this language to match what actually happens if
you add a VPP app using an adamID (all platforms with that adamID are
added, along with any settings like self service categories, setup
experience, labels, etc.)
2025-11-14 13:11:11 -05:00
Noah Talerman 15f5880638 [YAML reference] Clarify variable (#34956)
IdP username is an email
2025-11-11 18:01:11 -05:00
Noah Talerman f684118edd YAML reference (#35546)
- Fleet supports payload-free packages for Linux (`.sh`) and Windows
(`.ps1`)
- `.ipa` coming in 4.77
2025-11-11 14:15:11 -05:00
Rachael Shaw 3135e9a0a7 #30117 API/YAML design: Require all software installs during macOS setup experience (#33016)
User story:

+ #30117
2025-11-11 10:04:05 -05:00
Rachael Shaw 86b80e28ed Documentation v4.76.0 (#34943)
Documentation changes for the 4.76 release
2025-11-11 09:30:14 -05:00
Rachael Shaw 480a73c669 Move setup experience bug message (#35393) 2025-11-08 13:19:18 -06:00
Rachael Shaw 9cc3b8f0ba Docs: Add messaging about 🪲 #35309 (#35392)
Add caveat to macOS setup experience and GitOps docs re: 🪲 #35309
<img width="828" height="306" alt="Screenshot 2025-11-08 at 1 05 11 PM"
src="https://github.com/user-attachments/assets/ca6a04f6-bea6-4863-839e-65a004bad932"
/>
2025-11-08 13:11:06 -06:00
Dante Catalfamo f06e6fc582 Gitops docs changes for #34689 (#35015) 2025-11-04 16:27:36 -05:00
Noah Talerman b46180ad7e YAML reference: Certificate authority (CA) variables (#34859)
- Context: https://github.com/fleetdm/fleet/issues/33918
2025-10-30 17:00:14 -04:00
Noah TalermanandRachael Shaw 4c104da5b9 [YAML reference] Clarify Apple's built-in variables (#34030)
- @noahtalerman: These variables are only supported in specific
payloads. Apple source:
https://support.apple.com/en-my/guide/deployment/dep04666af94/1/web/1.0
- @noahtalerman: We confirmed this. See @allenhouchins's findings in
this feature request: https://github.com/fleetdm/fleet/issues/28636

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2025-10-27 17:29:42 -05:00
Noah Talerman 53a6179500 [Fleet server configuration] Clarify that only one can be set (#34743)
- Clarified that only one of `server_private_key_arn` or
`server_private_key` can be set.

Context:
https://github.com/fleetdm/fleet/issues/31321#issuecomment-3412996433
2025-10-27 17:12:58 -05:00
kitzy e96365ab58 [DOCS] Add example YAML configuration for macOS setup (#34766)
This came out of a customer call where we received the following output
from the `fleetctl generate-gitops` command:
```
The macos_setup configuration is not supported by this tool yet.  To configure it, please follow the Fleet documentation at https://fleetdm.com/docs/configuration/yaml-files#macos-setup
```
In the moment, it wasn't clear to me or the customer what had to be
done. This update provides the context (where the `macos_setup`
configuration is supposed to exist) as well as an example of what it
should look like.
2025-10-24 17:32:03 -05:00
Noah Talerman 3b2717f4fd YAML reference (#34604)
Use serial numbers for labels example. Serial numbers is best practice.
2025-10-21 14:15:57 -05:00
+3 7ed4aac2b8 Docs v4.75.0 (#34443)
Documentation changes for the 4.75 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: Victor Lyuboslavsky <2685025+getvictor@users.noreply.github.com>
Co-authored-by: Ian Littman <iansltx@gmail.com>
Co-authored-by: Noah Talerman <noahtal@umich.edu>
Co-authored-by: Lucas Manuel Rodriguez <lucas@fleetdm.com>
Co-authored-by: Magnus Jensen <magnus@fleetdm.com>
Co-authored-by: Jordan Montgomery <elijah.jordan.montgomery@gmail.com>
Co-authored-by: Tim Lee <timlee@fleetdm.com>
Co-authored-by: Janis Watts <184028114+jmwatts@users.noreply.github.com>
Co-authored-by: Sarah Gillespie <73313222+gillespi314@users.noreply.github.com>
Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
2025-10-17 17:45:52 -05:00
Noah Talerman 0e9bba4774 YAML reference: Typo: "self_service" (#34202) 2025-10-14 17:06:25 -05:00
jacobshandling 05b8ba4a32 Update gitops labels docs (#34207)
Small docs fixes
2025-10-14 17:06:01 -05:00
Rachael Shaw b94aba24aa Remove duplicate certificate authorities example from YAML docs (#33931)
There was an extra one left over from merging in doc updates.
2025-10-07 08:59:30 -05:00
+1 48cb0908cd Docs v4.74.0 (#33879)
Documentation changes for 4.74

---------

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: Victor Lyuboslavsky <2685025+getvictor@users.noreply.github.com>
Co-authored-by: Ian Littman <iansltx@gmail.com>
Co-authored-by: Noah Talerman <noahtal@umich.edu>
Co-authored-by: Lucas Manuel Rodriguez <lucas@fleetdm.com>
Co-authored-by: Magnus Jensen <magnus@fleetdm.com>
Co-authored-by: Jordan Montgomery <elijah.jordan.montgomery@gmail.com>
Co-authored-by: Janis Watts <184028114+jmwatts@users.noreply.github.com>
Co-authored-by: Allen Houchins <32207388+allenhouchins@users.noreply.github.com>
2025-10-06 17:03:10 -05:00
Noah Talerman 279cc8d0d4 YAML reference: Only one package, App Store app, or Fleet-maintained app per software (#33707)
Docs to address the following bug:
- #32607
2025-10-02 19:06:02 -05:00
Noah TalermanandRachael Shaw a5978d16d9 YAML files: Add missing key (#33574)
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2025-09-30 18:09:58 -05:00
Steven Palmesano 4a47305353 Change Mac script references from .ps1 to .sh (#33407)
Our example shows a Mac app using .ps1 scripts, but Macs don't use
PowerShell.
2025-09-24 10:12:34 -05:00
Noah Talerman 3d0a0639f6 YAML reference docs: Built-in variables (#33085)
Add `$FLEET_VAR_HOST_HARDWARE_SERIAL`

Looks like we added this variable as part of [this
sub-task](https://github.com/fleetdm/fleet/issues/26609) but we didn't
documented it.
2025-09-17 11:53:23 -05:00
jacobshandlingandJacob Shandling ee4d4c0a7d Fix minor inconsistency in agent config overrides docs (#32874)
Only macs would be overridden here

Co-authored-by: Jacob Shandling <jacob@fleetdm.com>
2025-09-11 12:37:14 -05:00
Lucas Manuel Rodriguez 4fe2ec58b7 Fix duplicate note and while we're at it some typos under docs/ (#32575)
Fixing the following duplicate note in
`docs/Configuration/yaml-files.md`:
<img width="512" height="630" alt="Screenshot 2025-09-04 at 5 49 05 AM"
src="https://github.com/user-attachments/assets/37229d45-e9b2-4744-9fe1-1c4c54be72b0"
/>

And while we're at it... fixing some typos under `docs/`.
2025-09-09 19:33:18 -03:00
+2 2a901105bf Docs v4.73.0 (#32682)
Documentation changes for the 4.73.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: Ian Littman <iansltx@gmail.com>
Co-authored-by: Victor Lyuboslavsky <2685025+getvictor@users.noreply.github.com>
Co-authored-by: Gabriel Hernandez <ghernandez345@gmail.com>
Co-authored-by: Magnus Jensen <magnus@fleetdm.com>
Co-authored-by: RachelElysia <rachel@fleetdm.com>
Co-authored-by: RachelElysia <71795832+RachelElysia@users.noreply.github.com>
Co-authored-by: Lucas Manuel Rodriguez <lucas@fleetdm.com>
Co-authored-by: Scott Gress <scottmgress@gmail.com>
Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
2025-09-08 19:09:44 -05:00
f0c0411d10 [Guide update] IdP authentication before BYOD iOS, iPadOS, and Android enrollment (#32475)
Related to:

- #30684

- @noahtalerman: Added a "Variables" section in the YAML reference so we
can link to it.

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2025-09-08 10:09:11 -05:00
6a64cf8da0 #30879 YAML changes (#31542)
For #30879

---------

Co-authored-by: Victor Lyuboslavsky <2685025+getvictor@users.noreply.github.com>
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2025-08-29 14:54:27 -05:00
Noah Talerman beb6113732 GitOps reference: Add missing smtp_settings (#32301)
Addresses this bug: https://github.com/fleetdm/fleet/issues/29815

More history/context in this PR:
https://github.com/fleetdm/fleet/pull/29346
2025-08-26 17:58:59 -05:00
Emmanuel Ferdman 62b8a77acd Fix a few broken references (#31640)
# Checklist for submitter

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

- [ ] 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)
- [ ] If paths of existing endpoints are modified without backwards
compatibility, checked the frontend/CLI for any necessary changes

## Testing

- [ ] Added/updated automated tests
- [ ] Where appropriate, [automated tests simulate multiple hosts and
test for host
isolation](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/reference/patterns-backend.md#unit-testing)
(updates to one hosts's records do not affect another)

- [ ] QA'd all new/changed functionality manually

For unreleased bug fixes in a release candidate, one of:

- [ ] Confirmed that the fix is not expected to adversely impact load
test results
- [ ] Alerted the release DRI if additional load testing is needed

## Database migrations

- [ ] Checked table schema to confirm autoupdate
- [ ] 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`).

## New Fleet configuration settings

- [ ] Setting(s) is/are explicitly excluded from GitOps

If you didn't check the box above, follow this checklist for
GitOps-enabled settings:

- [ ] Verified that the setting is exported via `fleetctl
generate-gitops`
- [ ] Verified the setting is documented in a separate PR 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

## fleetd/orbit/Fleet Desktop

- [ ] Verified compatibility 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))
- [ ] If the change applies to only one platform, confirmed that
`runtime.GOOS` is used as needed to isolate changes
- [ ] Verified that fleetd runs on macOS, Linux and Windows
- [ ] Verified auto-update works from the released version of component
to the new version (see [tools/tuf/test](../tools/tuf/test/README.md))

Signed-off-by: Emmanuel Ferdman <emmanuelferdman@gmail.com>
2025-08-21 12:13:45 -05:00
Rachael Shaw 03d2a854b7 #23899 API and YAML design (IdP department/group labels) (#30015)
For #23899
2025-08-20 11:28:36 -04:00
6b37527c8a 4.72.0 doc changes (#31766)
Documentation changes for 4.72.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: Victor Lyuboslavsky <2685025+getvictor@users.noreply.github.com>
Co-authored-by: Lucas Manuel Rodriguez <lucas@fleetdm.com>
Co-authored-by: Ian Littman <iansltx@gmail.com>
Co-authored-by: RachelElysia <71795832+RachelElysia@users.noreply.github.com>
Co-authored-by: Noah Talerman <noahtal@umich.edu>
Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
2025-08-13 19:10:48 -05:00
Pascal Matthiesen 6081da7673 feat: allow different cisa url to be provided (#31728)
Summary

• Allow custom CISA vulnerability data source URL to work around blocked
requests
  • Updates vulnerability sync logic to use configurable CISA endpoint
• Enables organizations to use CISA mirrors when direct access is
blocked

## Testing

- [x] Added/updated automated tests
- [x] QA'd all new/changed functionality manually
2025-08-13 13:35:45 -05:00
Harrison Ravazzolo 3c830e9690 Update gitops yaml docs (#31786)
Correct name for key is `custom_scep_proxy`, updating docu
2025-08-11 12:39:54 -05:00
Mitch FranceseandRachael Shaw 6d5927c95c Update yaml-files.md (#31413)
Added a section discussing how pathing works within Fleet’s GitOps to
help clear up any confusion. This was requested by a customer in the
Fleet Slack channel:


https://fleetdm.slack.com/archives/C05LE08TUD7/p1753812814755329?thread_ts=1753804250.222989&cid=C05LE08TUD7

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2025-08-08 10:32:20 -05:00
Marko Lisica ab0f699e85 Update private_server_key description (#31460)
Related to:

- #31353
2025-08-04 18:00:39 -05:00
Noah Talerman 4cb4832af5 Add reference docs: escaping Fleet variables ($) (#31566)
Move instructions for escaping to the GitOps (YAML) reference docs
instead of the guide (harder to find).

Part of the following bug here:
- #30006
2025-08-04 14:11:40 -05:00
Victor Lyuboslavsky 949a1eeabb Add sso_server_url configuration for dual URL SSO setups (#31497)
This change allows configuring a separate URL for SSO callbacks, which
is useful when organizations have different URLs for admin access vs
agent/API access.

Fixes #31480 the SSO issue where organizations with dual URL setups were
getting 'Destination does not match requested URL' errors after
upgrading to v4.71.0 with the new SAML library.

Video demo: https://www.youtube.com/watch?v=dFzNpUY3XKI

# Checklist for submitter

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

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

## Testing

- [x] Added/updated automated tests
- [ ] QA'd all new/changed functionality manually

## New Fleet configuration settings

- [x] Verified that the setting is exported via `fleetctl
generate-gitops`
- [x] Verified the setting is documented in a separate PR to [the GitOps
documentation](https://github.com/fleetdm/fleet/blob/main/docs/Configuration/yaml-files.md#L485)
  - Same PR since this is going to be a 4.71.1 patch
- [ ] 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

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

## Summary by CodeRabbit

* **New Features**
* Added support for configuring a dedicated SSO URL, allowing
organizations to restrict SSO authentication to a specific URL.
* The new SSO URL option is available in both the UI and API
configuration settings.

* **Documentation**
* Updated configuration and API documentation to include the new SSO URL
option with usage examples.

* **Bug Fixes**
* Resolved authentication issues for organizations using separate URLs
for admin and agent/API access.

* **Tests**
* Added new unit and integration tests to verify SSO behavior with and
without the dedicated SSO URL.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-08-01 20:32:15 +02:00
Noah Talerman fe7a91bf52 [API and YAML design] SSO breaks when using separate 'admin' URL (#31513)
API and YAML changes for the following bug:
- #31480
2025-08-01 10:44:12 -05:00
Marko Lisica 16f036a40b Mark ndes_scep_proxy as experimental (#31044)
Mark ndes_scep_proxy as experimental.

@rachaelshaw We already discussed this. We forgot to mark this YAML
configuration as experimental, but the API is marked as experimental. We
want to deprecate these and transition to new endpoints, as discussed
during the MDM design review, to enable better scaling of this feature.
2025-07-28 15:15:12 -05:00
0d8c099cf9 Docs v4.71.0 (#31200)
Documentation changes for 4.71.0

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Jordan Montgomery <elijah.jordan.montgomery@gmail.com>
Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
Co-authored-by: Lucas Manuel Rodriguez <lucas@fleetdm.com>
Co-authored-by: Ian Littman <iansltx@gmail.com>
2025-07-23 16:02:13 -06:00
Lucas Manuel Rodriguez d256bfdc71 Add arm64 support for fleetd extensions and fixes on test scripts (#31084)
This was required to test https://github.com/fleetdm/fleet/pull/30864 on
Apple Silicon.

I've created https://github.com/fleetdm/fleet/issues/31092 for tracking
purposes.

Fixes:
- Build univeral binary extension on macOS to test on VMs without
Rosetta.
- Add support for linux and Windows arm64. Which is also needed to test
Linux and Windows on UTM on Apple Silicon.
- Add Linux arm64 & Windows arm64 to the test scripts.

---

- [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-07-21 15:47:59 -03:00
Victor Lyuboslavsky 3003ce5eb2 Fix markdown header in fleet-server-configuration.md (#31039) 2025-07-21 12:42:37 -05:00
Katheryn Satterlee 98fd078bd5 Remove references to 'fleetctl upload-software' (#30793) 2025-07-11 14:05:18 -06:00
Ian Littman 1b20c5bae6 Document current auto-update behavior for Fleet-maintained apps set via GitOps (#30345) 2025-06-27 13:08:43 -05:00