Commit graph

1788 commits

Author SHA1 Message Date
Marko Lisica
8aaa4600ed
Docs: Configure script execution timeout (#15483)
Docs changes for:
- #15196
2024-01-12 17:29:43 -05:00
Noah Talerman
2132c7ee17
Update Fleet server configuration docs (#16054)
- Pull info about duration-based settings to the top to make it clear.
For this bug: #15926
- Add info about self-managed v. managed-cloud customers
- Cut content
2024-01-12 17:28:18 -05:00
Noah Talerman
c5738fbdeb
Update supported host operating system (#16070)
- macOS is always lowercased
2024-01-11 17:11:46 -05:00
Grant Bilstad
cd7da443a3
paragraph doubled in enroll docs (#16069)
Edit to remove double-copy of paragraph in docs
2024-01-11 14:09:42 -07:00
Rachael Shaw
0f3458b2a0
#14500 documentation: Option to disable scripts in organization settings (#15431)
Changes to the organization settings configuration example for
https://github.com/fleetdm/fleet/issues/14500
2024-01-11 14:37:25 -05:00
Rachael Shaw
bc075b1eea
#15058 API design: Add gigs total disk space to host endpoints (#15442)
Rest API changes for https://github.com/fleetdm/fleet/issues/15058
2024-01-11 14:35:56 -05:00
Rachael Shaw
7c84588689
#14800 API design: POST request for "Run live query" endpoint (#15508)
"Run live query" API updates based on @jrzmurray's PR
https://github.com/fleetdm/fleet/pull/13002, to resolve issue
https://github.com/fleetdm/fleet/issues/14800.
2024-01-11 14:28:48 -05:00
Katheryn Satterlee
e761ba529d
Update MySQL requirements (#15940)
Added a note about using alternative database servers with Fleet.

Resolves #15766
2024-01-11 10:00:38 -06:00
Noah Talerman
7a0e2089c4
API design: Get email w/o relying on end user (#15445)
- API changes for Get email w/o relying on end user: #15057
2024-01-10 17:29:51 -05:00
Noah Talerman
5f38355169
Merge fleetd doc page to enroll hosts page (#15907)
- Move relevant content from "Fleetd" doc page to "Enroll hosts" page
- Remove "Fleetd" docs page
2024-01-10 14:35:18 -05:00
Marko Lisica
89ff5541d3
API design: Lookup hosts based on IdP email (#15305)
API changes for the following story:

- #13034
2024-01-10 09:23:56 -05:00
Noah Talerman
59cd1bf491
Update Vulnerability Processing docs (#15939)
- Remove sentence and break out a new line to make top section more
scannable.
2024-01-10 09:18:36 -05:00
Eric
ad4737036b
Docs: Add downgrading Fleet page (#15788)
Closes: https://github.com/fleetdm/confidential/issues/4665

Changes: 
- Added a new documentation page that provides instructions for
downgrading from Fleet premium. The content for this section was pulled
from a [commented-out FAQ
question](1d2f5ae42a/docs/Get%20started/FAQ.md (L363-L394)).

---------

Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-01-08 17:01:47 -06:00
Tim Lee
2f937ce9a2
Docs: Host Details Pack Stats API (#15672) 2024-01-04 11:16:47 -07:00
Lucas Manuel Rodriguez
bd16acb66e
Adding doc changes for configuring fleetd channels remotely (#15872)
#13825

Creating a separate PR to not block on docs review.
2024-01-04 10:23:51 -03:00
Noah Talerman
72ccbbbc6f
Update supported operating systems (#15834)
- Clarify that Fleet Desktop on Fedora and Centos require Google Chrome
as the default browser.
2024-01-03 18:00:48 -05:00
Noah Talerman
3326dd4186
API design: Target hosts by serial number (#15344)
- API changes for #14748 
- Document `hardware_serial` name to be consistent w/ `hardware_serial`
parameter in hosts endpoints
2024-01-03 17:59:23 -05:00
Noah Talerman
ef75a0131e
MDM command docs (#15803)
- Fix typo. `fleetctl mdm run-command` expects `--hosts`
2024-01-03 17:58:49 -05:00
Jahziel Villasana-Espinoza
6dc9d2f6f0
fix: return better error when password is too long (#15875)
> Relevant issue: #15625

# 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/` or
`orbit/changes/`.
See [Changes
files](https://fleetdm.com/docs/contributing/committing-changes#changes-files)
for more information.
- [x] Added/updated tests
- [x] Manual QA for all new/changed functionality
2024-01-03 17:24:28 -05:00
Jahziel Villasana-Espinoza
63613ef90c
feat: update docs with new scripts disabled flag (#15888)
> Relevant issue: #14500

# 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-01-03 16:59:22 -05:00
Brock Walters
4519ff672f
Update Automations.md (#15864)
previous: ...one ticket is created per CVE regardless of the number of
hosts on which such CVE is detected.

Hope that meaning is the same? If so, what is there is a little clunky.
2024-01-03 16:22:13 -05:00
Noah Talerman
5ef01b7fd6
Fix broken anchor link in docs (#15751)
- Fix link
2024-01-02 17:15:25 -05:00
Victor Lyuboslavsky
8c9feedc98
API change: add host_count_updated_at to policies (#15765)
API Change for #15323
2024-01-02 13:41:54 -06:00
Brock Walters
fa9f1838f2
Update Troubleshooting-live-queries.md (#15681)
Not meaning to be pedantic just trying to make the flow a bit more
natural. :)

# 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/` or
`orbit/changes/`.
See [Changes
files](https://fleetdm.com/docs/contributing/committing-changes#changes-files)
for more information.
- [ ] Documented any permissions changes (docs/Using
Fleet/manage-access.md)
- [ ] 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.
- [ ] Added/updated tests
- [ ] Manual QA for all new/changed functionality
  - For Orbit and Fleet Desktop changes:
- [ ] 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)).
2023-12-21 14:48:25 -06:00
Noah Talerman
1d2f5ae42a
Update Fleet server configuration docs (#15776) 2023-12-20 16:13:48 -06:00
nonpunctual
31c2f42b73
Update segment-hosts.md (#15680) 2023-12-15 18:03:54 -05:00
Rachael Shaw
c40bd9f3c3
#12889 API design: Add software to "List hosts" response (#15019)
Proposed solution for https://github.com/fleetdm/fleet/issues/12889.
2023-12-15 15:59:45 -06:00
Rachael Shaw
197470a3ce
#14920 API design: Add device health endpoint (#15038)
Proposed first version of the device health API endpoint for #14920
2023-12-15 15:57:41 -06:00
Marko Lisica
b45737d780
Vulnerability processing docs improvement (#15306) 2023-12-15 15:54:10 -06:00
Victor Lyuboslavsky
24c9f5a4b6
Added query param to fleet/queries. (#15673)
Added query param to fleet/queries.
API change for #15630
2023-12-15 12:58:06 -06:00
Rachael Shaw
5e3f501c87
#14415 API design: Per-host query report endpoint (#14805)
Adds new API endpoint to enable displaying query reports per-host
(#14415).

---------

Co-authored-by: Tim Lee <timlee@fleetdm.com>
2023-12-15 12:27:20 -06:00
Lucas Manuel Rodriguez
024a20ac11
Allow enrolling fleetd using osquery's instance identifier (#15570)
#14879

- [X] Changes file added for user-visible changes in `changes/` or
`orbit/changes/`.
See [Changes
files](https://fleetdm.com/docs/contributing/committing-changes#changes-files)
for more information.
- [x] Added/updated tests
- [x] Manual QA for all new/changed functionality
  - For Orbit and Fleet Desktop changes:
- [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)).
2023-12-15 15:26:32 -03:00
Eric
a5065554b4
Docs: Uncomment FAQ question (#15639)
https://github.com/fleetdm/confidential/issues/4673

Changes:
- Moved the "How can I uninstall the osquery agent?" question out of the
commented-out block on the FAQ docs page.
2023-12-15 10:06:55 -06:00
Victor Lyuboslavsky
bac932bd19
Documentation for max_prepared_stmt_count requirements and update-interval. (#15495)
Documentation changes for #15476
2023-12-14 17:38:47 -06:00
Noah Talerman
0dc43b5337
Update disk encryption (#15662)
- Clarify what volume Fleet encrypts on Windows
2023-12-14 14:24:25 -05:00
Rachael Shaw
6886317cad
Docs: Update query permissions (#15154)
Updates to the "Manage access" page to reflect changes for:
+ https://github.com/fleetdm/fleet/issues/15146
+ https://github.com/fleetdm/fleet/issues/14415
2023-12-14 12:45:02 -06:00
Victor Lyuboslavsky
2520fc2179
Reduce server load for fleetd upgrade (#15606)
📺 Loom:
https://www.loom.com/share/9e17848963574af3aa10d426b450bcd0?sid=f8078293-c7e1-4864-a8a3-4cec996971f5

#15476 
#15540 
#15542

After upgrading fleetd, customer-blanco saw a spike in traffic and a
spike in DB connections. These fixes attempt to reduce the traffic and
DB load when fleetd is upgraded.

On the server, added fleet/device/{token}/ping endpoint to be used by
agents to check their token.

On the agent:
- Removed call to fleet/orbit/device_token unless token needs to be
updated.
- Changed call to fleet/device/{token}/desktop with a less resource
intensive call to fleet/device/{token}/ping
- Removed call to fleet/orbit/ping

# 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/` or
`orbit/changes/`.
See [Changes
files](https://fleetdm.com/docs/contributing/committing-changes#changes-files)
for more information.
- [x] Manual QA for all new/changed functionality
  - For Orbit and Fleet Desktop changes:
- [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)).
2023-12-13 14:31:48 -06:00
Noah Talerman
053582fd88
Update disk encryption docs (#15496)
- Associated w/ this story: #15600 
- Update docs now that disk encryption enforcement is cross platform
(Windows story here: #12577)
- Remove section about resetting a password w/ disk encryption key to
reduce doc content. Remove this link from the UI
2023-12-12 15:58:26 -05:00
Noah Talerman
883652cac6
Update setup instructions for macOS MDM (#15518)
- Clarify instructions
- Add bold text style to UI elements
2023-12-11 10:02:50 -05:00
Rachael Shaw
832f7fd8b6
API changes for confidential/#2118 (#15092)
API changes for https://github.com/fleetdm/confidential/issues/2118

---------

Co-authored-by: Victor Lyuboslavsky <victor.lyuboslavsky@gmail.com>
2023-12-08 17:12:24 -06:00
Rachael Shaw
3d14cc841d
REST API docs: Consistent URL parameter formatting (#15535)
Makes parameter formatting in documented REST API paths consistent.
Previously, we were using a mix of `/foo/:parameter/bar` and
`/foo/{parameter}/bar`. This updates all URLs to use `:` instead of
`{…}`.

Also, opportunistically fixed some other inconsistent formatting I
noticed in a couple places.
2023-12-08 16:22:20 -06:00
Roberto Dip
1a526aa19f
update documentation with expected response (#15527)
for  #13251
2023-12-08 18:56:58 -03:00
Luke Heath
300d318437
Cleaning up releasing Fleet docs (#15523) 2023-12-08 15:05:07 -06:00
Luke Heath
ff45facd81
Update releasing Fleet documentation (#15506) 2023-12-08 10:29:30 -06:00
Marko Lisica
6e1dfca816
Removing duplicated "Command line flags" section (#15514) 2023-12-08 16:10:30 +01:00
Noah Talerman
f6d8bcc732
Docs for Windows MDM commands (#15371)
- Update "Commands" doc page to cover Windows MDM commands
- Remove more doc content than added
2023-12-07 14:08:04 -05:00
Marko Lisica
95a7e7f8fa
Scripts docs typo - broken link (#15485)
# 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/` or
`orbit/changes/`.
See [Changes
files](https://fleetdm.com/docs/contributing/committing-changes#changes-files)
for more information.
- [ ] Documented any permissions changes (docs/Using
Fleet/manage-access.md)
- [ ] 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.
- [ ] Added/updated tests
- [ ] Manual QA for all new/changed functionality
  - For Orbit and Fleet Desktop changes:
- [ ] 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)).
2023-12-07 17:05:40 +01:00
Noah Talerman
845ef393bb
Update scripts docs (#15416)
- Simplify usage instructions to make it more like a reference
- Move "Run script asynchronously" to contributor docs so that user
facing API docs have one best practice API endpoint for scripts. Call
synchronous endpoint "Run script"
2023-12-06 12:40:42 -05:00
Noah Talerman
8d8846ed03
Remove broken link in Enroll hosts docs (#15428)
- Remove anchor link for section that was removed in a separate PR here:
#15279
2023-12-06 09:53:16 -05:00
Sharon Katz
29580a242d
15135 remove atom package (#15410) 2023-12-04 14:26:26 -05:00
Noah Talerman
e673cc6caa
Update Enroll hosts doc page (#15279)
- Remove section about plain osquery and launcher. Using fleetd is best
practice and we want all new Fleet users to follow this best practice.
If they can't we want to learn why.
- Replace "Fleetd configuration options" section with a tip. Easier to
maintain as we add/update flags.
2023-12-04 11:19:16 -05:00
Noah Talerman
bd54184510
Puppet module docs (#15336)
- We learned from a customer that the Puppet module requires global
admin
2023-12-04 11:18:18 -05:00
Noah Talerman
4bf2635453
Enroll hosts docs (#15374)
- Move "Grant full disk access for macOS hosts" to Advanced section
2023-12-04 11:16:55 -05:00
Martin Angers
88612cdf8c
Add back Windows OS Updates documentation changes (#15363) 2023-12-04 09:50:06 -05:00
Martin Angers
6fd06d6486
Add back Windows Profiles documentation changes (#15358) 2023-12-04 08:41:37 -05:00
Eric
f14ab358fe
2023-11-21 Website: Add new usage statistics (#15263)
Closes: #15255

Changes:
- Added the usage statistics added in
https://github.com/fleetdm/fleet/pull/14216 to the inputs of the
`receive-usage-analytics` webhook.
- Updated the `receive-usage-analytics` webhook to send the new usage
statistics to Datadog.
- Added attributes for the new usage statistics to the
`HistoricalUsageSnapshot` model.
- Removed the `columnName` from the `hostsStatusWebHookEnabled`
attribute of the `HistoricalUsageSnapshot` model, the name of this
column will be changed in the database when the new columns are added to
the databse table.
- Updated the usage statistics documentation to have the new statistics.


This PR requires database migrations. When this is approved and ready to
merge, we will need to:
- [ ] Merge this PR
- [ ] Put fleetdm.com into maintenance mode while the "Deploy Fleet
website" GH action runs.
- [ ] Add the new columns to the database table
- [ ] Change the name of the `hostStatusWebhookEnabled` column to
`hostsStatusWebHookEnabled`
- [ ] Set the default values for the new columns on the existing
records.
- [ ] When the website has finished redeploying, take it out of
maintenance mode.
2023-12-01 17:59:41 -06:00
Neil Blazevic
3da2529a13
Update standard query library docs w link (#15131) 2023-11-29 17:15:40 -06:00
Noah Talerman
f5923ba422
Update usage statistics docs (#15175)
- v4.0 was a long time ago
2023-11-27 16:55:30 -05:00
Noah Talerman
e8a3643abf
Update configuration docs (#15211)
Use capital "MB"
2023-11-27 16:54:53 -05:00
Roberto Dip
9c7b740b03
disable windows profiles feature in the back-end (#15278)
per discussion in slack, reverting relevant user-facing changes for
#13281
2023-11-27 16:08:52 -03:00
Alex Mitchell
b6e1dad27e
Update fleetd.md (#14833)
Removed Orbit from top header list and the Components diagram. There is
a lot of additional Orbit content throughout this doc that needs to be
purged over time, especially when fleetctl commands are changed as the
Orbit object is eliminated.

# Checklist for submitter

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

- [ ] Changes file added for user-visible changes in `changes/` or
`orbit/changes/`.
See [Changes
files](https://fleetdm.com/docs/contributing/committing-changes#changes-files)
for more information.
- [ ] Documented any API changes (docs/REST API/rest-api.md or
docs/Contributing/API-for-contributors.md)
- [ ] Documented any permissions changes (docs/Using
Fleet/manage-access.md)
- [ ] 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.
- [ ] Added/updated tests
- [ ] Manual QA for all new/changed functionality
  - For Orbit and Fleet Desktop changes:
- [ ] 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)).
2023-11-21 21:58:47 -06:00
Sam Pfluger
b2899c402e
Handbook/company/leadership#structure-of-departmental-handbook-pages (#14811)
- Add Isabell to team table
- reorder contact-us in leadership page
- Standardize "Contact us" on all departmental pages
- Convert all responsibilities to imperative mood verb phrase
- Untangle and deduplicate Engineering <> Product groups <> Product

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-11-21 13:55:46 -06:00
Lucas Manuel Rodriguez
4194c44131
Use NVD API 2.0 to download CVE information (#15102)
#14888

@getvictor This is ready for review, but keeping as draft as there are
probably many tests that need amending.

I used the new version of the `./tools/nvd/nvdvuln/nvdvuln.go` to
compare the current vulnerabilities found in our dogfood environment
with the vulnerabilities found by the code in this PR and both results
match:
```
go run -race -tags fts5 ./tools/nvd/nvdvuln/nvdvuln.go --debug --db_dir ./local --software_from_url <dogfood URL> --software_from_api_token <API_TOKEN> --sync 2>&1 | tee out.txt
[...]
CVEs found and expected matched!
```

- [X] Changes file added for user-visible changes in `changes/` or
`orbit/changes/`.
See [Changes
files](https://fleetdm.com/docs/contributing/committing-changes#changes-files)
for more information.
- [ ] Added/updated tests
- [X] Manual QA for all new/changed functionality

---------

Co-authored-by: Victor Lyuboslavsky <victor@fleetdm.com>
Co-authored-by: Victor Lyuboslavsky <victor.lyuboslavsky@gmail.com>
2023-11-21 12:30:07 -06:00
Grant Bilstad
2f618871ca
broken link osquery extensions (#15232)
'learn how' link goes to page that no longer exists, updated to new
extensions section
2023-11-20 17:42:19 -07:00
Eric
6a6f51dce6
Website: Update usage statistics webhook inputs and HistoricalUsageSnapshot model. (#15180)
Closes: #11812

Changes:
- Renamed the `hostStatusWebhookEnabled` attribute of the
`HistoricalUsageSnapshot` model to `hostsStatusWebHookEnabled` and
updated the definition to use the existing database column name.
- Updated the inputs of the `receive-usage-analytics` webhook to accept
a `hostsStatusWebHookEnabled` input.
- Updated the usage statistics documentation to have the [correct
variable
name](36e12d02e3/server/fleet/statistics.go (L21)).
2023-11-20 15:34:19 -06:00
Marko Lisica
669be3a53c
Enroll hosts docs improvements (#14862)
Summary:
- Enroll hosts page refinement
- Since page was too long and had a lot of content I did following:
    - Moved most important sections to the top
- Did some changes to make things more consistent, when possible having
UI and CLI sections with steps (ordered list)
- Moved `Add hosts with plain osquery` to contributor docs, since I
learned this approach is used just by couple of Fleet customers, and we
don't advise this as best practice anymore
- Added overview (table of contents) on the top to make easier to
navigate through the page
- Moved some technical (advanced) topics into separate section on the
bottom of the page

---------

Co-authored-by: Noah Talerman <noahtal@umich.edu>
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-11-20 19:39:41 +01:00
Jacob Shandling
b49cea6d49
Small docs fixes (#15184)
- Fix the link to SSO Just-in-time (JIT) provisioning docs from the
config files docs
- "Settings > Organization settings > **s**ingle sign-on options" –>
"... > **S**ingle sign-on options"

---------

Co-authored-by: Jacob Shandling <jacob@fleetdm.com>
2023-11-17 09:28:49 -08:00
Noah Talerman
f24cc15546
MDM docs: custom macOS settings (#15112)
- Add info about Fleet's profile redelivery
- Cut words
2023-11-17 10:13:22 -06:00
Jahziel Villasana-Espinoza
1fca8b1e38
fix: sort order for Last restarted (#14878)
# 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/` or
`orbit/changes/`.
See [Changes
files](https://fleetdm.com/docs/contributing/committing-changes#changes-files)
for more information.
- [x] Documented any API changes (docs/REST API/rest-api.md or
docs/Contributing/API-for-contributors.md)
- [x] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements)
- [x] Added/updated tests
- [x] Manual QA for all new/changed functionality

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-11-15 16:42:57 -05:00
Roberto Dip
319b64f368
allow to set mdm.windows_settings.custom_settings in configs (#15145)
for #14361 this adds the bits related to saving a slice of strings with
paths to configuration profiles.

---------

Co-authored-by: Martin Angers <martin.n.angers@gmail.com>
Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
2023-11-15 13:58:46 -03:00
Martin Angers
8c3b23a142
Add endpoint to upload an MDM custom profile for Windows and macOS (#15150) 2023-11-15 10:58:59 -05:00
Dave Herder
daf2a4cd07
Update Automations.md - removed references for jira and zendesk desti… (#15106)
…nations being in beta

beta is complete
2023-11-13 20:37:28 -06:00
Mike Thomas
1f73ea6d6a
Guide for which API endpoints to expose (#15118)
Added a guide for which API endpoints to expose and fixed an associated
broken link. See https://github.com/fleetdm/fleet/issues/15115 for
context.

# Checklist for submitter

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

- [x] Manual QA for all new/changed functionality
2023-11-13 11:43:18 -06:00
Eric
97c63c6c05
Docs: Add pageOrderInSection meta tag to high-level-architecture.md (#15090)
Changes:
- Added a pageOrderInSection meta tag to the high level architecture
page in the contributing docs. The missing meta tag is currently
preventing the Fleet website from deploying and causing the website
tests to fail.
2023-11-10 11:10:28 -06:00
Sharon Katz
014ff490d0
arch docs (#13382)
Tech docs
2023-11-10 10:06:54 -05:00
Eric
eedb867024
Mark critical policies in standard query library. (#15070)
Closes: #14812 

Changes:
- Added a "critical" tag to critical policies in the standard query
library.
- Updated the macOS version used in the "Operating system up to date
(macOS)" policy.
- Updated the name of a policy to be in sentence case ("MDM Enrolled
(macOS)" » "MDM enrolled (macOS)")
- Updated the build-static-content script to add a `critical` attribute
to queries that have the "critical" tag.
- Updated the /queries page to add a "critical" badge to queries that
have the critical attribute.
2023-11-09 21:18:02 -06:00
Rachael Shaw
4c639a9dc7
Docs: Using Fleet > Fleet UI changes for #7766 (#14977)
+ Updated content about scheduling a query to reference saving query
results in Fleet (re: #7766).
+ Cut/combined content about managing automations.
2023-11-09 20:38:13 -06:00
Noah Talerman
efa9f34f22
Docs: CIS Benchmarks for Windows 10 (#15072)
- Fleet covers v2.0.0
2023-11-09 15:19:57 -05:00
Victor Lyuboslavsky
fcafd0e5de
Added 'after' param to /carves endpoint. (#15061)
API change for https://github.com/fleetdm/fleet/issues/14571
Reflects dev changes from PR https://github.com/fleetdm/fleet/pull/15047
2023-11-09 12:26:05 -06:00
Martin Angers
182ce615fb
Implement DELETE /mdm/profiles/{id} for Windows and macOS (#15045)
#14363 (partial implementation, missing the get/download endpoint which
will come in a subsequent PR)
2023-11-09 14:59:14 -03:00
Rachael Shaw
588555ef63
Further clarify observer permissions to view queries & query reports (#15043)
It's a bit unclear from the permissions docs _how_ observers are able to
view all queries & their reports, leading to bug reports like
[this](https://github.com/fleetdm/fleet/issues/15009).
I think the intended behavior is that observers can view all queries and
their reports **via the API** but not in the UI or fleetctl. Updated
notes to clarify. (Let me know if my interpretation is incorrect!)
2023-11-09 02:53:32 -06:00
Sarah Gillespie
2a6447d822
Improve layout of autogenerated documentation for activities log (#14928) 2023-11-08 16:17:38 -06:00
Rachael Shaw
7ff7c2dc0f
Docs: tiny formatting fix (#15036)
"true" to `true` in boolean parameter description
2023-11-08 12:04:37 -06:00
Victor Lyuboslavsky
9cd4b9e770
Adding details for /queries/run endpoint. (#14956)
From discussions on PR https://github.com/fleetdm/fleet/pull/14909
2023-11-07 17:22:55 -06:00
Victor Lyuboslavsky
aa96caa8eb
Adding REST API example how to delete all hosts. (#14952) 2023-11-06 12:29:43 -06:00
Mike McNeil
15dbc1b3af
Update FAQ.md (#14951)
Does this get folks to the right place?  The other link was broken
2023-11-06 12:34:56 +09:00
Mike McNeil
88e7cd243d
Fix fleetdm.com/docs (#14950)
caused by a typo introduced during a live @mike-j-thomas + Mike M
product marketing session on Zoom:
22af47aa92 (r131737251)
2023-11-05 00:47:14 -05:00
Mike McNeil
6d029cf2a4
Docs: Update FAQ.md (#14948) 2023-11-05 00:20:20 -05:00
Mike Thomas
22af47aa92
Update heading position on why-fleet.md (#14884)
I moved the "What's it for?" heading. After seeing it on the site
(rather than Markdown) I feel that placing it between the new paragraphs
disrupts the message.

I also addressed some grammar and formatting issues. Removed some
redundant words and rephrased a couple of sentences to give a more
personable tone.

### Original

<img width="541" alt="image"
src="https://github.com/fleetdm/fleet/assets/78363703/1e67d9f2-4912-43db-846e-1f9b8d5803f6">

### vs this PR

<img width="741" alt="image"
src="https://github.com/fleetdm/fleet/assets/78363703/4a362eec-f871-4612-a46e-1fbdfe72f21e">
2023-11-04 22:50:00 -05:00
Eric
02f2e5a661
Docs: update backticks in parameter description (#14943)
Changes:
- added backticks to a parameter description ("`"differential", or
"differential_ignore_removals"`" » "`"differential"`, or
`"differential_ignore_removals"`")...
2023-11-03 20:34:00 -05:00
Rachael Shaw
05695a0928
Docs: Config file changes for #7766 (#14946)
Add `discard_data` to query covfig example and `query_reports_disabled`
to org settings.
2023-11-03 18:00:35 -05:00
George Karr
93a4e9cc2b
Update Building-Fleet.md (#14761)
Fixing build instructions for Ubuntu as the previous instructions
install an incompatible version of npm / nodejs
2023-11-03 14:53:02 -05:00
Dustin Gerdes
2cc20ab259
Docs: removed fleet vs fleet sandbox (#14503)
If some of the following don't apply, delete the relevant line.
...

---------

Co-authored-by: Sampfluger88 <108141731+Sampfluger88@users.noreply.github.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-11-03 14:30:00 -05:00
Katheryn Satterlee
62d758762a
Fix broken link to configuration documentation (#14292) 2023-11-03 13:26:03 -05:00
RachelElysia
bdb2c4c5b7
Fleet UI: Observer+ can run policies in the UI, update docs accordingly (#14796) 2023-11-03 07:42:11 -04:00
Charles Z
a13baca0c5
Update ATC docs for TCC.db example (#14914)
I've updated the ATC example that uses TCC.db to be cross-compatible
with as many MacOS versions as possible. This is still useful as-is.

I've also added a chunk for folks to copy/paste directly into their team
settings in the UI for those not using GitOps.

Hopefully others find this helpful!
...

---------

Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
2023-11-02 21:44:53 -05:00
Isabell Reedy
95bcc0c80e
Docs: how the product sets the name attribute of the scheduled query (#14307)
@ksatter I haven't included an example of the audit logs because we
already have it elsewhere in the docs, so have just linked.

Reference: #13646 & #13648

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2023-11-02 14:57:42 -05:00
George Karr
970854e078
Switching systray dependency to one without glibc requirements (#14197) 2023-11-02 14:40:21 -05:00
Mike Thomas
5fc79b8e23
Update FAQ.md (#14844)
Fixed heading from h3 to h2.
2023-11-01 21:37:57 -05:00
Mike Thomas
9363bfd302
Update why-fleet.md (#14819)
Changes:

- Added "Why Fleet" section to incorporate Fleet's point of view.
- Updated the "What's it for" section
- Lit up some useful links
- Updated some out-of-date links

.
2023-11-01 21:36:37 -05:00
Marko Lisica
e4e11e9ea4
MDM commands API changes (#14239)
API changes for the Windows MDM command story: #13069 

Changes:
- Add cross platform endpoints used for macOS and Windows MDM commands
- Deprecate `/apple` endpoints.

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2023-11-01 18:39:34 +01:00
Mike McNeil
a3399984e1
Docs: Update FAQ.md (#14818) 2023-10-31 04:11:32 -05:00
Mike Thomas
9c6003dc12
FAQ update (#14813)
Closes https://github.com/fleetdm/fleet/issues/14814

Changes:

- moved the FAQs from the pricing page to the FAQs in the docs. The
theory is that these questions are a long way down the page and likely
being missed.
- Added five more questions and answers to the FAQ from questions that
come up during customer calls.
- Commented out existing questions. Some are out of date, and some have
been dumped into the FAQ for lack of a better place to put them. We will
continue to add to this list with stronger content from talking with
users and customers.
- added a link to the FAQ on the pricing page.
2023-10-31 00:32:48 -05:00
Rachael Shaw
0e99f5a660
Docs: Change order of query API endpoints (#14803)
Moved "List queries" to the top, to match the order of other sections of
the API. (We usually start with the endpoint to get a list of things,
_then_ the endpoint to get one thing by ID.)
2023-10-30 15:21:43 -05:00
Noah Talerman
581724809d
REST API docs (#14793)
- Update link
- Update instructions
2023-10-30 15:41:02 -04:00
Victor Lyuboslavsky
1e0fa92428
13998 host options validation (#14539)
#13998 

Cleaned up REST API input validation for hosts, carves, users endpoints.

rest-api.md changes explained:
https://www.loom.com/share/9cd82653bacb4528bdaac117ec85a976

For the following endpoints:
/api/v1/fleet/hosts
/api/v1/fleet/hosts/count
/api/v1/fleet/hosts/report
  - converted validation errors from 500 to 400 HTTP status code
- added validation that policy_id must be present when policy_response
is specified
  - added validation that policy_response must be `passing` or `failing`
  - added validation that `os_name` must be specified with `os_version`

For the following endpoint:
/api/v1/fleet/users
  - converted team_id validation error from 500 to 400 HTTP status code

For the following endpoint:
/api/v1/fleet/carves
- added rest-api.md documentation for `page`, `per_page`, `order_key`,
`order_direction`, and `expired`
- converted `expired` validation error from 500 to 400 HTTP status code

# 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/` or
`orbit/changes/`.
See [Changes
files](https://fleetdm.com/docs/contributing/committing-changes#changes-files)
for more information.
- [x] Documented any API changes (docs/Using-Fleet/REST-API.md or
docs/Contributing/API-for-contributors.md)
- [x] Added/updated tests
- [x] Manual QA for all new/changed functionality

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-10-27 15:13:20 -05:00
RachelElysia
386f2c6171
ChromeOS: [bug] Surface chrome extensions as software for ChromeOS hosts (#14624) 2023-10-27 13:04:07 -04:00
Jahziel Villasana-Espinoza
c570ef1e21
feat: make analytics always true for premium customers (#14607)
# 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/` or
`orbit/changes/`.
See [Changes
files](https://fleetdm.com/docs/contributing/committing-changes#changes-files)
for more information.
- [x] Added/updated tests
- [x] Manual QA for all new/changed functionality
2023-10-27 11:41:18 -04:00
Roberto Dip
5dfc72b2a1
allow to use --context in fleetctl mdm run-command (#14665)
for #13712
2023-10-26 19:09:31 -03:00
Lucas Manuel Rodriguez
2fd6fa4e04
Vulnerability processing should ignore software without version (#14612)
#13615

- [X] Changes file added for user-visible changes in `changes/` or
`orbit/changes/`.
See [Changes
files](https://fleetdm.com/docs/contributing/committing-changes#changes-files)
for more information.
- ~[ ] Documented any API changes (docs/Using-Fleet/REST-API.md or
docs/Contributing/API-for-contributors.md)~
- ~[ ] Documented any permissions changes (docs/Using
Fleet/manage-access.md)~
- ~[ ] 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 tests
- [X] Manual QA for all new/changed functionality
  - ~For Orbit and Fleet Desktop changes:~
- ~[ ] 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)).~
2023-10-26 18:28:08 -03:00
Roberto Dip
001120274c
adjust response status code for mdm/apple/enqueue (#14666)
For #14529
2023-10-26 18:20:11 -03:00
Marko Lisica
de5695659a
Batch-apply scripts: parameters documented incorrectly (#14653)
# Checklist for submitter

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

- [ ] Changes file added for user-visible changes in `changes/` or
`orbit/changes/`.
See [Changes
files](https://fleetdm.com/docs/contributing/committing-changes#changes-files)
for more information.
- [ ] Documented any API changes (docs/Using-Fleet/REST-API.md or
docs/Contributing/API-for-contributors.md)
- [ ] Documented any permissions changes (docs/Using
Fleet/manage-access.md)
- [ ] 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.
- [ ] Added/updated tests
- [ ] Manual QA for all new/changed functionality
  - For Orbit and Fleet Desktop changes:
- [ ] 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)).
2023-10-26 10:59:10 +02:00
Noah Talerman
f50243fe20
Windows MDM article (#14566)
Addresses: https://github.com/fleetdm/confidential/issues/3914

- Consolidate changes from #13943, #14184, and #14249 into article
- Remove "Window setup" doc page.

TODO: @spokanemac to add an image for the article and appropriate meta
tags so that the article shows up on fleetdm.com/guides

---------

Co-authored-by: spokanemac <jack@jdstrong.com>
Co-authored-by: JD <spokanemac@users.noreply.github.com>
Co-authored-by: Eric <eashaw@sailsjs.com>
2023-10-24 08:19:18 -07:00
Rachael Shaw
782d71481f
Reframe note about scheduled queries not returning errors (#14683)
Move content into a blockquote (since h3s on this page are reserved for
API endpoints), and point users toward how to get errors for a
particular query via the REST API.
2023-10-20 17:34:42 -05:00
Eric
4a6bf0d447
2023-10-24 Website: Update /try-fleet (#14638)
Closes: https://github.com/fleetdm/confidential/issues/4015

Changes:
- Changed the url for `/fleetctl-preview` to
`/try-fleet/fleetctl-preview`
- Updated the controller for the `/fleetctl-preview` page to redirect
non-logged-in users to `/try-fleet/login`
- Removed the route for `/try-fleet/sandbox-expired`, and added a
redirect going to `/try-fleet/fleetctl-preview`.
- Updated the controller for `/try-fleet/sandbox` to redirect the users
without a non-expired Sandbox instance to `/try-fleet/fleetctl-preview`.
- Updated `signup.js` to not provision Fleet sandbox instances for
users.
- Updated the `User` model to support a third `signupReason`: "Try
Fleet"
- Updated `/try-fleet/register` to submit "Try Fleet" as a
`signupReason` when users sign up.
- Renamed the files for the `/fleetctl-preview` page (`get-started` »
`fleetctl-preview`)
- Updated/removed Fleet Sandbox related handbook sections.
- Replaced the "Fleet vs Fleet Sandbox" section in the deploying
documentation with a note about `fleetctl preview`.
- Updated links to Fleet Sandbox in articles.

---------

Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
2023-10-20 13:59:18 -05:00
gillespi314
d470127352
Update docs for host disk encryption detail API response (#14628) 2023-10-20 13:55:49 -05:00
Roberto Dip
2f589ff37c
document flags required for fleetd error reporting (#14656)
For #13189, this documents the server config flag required to report
errors.
...
2023-10-19 23:49:18 -05:00
Eric
ab1d055cd4
Remove navSection meta tags from configuration documentation pages (#14646)
Closes: https://github.com/fleetdm/fleet/issues/14467
2023-10-19 17:05:08 -05:00
pacamaster
cedf1d1ebb
add line about offline (#14271)
Docs only change...

...
2023-10-19 12:23:16 -05:00
Robert Fairburn
f52a6f3070
initial byo-vpc module article (#13665) 2023-10-18 11:23:52 -05:00
Pratham
9ec2efb979
docs/MDM-Windows-setup: fixup environment variable (#14593)
The correct variable to use seems to be `FLEET_DEV_MDM_ENABLED`,
`FLEET_MDM_WINDOWS_ENABLED_AND_CONFIGURED` is not present in the
codebase
2023-10-17 21:43:41 -05:00
Mike Thomas
82534168d9
Updated grammar and typos on FAQ.md (#14587)
I was in this file and got sucked into fixing up a bunch of typos and
grammar issues. (I just had to clear all the Grammarly red marks 😵‍💫)

- Added missing punctuation
- Removed unnecessary punctuation
- Fixed some typos
- Hypenated some compound adjectives 
- Removed some unnecessary hyphens

.
2023-10-16 23:36:23 -05:00
Rachael Shaw
10ed97e570
Docs: API changes for #7766 (#13484)
Draft PR to show API changes for #7766

#13469

---------

Co-authored-by: Lucas Rodriguez <lucas@fleetdm.com>
Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
2023-10-16 23:34:32 -05:00
Lucas Amorim
637430f442
Fixing typo on the proxies page (#14576)
Fixing typos - replacing capital case with lower case.

Removed all the checklist because it doesn't apply to changes in the
documentation....
...
...

Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
Co-authored-by: Sampfluger88 <108141731+Sampfluger88@users.noreply.github.com>
2023-10-16 21:03:10 -05:00
Mike Thomas
37cacac1d8
Update to "Can you host Fleet for me?" in FAQ.md (#14585)
I added a link to the license dispenser in the "Can you host Fleet for
me?" section.

# Checklist for submitter
- [x] Manual QA for all new/changed functionality
2023-10-16 17:24:23 -05:00
Noah Talerman
fb64a9ee73
Configuration reference docs: WSTEP cert/key (#14567)
- Inform user that they will have to turn disk encryption on/off again
if they change their WSTEP cert/key pair
2023-10-16 18:08:07 -04:00
Gabriel Hernandez
db580e4eba
update broken link for mdm macOS setup assistant docs (#14530)
fix broken link for mdm macos setup docs
2023-10-16 17:03:48 -05:00
Rachael Shaw
283e694e06
Fix link formatting (#14541)
Fixed markdown syntax for links in a couple places where it was
formatted incorrectly (`(…)[…]` instead of `[…](…)`)

(Fixed one earlier and just searched the docs folder for `)[` to find
these; hopefully this PR nabs the rest.)
2023-10-16 16:52:58 -05:00
Luke Heath
1b428aff94
Fix typo on MDM-Windows-setup.md (#14552)
......
2023-10-16 16:52:28 -05:00
Lucas Manuel Rodriguez
87e2cfca71
Add query report to manage-access.md (#14542)
Adding the permissions docs change for #7766.

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-10-16 14:18:42 -03:00
Rachael Shaw
8f4ae0c50a
Small formatting fix (#14553)
Added some missing backticks where we had a larger-than-intended block
of text highlighted as code.
2023-10-14 17:03:04 -05:00
Tim Lee
148386e956
Docs: Query Report API (#14204) 2023-10-12 14:17:41 -06:00
Rachael Shaw
8bbdadfb42
Fix link formatting in "Get a list of Visual Studio Code extensions" query (#14512)
Fixed link formatting in "Get a list of Visual Studio Code extensions"
query
2023-10-12 14:44:11 -05:00
Noah Talerman
e89a919d06
Docs: Update SCEP configuration (#14234)
- Update configuration docs to clarify this and what the workaround is
if changing the cert/key is necessary (due to compromise)
- Remove words from macOS setup docs
2023-10-12 11:27:49 -04:00
Rachael Shaw
1cc6df9705
REST API docs: Fix some formatting issues (#14480)
Fixed capitalization/formatting for a few inconsistent headings I
noticed.
2023-10-11 17:48:15 -05:00
Rachael Shaw
d8aaa4e9fc
Docs: Update REST API docs for "Run automation for all failing hosts of a policy" endpoint (#13630)
+ Fixed capitalization in title
+ Shortened description, and instead linked to relevant conceptual
documentation to clarify default policy automation behavior
+ Updated parameter descriptions (and listed premium feature last)
2023-10-11 16:49:45 -05:00
Katheryn Satterlee
4c677e9a06
Update Deploy-Fleet-on-CentOS.md (#14263)
Corrected the name of the target archive for download and instructions
for accessing the Fleet binary.

# Checklist for submitter

Docs-only change
2023-10-10 23:15:42 -05:00
Mike Thomas
2e5cafba83
Fixed broken links in fleet-server-configuration.md (#14313)
fixed two broken links:

https://fleetdm.com/docs/deploy/single-sign-on-sso 
https://fleetdm.com/docs/deploy/public-ip
2023-10-11 08:01:50 +09:00
Roberto Dip
9ffa11c25d
Feat: saved scripts (#14409)
For #9537
2023-10-10 19:00:45 -03:00
Marko Lisica
8035fc7511
Normalize ".mobileconfig" and "team ID" in API docs (#14405)
# Checklist for submitter

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

- [ ] Changes file added for user-visible changes in `changes/` or
`orbit/changes/`.
See [Changes
files](https://fleetdm.com/docs/contributing/committing-changes#changes-files)
for more information.
- [ ] Documented any API changes (docs/Using-Fleet/REST-API.md or
docs/Contributing/API-for-contributors.md)
- [ ] Documented any permissions changes (docs/Using
Fleet/manage-access.md)
- [ ] 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.
- [ ] Added/updated tests
- [ ] Manual QA for all new/changed functionality
  - For Orbit and Fleet Desktop changes:
- [ ] 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)).
2023-10-10 13:10:24 -05:00
pintomi1989
b42a8b2049
docs: Removal of the "the" (#14382)
# Checklist for submitter

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

- [ ] Changes file added for user-visible changes in `changes/` or
`orbit/changes/`.
See [Changes
files](https://fleetdm.com/docs/contributing/committing-changes#changes-files)
for more information.
- [ ] Documented any API changes (docs/Using-Fleet/REST-API.md or
docs/Contributing/API-for-contributors.md)
- [ ] Documented any permissions changes (docs/Using
Fleet/manage-access.md)
- [ ] 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.
- [ ] Added/updated tests
- [ ] Manual QA for all new/changed functionality
  - For Orbit and Fleet Desktop changes:
- [ ] 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)).
2023-10-10 13:07:34 -05:00
Marcos Oviedo
f0d77ab3db
Merging Bitlocker feature branch (#14350)
This relates to #12577

---------

Co-authored-by: gillespi314 <73313222+gillespi314@users.noreply.github.com>
Co-authored-by: Roberto Dip <dip.jesusr@gmail.com>
2023-10-06 19:04:33 -03:00
Rachael Shaw
cc547ba02c
Remove list of Windows CIS policies that require a Group Policy template (#14352)
This change is to reduce surface area of the conceptual docs. We already
point users toward how to identify the policies that need a Group Policy
template:

> These items are tagged with the label
`CIS_group_policy_template_required` in the YAML file, and details about
the required Group Policy templates can be found in each item's
`resolution`.

Keeping a duplicate list here is just more surface area to maintain, aka
more content that's likely to get out-of date. (And since it's in a code
block anyway, it's not any easier to read here than by just referencing
the YAML file directly, so the user experience won't suffer from us
removing it.)
2023-10-06 12:42:19 -05:00
Eric
e7ac6d8281
Docs: Update fleetd link on anatomy page. (#14344)
closes: https://github.com/fleetdm/fleet/issues/14338
2023-10-06 11:45:27 -05:00
Rachael Shaw
d029d3f928
Docs: Add version range to "List all software" example response (#13647)
Proposed API changes for https://github.com/fleetdm/fleet/issues/11666

---------

Co-authored-by: Tim Lee <timlee@fleetdm.com>
2023-10-05 13:51:16 -05:00
Roberto Dip
1a6b1038dd
add docs for detail query overrides (#14299)
docs for https://github.com/fleetdm/fleet/pull/14296

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-10-05 14:23:13 -03:00
Noah Talerman
a40db25281
Scripts docs: Fix typo (#14300)
- Fix incorrect flag
2023-10-04 16:16:18 -04:00
Noah Talerman
9c7079f50c
Windows MDM docs: turn on Windows MDM (#13943)
- Add new "Windows setup" page to "Device Management" section of docs
- Rename "MDM setup"  page to "macOS setup." Update links and add redirect
- Rename existing "macOS setup" page to "macOS setup experience." Update links. Did not add redirect because of conflict with "macOS setup" page
- Remove "MDM" from all MDM doc page titles
2023-10-04 15:39:09 -04:00
Mo Zhu
6c5edd3ddd
Link to usage statistics config from usage statistics page (#14207)
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-10-03 17:34:46 -04:00
Mo Zhu
606e1560e0
document that vscode extension query requires fleetd (#14221) 2023-10-03 11:28:54 -04:00
Katheryn Satterlee
fce53bba9a
Update CIS-Benchmarks.md (#14242)
Add additional information about passing/failing CIS benchmark policies

# Checklist for submitter

Doc-only change
2023-10-02 13:49:58 -04:00
Sabrina Coy
90e7f2043a
Fix broken link in #macos0setuo-assistant (#14233)
Link for Fleet's example ADE profile incorrectly points to a profile
called `setup_assistant.json`. The correct profile is
`automatic_enrollment.json`. Link is corrected in the PR.
2023-10-02 11:59:22 -04:00
Sharon Katz
630466c687
#13886 chrome ext doc (#13902)
Co-authored-by: Mo Zhu <mo@fleetdm.com>
Co-authored-by: Mo Zhu <mozhu888@gmail.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-10-02 09:24:33 -04:00
Mike McNeil
0604d529df
Handbook: Explai the deal w/ hosting small Fleet instances (#14103) 2023-10-01 18:01:24 -05:00
Mike McNeil
e7dd92105e
Docs: Encourage using page over after (#14115)
Shout out to @tdiderich for pointing out this improvement.
2023-10-01 17:59:30 -05:00
Katheryn Satterlee
8852709d6e
Update messaging for contributor API (#13494)
Added additional information about what differentiates the Contributor
API routes from the public API routes.

# Checklist for submitter

Docs-only change
2023-09-29 17:03:29 -05:00
Eric
9891861e58
Website: Improve support for indented content in Markdown lists, update MDM macOS setup docs page. (#14124)
Closes: #12836 

Changes:
- Updated the `build-static-content` script to not add HTML comments to
Markdown codeblocks, and to not replace HTML comments in generated HTML
pages
- Updated the custom codeblock renderer in the `to-html` helper to add
syntax highlighting classes to Markdown codeblocks.
- Updated the indentation of content in lists on the MDM macOS setup
docs page.

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
2023-09-29 13:13:03 -07:00
Lucas Manuel Rodriguez
e1333c113f
[Hackathon] Add query to list VSCode extensions for macOS (#14213)
Co-authored-by: Sharon Katz <121527325+sharon-fdm@users.noreply.github.com>
2023-09-29 15:21:28 -04:00
Dave Herder
5696d4875b
Update Deploy-Fleet-on-Kubernetes.md (#14155)
added clarification on running Helm commands in v2 vs v3

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-09-29 11:15:44 -07:00
Tyler Diderich
878e16269b
Update Deploy-Fleet-on-CentOS.md (#14198)
Minor docs update
2023-09-29 10:24:08 -05:00
RachelElysia
86daf97425
Fleet CTL: Surface password requirements to console for FleetCTL use, update API only password example (#14171) 2023-09-28 11:21:25 -07:00
Noah Talerman
00e71761c5
Update supported Windows versions (#14188)
- Clarify that Fleet supports Windows 10+ for "Pro" and "Enterprise."
Not "Home"
2023-09-28 12:59:18 -04:00
Dave Herder
4a514311dd
Update rest-api.md (#14129) 2023-09-27 15:53:04 -07:00
Dave Herder
b50cbef42c
Update FAQ.md - remove Software Inventory instructions (#14153) 2023-09-27 15:47:57 -07:00
Mo Zhu
9d2c3f0870
Update Reference-Architectures.md (#14039)
Purpose of this change:
- Right now we don't have a guide for deploying on Azure. We want to
prompt people to ask for it by linking them to the Slack. That is a way
that we can kick off the process of writing a formal document.
2023-09-27 08:19:31 -07:00
Mo Zhu
f65d574955
state that CIS benchmark policy is tagged as level 1 and level 2 (#14156) 2023-09-26 16:12:32 -07:00
Rachael Shaw
9190975ada
Document behavior for hosts/report endpoint when filtered by policy_id but not policy_response (#14127)
Documents behavior reported in
https://github.com/fleetdm/fleet/issues/13998
2023-09-26 16:46:38 -05:00
Isabell Reedy
14d0df0f85
Specify that enroll secrets should be alphanumeric (#14030) 2023-09-26 14:38:35 -04:00
George Karr
68ac65f461
Add example errors to api docs for login (#13941) 2023-09-26 10:33:35 -05:00
Lucas Manuel Rodriguez
de4d76d09b
Documentation changes for #13926 (#14060)
Documentation changes for #13926.

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-09-26 11:49:45 -03:00
Lucas Manuel Rodriguez
2f0d0eb197
Documentation changes for #13287 (#14059)
Documentation changes for #13287.

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-09-26 11:49:30 -03:00
Isabell Reedy
81c3584bf4
Docs - mandate FileVault activation upon set-up (#13929) 2023-09-26 10:14:07 -04:00
Mo Zhu
9cce5ffd7f
2023-09-25 Update macOS supported version to match MDM (#14025) 2023-09-25 21:43:53 -05:00
Isabell Reedy
9ec5aae288
Docs - Add bytes option for Windows MDM config (#13933) 2023-09-25 17:22:52 -04:00
Luke Heath
1e1e28791f
Document milestone release ritual (#13932) 2023-09-25 14:35:36 -05:00
Jacob Shandling
5f2b83c5e6
Add documentation for using --local-wix-dir (#14070) 2023-09-25 11:05:11 -07:00
Mo Zhu
83810fb85c
Link to scalability testing for CIS benchmarks (#13799)
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-09-25 10:59:09 -07:00
Mo Zhu
3cf57dfd3b
Document that fleet tested FLEET_OSQUERY_ENABLE_ASYNC_HOST_PROCESSING… (#13966)
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-09-25 10:46:36 -07:00
Mo Zhu
56d4380ba6
State that latest version of osquery is supported (#13982)
.  ...
2023-09-25 10:34:42 -07:00
Mo Zhu
85082d7976
Remove version support from Fleet Desktop, consolidate version support (#14093)
Single place where host OS version support is listed: 


https://fleetdm.com/docs/using-fleet/supported-host-operating-systems#supported-host-operating-systems

..

Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
2023-09-23 00:27:33 -05:00
Roberto Dip
e18b6bd52b
add missing docs for org_info (#13972)
As the title says, this adds missing docs for a feature we shipped a
while ago.

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-09-22 19:15:37 -03:00
Eric
1b25187453
Docs: add syntax highlighting keywords to code blocks (#13963)
Closes: #13691

Changes: 
- Added keywords for syntax highlighting to code blocks in documentation
Markdown files.

---------

Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
2023-09-22 16:57:40 -05:00
Rachael Shaw
433212dfed
Docs: Add vulnerability description to software api 2023-09-22 14:07:31 -06:00
Roberto Dip
c508209e11
document migration webhooks (#13900)
This documents a few migration webhooks we have built, so I'm not the
only person that can run them.
2023-09-18 19:39:00 -03:00
Mo Zhu
5e531d011b
Update Supported-host-operating-systems.md (#13944) 2023-09-18 11:49:57 -07:00
Mo Zhu
e0eed5fde9
State that Chrome installation is only for root groups, not sub-groups (#13764) 2023-09-18 11:40:10 -07:00
Tim Lee
5bc6d30aa8
Add Description text to CVE Metadata (#13856) 2023-09-15 11:24:10 -06:00
Isabell Reedy
35d233eee2
Docs - Automatically set enroll secret for team created via fleetctl apply (#13928) 2023-09-15 10:56:18 -04:00
Noah Talerman
93424e08c5
Tweak scripts docs (#13937)
- Tweak verbiage to make the docs look better.
2023-09-15 09:44:13 -04:00
Tim Lee
e80ea50240
Flock vulnerability false positive (#13827) 2023-09-14 10:38:36 -06:00
Noah Talerman
25af472c91
Fix rendering in MDM docs (#13920)
- Fix strange rendering in MDM docs
2023-09-14 09:43:33 -04:00
Mike Thomas
7a4737e459
migrate remaining docs pages (#13740)
Migrated remaining docs pages as part of the July 31st docs re-org
project. (See https://github.com/fleetdm/fleet/issues/13684)

Changes:

- Removed "Commands" section from fleet-server-configuration.md
- Moved systemd, using a proxy, SSO, and public IP content to the
"Deploy" docs and added stubs in the original file to preserve
bookmarked links.
- Changed the headings of the original stubs in the point above to be
wrapped in an HTML H2 tag to hide them from the "On this page
navigation."
- Updated left side-bar styling to match wireframes.

# Checklist for submitter
- [x] Manual QA for all new/changed functionality

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-09-13 16:06:35 -07:00
Katheryn Satterlee
c671143c97
Add docs for experimental feature (#13534)
Added documentation for experimental Orbit feature to silence errors
related to enrollment for #13071

# Checklist for submitter

Docs-only change

---------

Co-authored-by: Luke Heath <luke@fleetdm.com>
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-09-13 16:21:13 -05:00
Rachael Shaw
066f4c95d7
Docs: Fix title (#13917)
Sentence-case fix
2023-09-13 15:57:30 -05:00
Noah Talerman
c481d67abb
Add docs for Fleet's Puppet module (#13837)
- Add doc page to explain setup and usage of Fleet's Puppet module
2023-09-13 16:39:41 -04:00
Roberto Dip
ea6b59f179
upgrade Go version to 1.21.1 (#13877)
For #13715, this:

- Upgrades the Go version to `1.21.1`, infrastructure changes are
addressed separately at https://github.com/fleetdm/fleet/pull/13878
- Upgrades the linter version, as the current version doesn't work well
after the Go upgrade
- Fixes new linting errors (we now get errors for memory aliasing in
loops! 🎉 )

After this is merged people will need to:

1. Update their Go version. I use `gvm` and I did it like:

```
$ gvm install go1.21.1
$ gvm use go1.21.1 --default
```

2. Update the local version of `golangci-lint`:

```
$ go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.54.2
```

3. (optional) depending on your setup, you might need to re-install some
packages, for example:

```
# goimports to automatically import libraries
$  go install golang.org/x/tools/cmd/goimports@latest

# gopls for the language server
$ go install golang.org/x/tools/gopls@latest

# etc...
```
2023-09-13 15:59:35 -03:00
George Karr
845bd6eef1
Update FAQ.md fix typo (#13828)
there is no `--osquery-channel` it's `--osqueryd-channel`
2023-09-13 12:50:51 -05:00
Dave Herder
38c31d536d
Update FAQ.md (#13713)
Added documentation about using fleetctl with context and mdm commands

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-09-12 15:35:35 -07:00
Noah Talerman
8600c8fe14
Add docs for script execution (#13807)
- Add doc page for run a script via CLI story (#9583).
2023-09-12 18:31:04 -04:00
Noah Talerman
6026130a8e
Update API docs: add get host by device token (#13761)
- Add get host by device token
- Remove this API route from the contributor docs
2023-09-12 17:13:09 -04:00