Commit Graph
2122 Commits
Author SHA1 Message Date
Eric 4980052f0b Website: Update policy details page, add controls to policies in standard query library. (#25309)
Related to: #23285


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

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

# Checklist for submitter

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

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

# Checklist for submitter

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

adds the `software_title_id` to the `added_app_store_activity`

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

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

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

---------

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

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

---------

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

# Checklist for submitter

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

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

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

Co-authored-by: Jacob Shandling <jacob@fleetdm.com>
2024-12-23 14:40:24 -08:00
Noah Talerman e6b1f73846 API reference docs: Profiles & scripts in GET /config, PATCH /config,GET /teams/:id , and PATCH /teams/:id (#24972)
Discovered this gap in API reference docs here:
https://github.com/fleetdm/fleet/issues/24789#issuecomment-2555549128
2024-12-23 15:56:41 -05:00
gillespi314 c78002747f Merge branch 'main' into feat-labels-scoped-software 2024-12-20 17:06:48 -06:00
Janis Watts 6979fc128c Updated MailHog/Mailpit instructions for current UI and consistency (#24954)
Updated instructions to reflect the current UI options and changed
formatting in "MailHog SMTP server without authentication" to match the
more organized "Mailpit SMTP server with plain authentication" section.
2024-12-20 14:29:41 -06:00
Noah Talerman 5f9fcfc9f4 YAML files reference docs: windows_migration_enabled (#24891)
- Add missing reference docs for the following user story:
  - #22075
2024-12-19 14:37:49 -05:00
Katheryn Satterlee d5ce6fa5d1 Clarify automation reset (#24884)
Updated /automations/reset description to reflect that this endpoint
does not immediately trigger automations, but resets the status of hosts
so that they are seen as newly failing on the next automation run.
2024-12-19 11:46:55 -06:00
Gabriel Hernandez 9057bf62a3 Merge branch 'main' into feat-labels-scoped-software 2024-12-18 15:36:20 -06:00
Martin Angers 14fc86d5e7 SSVL: update activities to add labels include/exclude (backend changes) (#24839) 2024-12-18 08:16:36 -05:00
c4a2bb4d6b 4.61 documentation changes (#24833)
Co-authored-by: Ian Littman <iansltx@gmail.com>
Co-authored-by: Zach Wasserman <zach@fleetdm.com>
Co-authored-by: Lucas Manuel Rodriguez <lucas@fleetdm.com>
Co-authored-by: Konstantin Sykulev <konst@sykulev.com>
Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2024-12-17 15:39:24 -06:00
Noah TalermanandRachael Shaw 8759f4b23f Currently, Fleet Desktop for Kubuntu requires Google Chrome (#24812)
More context:
https://github.com/fleetdm/fleet/issues/23697#issuecomment-2546913113

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-12-16 17:50:56 -06:00
Noah Talerman 6b6eb19bb0 Fleet server configuration docs: capitalize "S3" (#24794) 2024-12-16 10:42:20 -06:00
Andrea Scarpino e3c87a2c79 List paths used by Fleet desktop (#23891)
We don't expose fleet publicly and we had to open these paths to make
Fleet Desktop work.
2024-12-13 17:47:50 -06:00
Konstantin SykulevandRachael Shaw abeb16c087 Updated deprecated endpoint references with new endpoint (#24723)
[#23880](https://github.com/fleetdm/fleet/issues/23880)

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-12-12 13:55:49 -06:00
Eugene 039ea91f9b Capitalization fix & added :id information (#24643)
Fixed capitalization of "Default response" and id information for
modiifying a package
2024-12-12 12:50:49 -06:00
Eugene f1ea2360d2 Edit the "List activities" description. (#24562)
Edited for length and clarity
2024-12-11 17:33:56 -05:00
Jahziel Villasana-Espinoza 5814e3985a feat: add software title ID to add software activity (#24577)
> Related issue: #24120

## Changes
- Added the `software_title_id` field to the activity details for
`added_software` activities, which get generated when adding a customer
installer or a FMA
- Added a return value (`titleID`) to
`ds.MatchOrCreateSoftwareInstaller`
- Removed `ds.GetSoftwareTitleIDByMaintainedAppID`. Since we're
returning the new value above, this method was no longer needed.

## Testing steps
1. Add a custom installer
2. Add a FMA
3. Check the activity details in the response to `GET /activities`.
Verify that the `software_title_id` field exists and is correct.
4. Add a FMA with automatic install. Make sure the policy is correctly
created, has the correct software title ID associated with it, and that
it installs the app.

# 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 tests
- [x] Manual QA for all new/changed functionality
2024-12-11 09:54:15 -05:00
Noah TalermanandRachael Shaw 68f2d99b25 API reference docs: disk encryption is cross-platform (#24588)
API reference doc changes for the following story:
- #22074

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-12-10 16:52:29 -06:00
Noah Talerman 6e4ddaeab9 YAML files reference docs: labels and users coming soon, ticket creation, ABM and VPP (#24480) 2024-12-10 17:50:04 -05:00
Katheryn Satterlee 7b87a32606 Add detail_query_overrides to contributor docs (#24589) 2024-12-10 15:46:59 -05:00
Janis Watts a2e85abc62 Changed Metadata URL in SSO configuration to 127.0.0.1 due to product validation update (#24599)
Fleet now has a validation check in the Metadata URL field. Updated
instructions from

Metadata URL: http://localhost:9080/simplesaml/saml2/idp/metadata.php

TO

Metadata URL: http://127.0.0.1:9080/simplesaml/saml2/idp/metadata.php
2024-12-10 14:53:09 -05:00
Noah Talerman 8fe05fcf93 API reference: run script w/ team_id and script_name (#24484) 2024-12-10 13:39:24 -06:00
Martin Angers 538abdccf8 Add contributor docs to document the teams/no team conventions (#24569)
Not associated with a ticket, was an action item from our retrospective
meeting.
2024-12-10 10:19:28 -05:00
Katheryn Satterlee c06a6b0509 Update deploy-fleet.md (#24503)
Add link to reference architecture for users who want to self-host.

Docs-only change.
2024-12-09 10:32:57 -05:00
Jahziel Villasana-Espinoza 614446e9b3 feat: document orbit-auth endpoints (#24368)
> Related issue: #22811

# 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] Manual QA for all new/changed functionality
2024-12-05 11:22:13 -06:00
Noah Talerman c8ac4067a8 Missing YAML files (GitOps) reference docs (#24362)
- Add `uninstall_script` for `packages`
- This feature was shipped as part of the following user story: #20320
  - Looks like we forgot to merge in the reference docs
2024-12-05 11:20:16 -06:00
Victor Lyuboslavsky e04ab28128 Docs for /fleet/abm_tokens/count API endpoint (#24303)
For #24288
2024-12-04 19:19:16 -06:00
Ian Littman 4e27aebb5b Indicate that we show date only (not date and time) for build_date in version endpoint response (#24388)
For #24293.
2024-12-04 18:24:44 -05:00
Allen Houchins 8b8f5f0649 Update yaml-files.md (#24371)
- Disk encryption for Linux
2024-12-04 18:08:53 -05:00
William Theaker a7ec57e881 Fix gitops secret example (#24217)
The current string doesn't work.
2024-12-04 16:03:25 -06:00
Konstantin Sykulev e3c9bf67cc Fixed broken link in Deploy/README.md (#24134)
A `monitoring-fleet.md` file does not seem to exist. Pointed the link to
the `Reference-Architectures.md` Monitoring Fleet section.
2024-12-04 15:49:22 -06:00
Marko Lisica ad83e71e39 [API design] Custom OS settings: "include any label" option for custom target (#23647) 2024-12-03 18:17:42 -05:00