Commit Graph
151 Commits
Author SHA1 Message Date
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
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
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
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
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
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
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
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
Allen Houchins 97c9b651e1 Update fleet-server-configuration.md (#27868)
Fixed typo
2025-04-04 17:44:19 -05:00
Ian LittmanandRachael Shaw 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
+2 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
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
Benjamin Edwards c6178c64cd add configuration setting for forcing h2c (#26799) 2025-03-21 09:38:21 -04:00
Mike McNeil 21dfccc655 Update fleet-server-configuration.md (#27313) 2025-03-19 15:09:34 -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
Noah Talerman 76071505ff YAML reference docs: custom targets (labels) is Premium only (#27109) 2025-03-13 16:51:54 -05: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 TalermanandRachael Shaw 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
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
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
EugeneandNoah Talerman 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
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
Rachael Shaw 26a18d1f90 Update agent-configuration.md (#26371)
Fix unnecessary backticks and capitalization.
2025-02-15 11:29:59 -06:00
Nathaniel StraussandRachael Shaw 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
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 LyuboslavskyandRachael Shaw 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
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
Marko LisicaandNoah Talerman d30b8fd96a Update path example for install_software.package_path (#25895)
Related to #25867 

Paths are relative. Fixed in
[4.58.0](https://github.com/fleetdm/fleet/blob/main/CHANGELOG.md?plain=1#L308).

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2025-01-31 10:55:26 -06:00
Rebecca Cowart 00c2f366e9 Update agent-configuration.md (#25855)
grammar fix
2025-01-30 13:30:18 -06:00
Katheryn SatterleeandRachael Shaw 49231f19be Update agent-configuration.md (#25740)
- Updated the query suggested to view all osquery flags
- Added a note that running this query through osqueryi will not reflect
the settings in use by osqueryd.

# Checklist for submitter

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

Documentation only change

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2025-01-27 13:35:46 -06:00
Harrison Ravazzolo 19947a0c08 Add support for post_install_script (#25683)
This is supported in gitops but not referenced in docu.
2025-01-22 18:02:42 -06:00
Harrison Ravazzolo a23c305e04 Typo in gitops yaml file (#25681)
Update `name` to proper syntax `org_name`
2025-01-22 18:00:28 -06:00
Scott Gress 4ac1be34d9 Update docs for host_batch_size (#25632)
for #24967 

This PR updates the documentation for the `host_batch_size` for both the
failing policies webhook and the vulnerabilities webhook. The new
documentation matches the actual behavior when `host_batch_size` is set
to 0.
2025-01-22 13:15:31 -06:00
Rebecca Cowart 2f20f13246 Update yaml-files.md (#25526)
Added ai_features_disabled to the list of server_settings. Fixed two
spelling issues. Made the grammar surrounding each "(default:...)" text
consistent within that section.
2025-01-16 16:04:53 -06:00
Marko Lisica 8b073d577c Update docs and guide about variables (#25445)
Related to:
- https://github.com/fleetdm/fleet/issues/23238#issuecomment-2591300093
2025-01-16 13:34:28 -05:00
Dante CatalfamoandScott Gress 39466cb644 Use webhooks settings from gitops even when empty (#25347)
#24958

---------

Co-authored-by: Scott Gress <scottmgress@gmail.com>
2025-01-15 11:31:48 -05:00
378b404421 Documentation changes for v4.62.0 (#25315)
Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
Co-authored-by: Konstantin Sykulev <konst@sykulev.com>
Co-authored-by: George Karr <georgekarrv@users.noreply.github.com>
Co-authored-by: Victor Lyuboslavsky <victor.lyuboslavsky@gmail.com>
Co-authored-by: Ian Littman <iansltx@gmail.com>
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Lucas Manuel Rodriguez <lucas@fleetdm.com>
Co-authored-by: Eric <eashaw@sailsjs.com>
2025-01-09 18:04:34 -06:00
Noah Talerman 9cb59c2abd Reference docs: "Agent configuration" page cleanup (#25290)
This PR brings the "Agent configuration" format/organization closer to
the format we use for all other reference docs (YAML files, REST API,
and Fleet server configuration)

Changes:
- Update page headers so that the right-side navigation includes all the
top-level keys. Similar to the YAML files docs.
- Brings examples to the top of each section after a short description
(if necessary)
- Cut content
- Update "Learn more" links to more recent guides
2025-01-09 13:10:56 -06:00
Scott Gress f2239e6a48 Merge docs changes around script exection and YARA (#25204)
This PR cherry-picks a couple of docs changes I added to the docs-4.63.0
branch. These changes were approved and merged in
https://github.com/fleetdm/fleet/pull/25181 and
https://github.com/fleetdm/fleet/pull/25189, before I belatedly asked
whether that was the correct process.
2025-01-07 11:17:21 -06:00
Harrison RavazzoloandHarrison John 71c8467a28 Fix typos in server config documentation (#25036)
Co-authored-by: Harrison John <harrisonjohn@Harrisons-MacBook-Pro.local>
2024-12-30 13:00:43 +01:00
Noah Talerman 5f9fcfc9f4 YAML files reference docs: windows_migration_enabled (#24891)
- Add missing reference docs for the following user story:
  - #22075
2024-12-19 14:37:49 -05:00