Commit graph

85 commits

Author SHA1 Message Date
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
Noah Talerman
c8ff6c4c77
Supported operating systems: Amazon Linux (#32045)
- @noahtalerman: During #g-software design review on 2025-08-15, we
learned that Fleet builds and tests against Amazon Linux

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2025-08-27 13:05:26 -05:00
Noah Talerman
58eb8332a4
Supported operating systems: Android 13+ (#32258)
12 is EOL: https://endoflife.date/android
2025-08-26 18:00:37 -05:00
Victor Lyuboslavsky
58eef867e0
Update MySQL versions we test with to 8.4.6 and 9.4.0 (#31694)
Fixes #31693

Manually forced a run for MySQL 8.4.6 to validate.

# Checklist for submitter

- Changes not needed since this is not a product change.

## Testing

- [x] Added/updated automated tests
2025-08-08 07:19:06 +02:00
Mike McNeil
5b6385b119
FAQ.md: use normal-sounding words (#31035)
# 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
- [ ] Where appropriate, automated tests simulate multiple hosts and
test for host isolation (updates to one hosts's records do not affect
another.)
- [ ] 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-07-21 12:45:42 -05:00
Sam Pfluger
e3a93f7366
Add Nate's article to FAQ (#30371) 2025-06-27 12:29:56 -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
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
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
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
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
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
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
Lucas Manuel Rodriguez
eede554a79
Update Wayland docs (#26446)
For #25998
2025-02-21 09:24:03 -05:00
Mike Thomas
a7acff4eda
Updated anatomy and teams guide (#25629)
Closes https://github.com/fleetdm/fleet/issues/24615

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

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

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2025-01-22 12:39:44 -06:00
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
Rebecca Cowart
c0d63e9468
Update FAQ.md - Removals (#25223)
Removed questions scheduled to be removed
2025-01-08 11:56:27 -06: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
Rachael Shaw
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 Talerman
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
Mike McNeil
8080737870
Website: Update FAQ.md (#23718)
- 1000 => 300
- "cost-efficient" might make it seem like it's cost prohibitive for
everyone (but the real problem is just that we can't quite yet afford to
run thousands of small instances of Fleet for folks with 10-100 hosts,
because it means increasing infrastructure engineering headcount)
2024-11-19 22:42:20 -06:00
Noah Talerman
1e1b32ea40
Update pricing FAQ: pending hosts don't count (#23947) 2024-11-19 14:11:01 -05:00
Noah Talerman
12b66f9186
Update tutorials-and-guides.md (#23724)
- Certificates in fleetd is an advanced article about configuring fleetd
w/ custom certificates. I think "Custom OS settings" (configuration
profiles) is a better controls article
- Simplify titles of software links
2024-11-13 12:37:26 -06:00
Noah Talerman
d130ebe1e8
Add Debian to supported operating systems (#23773)
- Debian is a popular Linux flavor for servers
- Several Fleet customers have Debian hosts enrolled (see usage stats
[here](https://docs.google.com/spreadsheets/d/1Mh7Vf4kJL8b5TWlHxcX7mYwaakZMg_ZGNLY3kl1VI-c/edit?gid=538901298#gid=538901298))
- @iansltx has tested Fleet w/ Debian 11 and 12

---------

Co-authored-by: Ian Littman <iansltx@gmail.com>
2024-11-13 12:33:49 -06:00
Rachael Shaw
e892a826ee
Simplify "How can I uninstall fleetd?" answer (#23547)
Link to uninstall fleetd guide to avoid duplicate content
2024-11-05 17:48:04 -06:00
Mike Thomas
a60d2afd9f
docs-tutorials-and-guides-update (#23377)
Closes https://github.com/fleetdm/fleet/issues/22951

- Updated the guides listed on
https://fleetdm.com/docs/get-started/tutorials-and-guides to only
include the most essential onboarding guides. Guides are listed in the
following order:
    - Deploying Fleet
    - Organizational units
    - Controls
    - Installing software
    - Admin
- Added archive notices to the three "How to install osquery..."
articles
- Added "Further reading" links to the bottom of the Queries guide and
Policies guide to point to related advanced topics
- Renamed "Managing labels in Fleet" to "Labels" for parallelism with
our other guides (left the URL as is, no redirect necessary)
- Renamed "What are Fleet policies" to "Policies" for parallelism with
our other guides (left the URL as is, no redirect necessary)
2024-10-30 11:34:44 -05:00
Lucas Manuel Rodriguez
3f89b48ca5
Add iPadOS to minimum versions in FAQ docs (#23197)
Follow up to https://github.com/fleetdm/fleet/pull/23104.
2024-10-24 15:02:11 -05:00
Jahziel Villasana-Espinoza
d25e6cd067
fix: add ios minimum version to os list (#23104)
> No issue, just a fix from a customer convo today

# 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. -->
2024-10-22 17:22:34 -05:00
Rachael Shaw
4cc3e3bb63
Docs v4.58.0 (#22769) 2024-10-17 17:51:52 -05:00
Mike McNeil
514ca727ec
Update why-fleet.md (#22499) 2024-10-01 15:38:00 -05:00
Mike Thomas
9b04349192
Update why-fleet.md (#22290)
Updated and optimized for readability and consistency with Fleet's
messaging.

Closes https://github.com/fleetdm/fleet/issues/22150
2024-09-27 16:18:43 -05:00
Allen Houchins
c211572242
Refreshed and updated content (#21982)
Updated the "How to uninstall osquery" document to no longer reference
older osquery references and file paths that no longer exist.

---------

Co-authored-by: JD <spokanemac@users.noreply.github.com>
Co-authored-by: Eric <eashaw@sailsjs.com>
2024-09-27 16:16:38 -05:00
Ian Littman
ab996dc57d
Note that minimum MySQL version is 8.0.36 everywhere (not just 8.0) because that's what we test with (#22072)
Also mention that we test with 8.4.2 in a few more places.

Note that while I'm editing release articles, this isn't retconning
minimum requirements; we mention in 4.55.0 release notes further down
that we expect 8.0.36.
2024-09-13 10:59:38 -05:00
Mike Thomas
2171544ad1
Docs quick reference optimization (#21331)
This PR closes https://github.com/fleetdm/fleet/issues/21108

@noahtalerman, I double-checked all redirects, and they are working.
Clicking through the URLs in [this
spreadsheet](https://docs.google.com/spreadsheets/d/1djVynIMuJK4pT5ziJW12CluVqcaoxxnCLaBO3VXfAt4/edit?usp=sharing)
is a pretty quick way to go through them all. Note that "Audit logs" and
"Understanding host vitals" redirect to the contributor docs on GitHub,
so they will throw a 404 until this is merged.

Some new guides benefitted from a name change, so they make more sense
as stand-alone guides, and also so that we don't have to mess around
with more redirects later. Those name changes followed [this
convention](https://fleetdm.com/handbook/company/communications#headings-and-titles),
which was recently documented in the handbook.

Have fun!

---------

Co-authored-by: Eric <eashaw@sailsjs.com>
Co-authored-by: Noah Talerman <noahtal@umich.edu>
2024-08-16 15:30:31 -05:00
Lucas Manuel Rodriguez
68ea52a764
Update docs: minimum Aurora version supported (#21130)
From https://github.com/fleetdm/fleet/pull/20225#discussion_r1702942048
2024-08-07 19:01:39 -03:00
Mike Thomas
e488a26dc7
Update tutorials-and-guides.md (#21078)
I have updated the list of tutorials and guides in the docs.

Although the brief stated the cut down the list to only the top 10,
@nonpunctual and I whittled the list down to curate the top 20 guides
that we believe are relevant to users who are deploying and setting up
Fleet. We listed them in order of operation as much as possible.

Closes https://github.com/fleetdm/confidential/issues/7343
2024-08-07 07:56:13 +09:00
Eric
1517b285ec
Docs: Add fleetdm.com/guides link to tutorials-and-guides docs page. (#21026)
Related to: https://github.com/fleetdm/confidential/issues/7343

Changes:
- Added a fleetdm.com/guides link to the tutorials and guides docs page.
2024-08-02 18:35:23 -05:00
Grant Bilstad
ad9e93020e
Update FAQ Deploying section (#20669)
Updating FAQ section with new deploy information.
2024-07-23 15:17:47 -06:00
Dante Catalfamo
5e1a3d03ae
MySQL 8.0 Migration (#20225)
#17249
2024-07-22 16:27:36 -04:00
Mike Thomas
c5657016c6
Update FAQ.md (#20492)
Added a comment to let folks know why a bunch of questions are hidden.
Closes https://github.com/fleetdm/confidential/issues/7109

---------

Co-authored-by: Eric <eashaw@sailsjs.com>
2024-07-17 16:26:15 -05:00
Zach Wasserman
b2dec6de57
Fix anchor link for agent uninstall (#19937)
For #19936

# 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://fleetdm.com/docs/contributing/committing-changes#changes-files)
for more information.
- [ ] Manual QA for all new/changed functionality
2024-06-25 13:06:03 -07:00
Dave Herder
2db2b4ede1
policies doc glue-up (#19389)
Feedback from prospect-redwine was that this page required more depth on
policies. We have documentation around policies, this PR is to add
linking and to glue the topics together.

---------

Co-authored-by: Noah Talerman <noahtal@umich.edu>
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: JD <spokanemac@users.noreply.github.com>
2024-06-03 10:55:10 -07:00
Mike Thomas
21b1aac24f
Update why-fleet.md (#19064)
Removed the following sections to make way for the [new docs
CTA](https://github.com/fleetdm/fleet/pull/19062):

- What's next
- Try it out
2024-05-17 08:07:17 +09:00
Rachael Shaw
7cfb7721b3
FAQ: Add doc link to "How do I contact Fleet for support?" (#18654)
Add doc link to "How do I contact Fleet for support?"
2024-04-30 15:21:32 -05:00
Rachael Shaw
2e2137129a
Simplify "Is Fleet MIT licensed?" answer (#18653)
Simplify the language in "Is Fleet MIT licensed?"
2024-04-30 15:09:59 -05:00
Rachael Shaw
895d4bc2f7
Use "Fleet's agent (fleetd)" naming in the docs (#18138)
For #16512

---------

Co-authored-by: Eric <eashaw@sailsjs.com>
2024-04-29 11:12:03 -05:00
Rachael Shaw
63d91526d2
A few capitalization fixes in the docs (#18416)
Sentence-casing.
2024-04-18 16:45:55 -05:00
George Karr
b0bb2e6ab5
Update FAQ.md (#17707)
This instructions were inaccurate following these steps only `Fleet
Osquery` was installed not `orbit`

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-03-30 02:33:41 -05:00
Gabriel Hernandez
32f4465a40
update Orbit docs url (#17077)
updated URL for orbit docs. The previous location forwarded to
https://fleetdm.com/docs/using-fleet/enroll-hosts and did not give info
about Orbit.

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-02-26 17:13:25 +00:00
Luke Heath
e74b7b9201
Add Fleetd Chrome Extension to anatomy docs (#16762) 2024-02-16 09:14:00 -06:00