Commit graph

2007 commits

Author SHA1 Message Date
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
Noah Talerman
c7dfaf45f7
Update docs: Vulnerability Processing page (#19861)
- Fleet detects vulns (CVEs) for Linux kernels: #18053
2024-06-20 12:55:45 -05:00
Victor Lyuboslavsky
e3510cdcf6
Add exclude_software query param to hosts endpoint. (#19617)
API docs change for #19348
2024-06-20 08:06:46 -05:00
Victor Lyuboslavsky
c3efefa44a
Updated locked_host activity docs. (#19792)
#19545
Updated locked_host activity docs.
2024-06-17 11:54:56 -05:00
Dave Herder
bb6ee46987
fix a broken link in MDM-setup section (#19756)
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-06-14 12:17:33 -07:00
Noah Talerman
a327aacdc4
REST API docs: Fix typo (#19729) 2024-06-13 13:43:17 -04:00
Marko Lisica
f71819a673
API design: Webhooks for global activity feed (#19725)
API design for: #14722

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-06-13 17:31:56 +02:00
Noah Talerman
19cd94385f
Contributor docs: APNs and ABM in the UI (#19549)
- Remove outdated sections
2024-06-12 18:31:09 -04:00
Noah Talerman
d7394aae6b
Device management > Setup and Commands docs: iOS/iPadOS (#19590)
- Update "Setup" and "Commands" doc pages to mention iOS and iPadOS.
2024-06-12 18:30:46 -04:00
Noah Talerman
80677d1dd0
REST API docs: Add policy (#19699)
- Fix typo in descriptions
- Remove legacy/deprecated way of adding a policy
2024-06-12 18:30:28 -04:00
Noah Talerman
bac033e0d6
REST API docs: manual enrollment profile (#19593)
- Clarify that the manual enrollment profile is unsigned
2024-06-12 18:29:19 -04:00
Rachael Shaw
5b4488c6b7
API docs: Update macos_settings and windows_settings format (#19476)
Noticed several places where the structure of
`mdm.macos_settings.custom_settings` and
`mdm.windows_settings.custom_settings` didn't match the example response
for "Get configuration" (which I think is the most up-to-date).

(Will follow up and update the parameter descriptions for
`mdm.macos_settings.custom_settings`/`mdm.windows_settings.custom_settings`
to clarify they're objects with `path` and `labels` once
https://github.com/fleetdm/fleet/pull/19424 is merged.)

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2024-06-12 15:45:26 -05:00
Dave Herder
6c44a12a9e
Fix dead rotating enroll secrets guide link (#19667) 2024-06-11 15:56:20 -07:00
Noah Talerman
08c5867260
Update segment hosts (teams) docs (#19589)
- Add Fleet's best practice
2024-06-11 17:50:33 -04:00
Noah Talerman
6aef9520e9
MDM setup docs: APNs and ABM in the UI (#19463) 2024-06-07 14:33:00 -07:00
Rachael Shaw
97cc5d17ea
Remove "available in Fleet Premium" note from scripts permissions docs (#19492)
Scripts are available to free users.
2024-06-06 11:15:56 -05:00
Marko Lisica
5ff86f0b8e
Software permissions changes (#19405)
Adding new rows to manage access table to reflect new permissions added
with #14921
2024-06-06 10:12:12 -05:00
Roberto Dip
8bc79f8478
add documentation for edge case scenario (#19496)
for #16857
2024-06-05 13:55:53 -03:00
Marko Lisica
83edd57eca
Update scripts docs (#19419)
With #17321 we added support for `zsh` interpreter and we want to
document this.

@spokanemac had a hard time understanding that we don't support `.zsh`
extension while dogfooding the feature. I added note to explain that
user must create `.sh` file with `/bin/zsh` interpreter specified.
2024-06-04 08:17:00 +02:00
Noah Talerman
23ae7c763c
Server configuration docs: APNs and ABM in the UI (#19461)
- Add redirect for error message on Fleet server startup if private key
is missing: #19455
- Move the APNs and ABM environment variables to contributor docs. They
will no longer be used
2024-06-03 15:45:41 -04: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
gillespi314
949acfb2bd Merge branch 'main' into feat-software-self-service 2024-05-31 16:35:56 -05:00
Gabriel Hernandez
af88da49bc Merge branch 'main' into feat-software-self-service 2024-05-31 18:15:19 +01:00
Roberto Dip
1c2ee0c949 Merge remote-tracking branch 'origin/main' into feat-save-certs 2024-05-31 09:34:48 -03:00
Eric
7b1a56f752
Docs: fix broken link (#19345)
Changes:
- Fixed a broken link on the "macOS setup experience" docs page.
2024-05-30 17:12:40 -05:00
Noah Talerman
e26f1af309
Fix MDM setup docs (#19343)
- You only need the APNs cert for renewing APNs
2024-05-30 18:04:57 -04:00
Roberto Dip
178c0d565f Merge remote-tracking branch 'origin/main' into feat-save-certs 2024-05-30 18:34:40 -03:00
Rachael Shaw
77228ff433
Fleet configuration API docs: Document server_settings.enable_analytics (#19384)
`server_settings.enable_analytics` was only documented in the "Get
configuration" endpoint and nowhere else. Added to "Modify
configuration" params and example response.
2024-05-30 14:24:19 -05:00
Rachael Shaw
61f366fe3a
#18187 API docs: AI-generated calendar description for policy remediation (#19383)
Documents the new Fleet configuration setting:
`server_settings.ai_features_disabled`

For #18187
2024-05-30 14:09:25 -05:00
Rachael Shaw
8daa61d963
#15605 API docs: Merge inherited & team queries/policies (#19375)
New PR to avoid affecting PR open time KPI. See previous PR discussion
here: https://github.com/fleetdm/fleet/pull/17227
2024-05-30 12:16:08 -05:00
Rachael Shaw
9afe9f3e0c
#16989 API design: Settings to automatically delete activity (#19374)
New PR to avoid affecting PR open time KPI. See draft PR for previous
discussion: https://github.com/fleetdm/fleet/pull/17809
2024-05-30 12:07:38 -05:00
Martin Angers
3e2f5e97e5 Regenerate docs 2024-05-29 16:15:51 -04:00
Martin Angers
6b9fecf172 Fix conflicts 2024-05-29 16:08:51 -04:00
Andrwe Lord Weber
a8a1054b36
add linux platform tuxedo (#19011)
# Changes

I'm running orbit based osqueryd on a laptop with [Tuxedo
OS](https://www.tuxedocomputers.com/en/TUXEDO-OS_1.tuxedo#).
This OS identifies its platform via osquery as `tuxedo` and is therefore
not recognized by the Fleet server:

```json
{
    "err": "unrecognized platform",
    "hostID": 76,
    "level": "error",
    "platform": "tuxedo",
    "ts": "2024-05-15T13:17:34.513509387Z"
}
```

This causes policy and scheduled queries to not being run on my system.
With this PR Im adding `tuxedo` to all occurrences found when searching
for `kali`.

Additionally pre-commit checks were failing for me locally as it could
not find the hook-id `RuboCop`. This could be solved by using `rubocop`
instead.
Afterwards all pre-commit checks succeeded locally.

# Checklist for submitter

- [x] Added/updated tests

Signed-off-by: Andreas Ulm <andreas.ulm@prisma-capacity.eu>
2024-05-29 13:54:07 -03:00
Jahziel Villasana-Espinoza
5d40c4c352 feat: add note about updating 2024-05-29 10:53:39 -04:00
Jahziel Villasana-Espinoza
52a1d3f480 fix: truncate key, docs 2024-05-29 10:36:38 -04:00
Noah Talerman
84a1c84244
Update docs: Best practice infra for deploy security agents (#19251)
- Add S3 to AWS reference architecture docs
- Add note that GCP support for add/install software (deploy security
agents) and file carves is coming soon
- Add note that Render support for add/install software (deploy security
agents) is coming soon
- Update links to best practice Terraform example
2024-05-28 14:41:54 -04:00
Martin Angers
1b9f5a79a5
Software SS: activities (#19292) 2024-05-28 10:44:06 -04:00
Eric
7bd7c023e2
Docs: Fix broken relative link on SSO docs page (#19216)
Changes:
- Fixed a broken relative link
2024-05-24 16:57:29 -05:00
Noah Talerman
95910d3e43
Update docs: Maintenance windows (Fleet in your calendar) (#19232)
Doc updates for the "Maintenance windows (Fleet in your calendar)" story
(#17230)
2024-05-23 17:07:53 -04:00
Noah Talerman
27cc943a4b
Sever config docs: Deploy security agents (#19236)
Server configuration doc changes for "Deploy security agents" story
(#14921)
2024-05-23 17:07:28 -04:00
Noah Talerman
23e80f2ce4
API design: Deploy security agents to macOS, Windows, and Linux hosts (#19245)
API changes for:
- #14921
2024-05-23 17:07:07 -04:00
Mike Thomas
1dc53cfa93
Update Fleet-UI.md (#19135)
Added a note to warn UI users against using dot notation for column
names in their queries.

Closes https://github.com/fleetdm/confidential/issues/6506

(@dherder, please check my interpretation of the issue.)

---------

Co-authored-by: Dave Herder <27025660+dherder@users.noreply.github.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-05-23 15:45:27 -05:00
Noah Talerman
7bb215a0b1
Cleanup docs: Pre-fill and lock local account creation screen during out-of-the-box macOS setup (#19225)
Docs changes for "Pre-fill and lock local account creation screen during
out-of-the-box macOS setup" story (#9147)

See comment here for more context:
https://github.com/fleetdm/fleet/issues/9147#issuecomment-2127391460

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-05-23 10:33:09 -05:00
Noah Talerman
2406ab28cf
Update Supported host operating systems (#19217)
- At least 2 of Fleet's largest customers use Windows Server 2012
2024-05-22 17:56:28 -04:00
Luke Heath
cb419de31d
Update releasing Fleet contributor docs (#19188) 2024-05-21 16:50:13 -05:00
Benjamin Edwards
677835e2c3
support external id in STS Assume Role calls (#18901) 2024-05-21 13:19:35 -04:00
Noah Talerman
54cca7b28a
Docs: Fix broken links & add redirects (#19066) 2024-05-17 11:24:33 -05:00
Mike Thomas
665b5d0929
Text improvements and added "Deploy to Render" button (#19101)
- Text and style updates
- Added a Render's "Deploy to Render" button for clarity
2024-05-17 11:17:01 -05:00
Jahziel Villasana-Espinoza
c4923ffecd
Feature: software installers (#19050)
for https://github.com/fleetdm/fleet/issues/14921

# 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.
- [x] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements)
- [x] Added/updated tests
- [x] If database migrations are included, checked table schema to
confirm autoupdate
- For database migrations:
- [x] Checked schema for all modified table for columns that will
auto-update timestamps during migration.
- [x] Confirmed that updating the timestamps is acceptable, and will not
cause unwanted side effects.
- [x] Ensured the correct collation is explicitly set for character
columns (`COLLATE utf8mb4_unicode_ci`).
- [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)).
2024-05-17 10:37:45 -04: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
Roberto Dip
8d9dcafbbc Merge remote-tracking branch 'origin/main' into feat-software-installers 2024-05-16 17:23:39 -03:00
Noah Talerman
1077255791
Vulnerability processing docs: Add VS Code extensions (#19070)
- Document that Fleet now detects vulns on VS Code extensions
2024-05-16 15:41:17 -04:00
Lucas Manuel Rodriguez
bb310e685d
Support Ubuntu 24.04 with Xorg (by detecting user's DISPLAY environment variable) (#18996)
#18925 (Should also fix #17660.)

Tests:
- Ubuntu 22.04.2
	- Wayland
		- Works with chrome  
		- Doesn't work with Firefox. 
	- Xorg
		- Works with Chrome.  
		- Works with Firefox. 
- Ubuntu 24.04
	- Wayland
		- Doesn't work with Chrome. 
		- Doesn't work with Firefox. 
- Xorg (when using Xorg it defaults to `DISPLAY=:1`, and with the
changes in this PR it works):
		- Works with Chrome.  
		- Works with Firefox.  
---

How to change between Wayland and Xorg:

- Set `WaylandEnable=false` in `/etc/gdm3/custom.conf` and reboot.

---

How to determine what's running:
```sh
$ loginctl
SESSION  UID USER SEAT  TTY 
      2 1000 luk  seat0 tty2
     c2 1000 luk        

$ loginctl show-session 2 -p Type
# will output
Type=wayland
or
Type=x11
```
---

- [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.
- [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)).
2024-05-16 08:39:30 -03:00
Roberto Dip
1ef19e4ff2 Merge remote-tracking branch 'origin/main' into feat-software-installers 2024-05-15 19:55:02 -03:00
Mike Thomas
f506e85fbc
Style and typo fixes (#19008)
I fixed a couple of typos, corrected a couple of header tags, and
tightened up a couple of margins.

# Checklist for submitter

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

---------

Co-authored-by: Eric <eashaw@sailsjs.com>
2024-05-16 07:49:39 +09:00
Mike Thomas
9802ccc37a
Migrate deployment guides to articles (#19007)
This PR is a follow-up to https://github.com/fleetdm/fleet/issues/16660
to:

- Move all (non-recommended) deployment guides from the docs into
`/articles` under the `guides` category
    - AWS ECS
    - CentOS
    - Cloud.gov
    - AWS with Terraform
    - Hetzner Cloud
    - Render
    - Kubernetes
- Set up redirects for migrated articles
- Add article thumbnail and cover images

# Checklist for submitter

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

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
Co-authored-by: Eric <eashaw@sailsjs.com>
2024-05-16 07:29:51 +09:00
Noah Talerman
bddfb2271b
SSO docs: Fix typo (#19042)
- Fix numbered steps
2024-05-15 17:55:04 -04:00
Noah Talerman
af6129cc16
Update Windows MDM setup article and MDM setup docs (#18981)
- Update docs to reflect that, in order to use Autopilot, you must have
one Intune license per host (from #fleetdm/confidential#6283)
- Make "MDM setup" doc page cross platform
- Cut content
2024-05-15 15:34:58 -04:00
Eric
2dd7b6e564
Website: add "Deploy Fleet" docs page. (#18992)
https://github.com/fleetdm/fleet/issues/16660

Changes:
- Added a new page (deploy-fleet.md) to the deploying docs
- Moved the content from the following pages to the
deploy/reference-architectures page:
  - Systemd
  - Proxies
  - Public IPs
  - Monitoring Fleet
  - Introduction
- Reordered the pages in the Deploy docs folder
- Added a redirect: `/docs/deploy/introduction »
/docs/deploy/deploy-fleet`

---------

Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
2024-05-15 13:56:36 +09:00
Sam Pfluger
1b44927968
Fix broken markdown formatting (#18999)
Closes #18985 
...
2024-05-14 17:40:05 -05:00
Luke Heath
9cdd9be308
Update deploy on Render documentation (#18964) 2024-05-14 12:54:37 -05:00
Luke Heath
15ba5f3a20
Update supported browsers (#18960) 2024-05-13 17:10:21 -05:00
Rachael Shaw
7ca3bda4a4
Recategorize & reorganize /mdm/ REST API endpoints (#18886)
Original PR for API design: https://github.com/fleetdm/fleet/pull/16728

---------

Co-authored-by: George Karr <georgekarrv@users.noreply.github.com>
2024-05-10 16:57:06 -05:00
Rachael Shaw
db070837c8
API design: Create API endpoint to turn disk encryption for teams crossplatform (#18885)
Original PR: https://github.com/fleetdm/fleet/pull/16129

---------

Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2024-05-09 13:57:38 -05:00
Rachael Shaw
d1791518a4
Docs: Reduce words in a note (#18884)
published to nvd -> published
2024-05-09 13:43:11 -05:00
Jahziel Villasana-Espinoza
c88a7cf6b0
feat: software added and deleted global activities (#18798)
> Related issue: #18330 

# 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.
- [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

## Notes
- ~I added an `includeTitle bool` parameter to
`ds.GetSoftwareInstallerMetadata`. This allows for the title of the
software (from the `software_titles` page) to be fetched in
`svc.DeleteSoftwareInstaller` without an additional call to the DB.~ We
wound up deciding to just fetch the title every time.

---------

Co-authored-by: Martin Angers <martin.n.angers@gmail.com>
2024-05-08 10:08:28 -04:00
Marko Lisica
643a3eb34a
Docs: Reminder for APNs and ABM renewal (#16919)
Improve docs for APNs renewal:
- Learn users that they should check that Common name (CN) of
certificate in APNs portal should match one used in Fleet
2024-05-07 14:04:06 -04:00
Roberto Dip
e5283ef2a8 Merge remote-tracking branch 'origin/main' into feat-software-installers 2024-05-07 13:37:29 -03:00
Martin Angers
7bb726ba8e
Create and return upcoming/past host activities for software installs (#18772) 2024-05-07 11:28:16 -04:00
Rachael Shaw
6fa8763714
API design: Add declaration (DDM) profiles for macOS (#18718)
Fresh PR to avoid product design PRs messing with the PR open time KPI
(original here: https://github.com/fleetdm/fleet/pull/17369)

---------

Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
2024-05-02 17:33:06 -05:00
Rachael Shaw
e213ebde45
API design: Resend configuration profile (#18717)
Fresh PR to avoid product design PRs messing with the PR open time KPI
(previously https://github.com/fleetdm/fleet/pull/17711)

---------

Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
Co-authored-by: George Karr <georgekarrv@users.noreply.github.com>
2024-05-02 17:08:22 -05:00
Rachael Shaw
0bd2f00495
Permissions: Resend a configuration profile (#18724)
Fresh PR to avoid product design PRs messing with the PR open time KPI
(previously https://github.com/fleetdm/fleet/pull/17841)

Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
2024-05-02 17:06:36 -05:00
Rachael Shaw
080d466121
API design: Add manual labels via UI and API (#18716)
Fresh PR to avoid product design PRs messing with the PR open time KPI
(previously https://github.com/fleetdm/fleet/pull/17670)

---------

Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
2024-05-02 16:59:03 -05:00
Rachael Shaw
74eb6c4f01
API design: Add critical policy and resolution data to device health API (#18715)
Fresh PR to avoid product design PRs messing with the PR open time KPI
(original: https://github.com/fleetdm/fleet/pull/16982)

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2024-05-02 16:28:34 -05: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
Tim Lee
0a27843b83
bump golangci-lint to 1.55.2 (#18604) 2024-04-30 08:59:14 -06:00
Michael Pinto
373e9153b7
Add 2023 penetration test (#18375)
Co-authored-by: Robert Fairburn <8029478+rfairburn@users.noreply.github.com>
2024-04-29 14:39:28 -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
Marko Lisica
a0a8579b56
API design: API endpoint for updating a host's manual labels (#16979)
API design for: 
- #16767

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-04-25 15:53:01 -05:00
Rachael Shaw
1657b38eba
#17361 API changes: Add fleetd version to host details (#17814)
For #17361.

---------

Co-authored-by: Victor Lyuboslavsky <victor@fleetdm.com>
2024-04-25 13:26:28 -05:00
Rachael Shaw
de26973953
#17148 API changes: See if scripts are enabled for a host (#17813)
For #17148.
2024-04-25 13:20:01 -05:00
Marko Lisica
28e501cd3c
Docs change: Use new Software Update (DDM) for macOS Sonoma (14) and higher (#17487)
Docs changes related to:

- #17295
2024-04-25 13:19:03 -05:00
Grant Bilstad
414c27d53b
Add link to file carve contributor docs (#18309)
File carves were moved to their own section in contributor docs
https://github.com/fleetdm/fleet/pull/16877
Fixed link on API page

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-04-25 10:19:33 -06:00
Rachael Shaw
63d91526d2
A few capitalization fixes in the docs (#18416)
Sentence-casing.
2024-04-18 16:45:55 -05:00
Lucas Manuel Rodriguez
d0b02fa985
Add sequence diagram for NVD vulnerability processing (#18216)
#17966

Better view here:
https://github.com/fleetdm/fleet/blob/17966-add-sequence-diagram-oncall/docs/Contributing/Vulnerability-processing.md#cpe-and-cve-data-generation-workflow

Added these docs during my oncall time (and also during the VulnCheck PR
review).

@mostlikelee Let me know if I got this right.
2024-04-17 13:28:39 -03:00
Lucas Manuel Rodriguez
e7f61305a9
New APIs to add/remove manual labels to/from a host (#18283)
#16767

To create a manual label:
```sh
cat labels.yml
---
apiVersion: v1
kind: label
spec:
  name: Manually Managed Example
  label_membership_type: manual
  hosts:
    - lucass-macbook-pro.local
```

To add/delete a manual label to/from a host:
```
curl -k -v -X POST -H "Authorization: Bearer $TEST_TOKEN" https://localhost:8080/api/latest/fleet/hosts/1/labels -d '{"labels": ["Manually Managed Example"]}'

curl -k -v -X DELETE -H "Authorization: Bearer $TEST_TOKEN" https://localhost:8080/api/latest/fleet/hosts/1/labels -d '{"labels": ["Manually Managed Example"]}'
```

API draft changes: https://github.com/fleetdm/fleet/pull/16979/files
Figma with error strings:
https://www.figma.com/file/JiWoAiuHlkt76s3o3Uyz6h/%2316767-API-endpoint-for-updating-a-host's-manual-labels?type=design&node-id=2-130&mode=design&t=pxRPhrn6E1bOCrEd-0

- [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.
- [X] 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
- ~[ ] 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`).~
- [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)).~
2024-04-16 06:37:58 -03:00
George Karr
fa5e224a4a
Add feature to resend MDM configuration profiles (#18280)
Includes PRs #18111, #18212, and #18271
2024-04-15 16:48:42 -05:00
Sarah Gillespie
ecdcb7c2fb
Add activity item for resend configuration profile (#18271) 2024-04-15 14:18:09 -05:00
Victor Lyuboslavsky
1dc1e23b65
Removed current_instance_checks from docs. (#18186)
#16661 

Removed current_instance_checks from docs.
2024-04-15 10:25:04 -05:00
Rachael Shaw
29b482fffa
#17230 API design: Fleet in your calendar (#17552)
REST API updates for #17230.

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2024-04-12 18:01:52 -05:00
Noah Talerman
0888cdb8de
Update end user auth and SSO docs (#18127)
Docs improvements uncovered during
[dogfooding](https://github.com/fleetdm/confidential/issues/2506):

- Update end user auth docs to link to SSO docs. So the user knows what
do to get the necessary info from their IdP (create an Okta/GW app)
- Cut content from SSO docs and move Okta and Google Workspace to top
level headers
- "IDP" => "IdP"
- Use **bold** styling to indicate UI elements in docs (instead of
_italics_)

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-04-12 16:39:56 -05:00
Marko Lisica
b032ddf06e
Add missing searchable fields to docs (#17825)
Docs are missing some of the searchable fields.
2024-04-12 17:34:38 -04:00
Roberto Dip
3b96743932
document research done to extract name and version from installers (#18241)
copying what's described here
https://github.com/fleetdm/fleet/issues/17984#issuecomment-2051911744
for future reference.
2024-04-12 17:16:13 -03:00
Rachael Shaw
57a28ed18d
#14916 Configuration change: Host status webhook per-team (#15612)
Adds `webhook_settings.host_status_webhook` options to team config for
#14916.

Also updated conceptual docs that reference this config (and cut down
some content to make room).
2024-04-10 15:28:17 -05:00
Noah Talerman
65ab7a896d
Remove duplicate DEP profile example (#18114)
- Remove duplicate
- Add redirect so the example profile can move later w/o breaking links
- Update links
2024-04-09 09:47:47 -04:00
Roberto Dip
02f4d5c134
run make generate-docs for DDM activities (#17888) 2024-04-08 13:19:56 -03:00
Brock Walters
8d0d309a1f
Update macos-install-wine.sh with codesign warning (#17982)
The Wine developer does have an Apple Develeoper certificate but the
"Wine Stable" app bundle is not code-signed or notarized post-install &
disables Gatekeeper for the install. This adds a warning to the script
user about the app not being signed. post-install

---------

Co-authored-by: Victor Lyuboslavsky <victor.lyuboslavsky@gmail.com>
2024-04-05 16:14:57 -04:00
Marko Lisica
4585a6e2c2
API design: Pre-fill and lock local account creation screen during out-of-the-box macOS setup (#17118)
API design for:
- #9147
2024-04-04 14:38:42 -04:00
Victor Lyuboslavsky
5a3c54c0b6
Updated 1Password policy to only search 1 level deep for performance reasons. (#18003)
#17827 

Updated 1Password policy to only search one level deep for performance
reasons.

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2024-04-04 09:33:17 -05:00
Rachael Shaw
1d80aa7668
When flagging a parameter as premium-only, always include a period. (#18038)
For better readability: add periods as separation between the Fleet
Premium message and parameter descriptions.
   _Available in Fleet Premium_. Description text.
 _Available in Fleet Premium_ Description text.
2024-04-03 11:48:22 -05:00
Marko Lisica
87fe581b93
Scripts API: documented missing parameter and improved copy (#17881)
- Updated `GET /api/v1/fleet/scripts`: documented `team_id` parameter
that was missing
- Replaced "Upload" with "Add" since that's the language we want to use
across the product and docs.
- Removed articles from headings

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-04-01 16:53:00 -05:00
Noah Talerman
4ae6b362b9
Cut content from CIS Benchmarks (#17887)
- Remove "Overview" header 
- Cut "MDM required" and "Fleetd required" sections
- Move "How to add" above "Requirements."
- Cut the "Audit vs. remediation" section
2024-04-01 11:34:39 -04:00
Katheryn Satterlee
2479c21622
Update fleetctl-CLI.md (#17975) 2024-04-01 08:53:00 -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
Dave Herder
f4ab2125cc
Update enroll-hosts.md (#17834) 2024-03-29 16:05:46 -07:00
George Karr
0752993c93
Update MDM-macOS-setup.md (#17807) 2024-03-26 12:36:38 -05:00
George Karr
c739ed2472
Update Releasing-Fleet.md (#16725)
Updating broken link

---------

Co-authored-by: Sam Pfluger <108141731+Sampfluger88@users.noreply.github.com>
2024-03-26 12:02:09 -05:00
Noah Talerman
4271ca7fd6
Update rest-api.md (#17794)
- Clarify that hostnames are fully qualified domain names (FQDNs). FQDN
= hostname + domain.

For the following issue: #16895
2024-03-26 11:16:28 -05:00
Noah Talerman
a0e3407f21
Update rest-api.md (#17801)
- Fix anchor link
2024-03-25 09:41:12 -04:00
Eric
6ae3880704
Website: Update build script to exclude folders with an underscore prefix & rename docs/Deploy/kubernetes/ (#17817)
Closes: #17582

Changes:
- Updated the `build-static-content` script to not generate HTML pages
for files in subfolders that are prefixed with an underscore
- Renamed the `docs/Deploy/kubernetes` folder »
`docs/Deploy/_kubernetes`
- Documented this new behavior on the communications page of the
handbook.
- Updated commands on the Deploy Fleet on Kubernetes page.

---------

Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
2024-03-22 18:15:01 -05:00
Marko Lisica
a71e4c7d92
Typo: "removing" /past from host's activities API (#16871)
Typo: "removing" /past from host's activities API

# 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
- [ ] 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.
- [ ] 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)).

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-03-22 11:42:11 +01:00
Noah Talerman
3c33e83085
Update standard-query-library.yml (#17782)
- Policy's fail when they return no results
2024-03-21 18:48:56 -04:00
Rachael Shaw
44c3ba83e5
Reduce CIS benchmark documentation page contents (#17108)
+ Move specific CIS benchmark details into READMEs
+ Reduce content in Using Fleet > CIS Benchmarks

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2024-03-21 15:03:14 -05:00
Noah Talerman
1bb81c9e10
Update rest-api.md (#17686)
- Remove note about fleetd 
- Update note about MDM being turned on
2024-03-21 15:44:23 -04:00
Dante Catalfamo
bd3e775e67
Windows MDM Fix Manual Detection (#17721)
#15565 

Replace the use of the isFederated registry key with a keys that check
for AAD (Azure Active Directory, now Entra ID)

Federated enrollment (`isFederated`) seems to be when windows uses a
Discovery MDM endpoint to get its policy and management endpoint
configuration. This is always the case when a client is enrolled with
fleet, so installations always show up as automatic.

It's being replaced by a different key, `AADResourceID`, which appears
to identify the resource that controls the automated deployment. In my
tests it only appears to be populated when the computer is enrolled
through automated deployments. This key appears on both Windows 10 and
11.

There is a similar key, `AADTenantID`, which appears to identify the
client (tenant) to the Azure cloud. I haven't seen this ID in our
systems, so it is likely exclusively used in Azure. Both this key and
`AADResourceID` seem to always be set at the same time, so we only
check for the `AADResourceID`.

I've also added documentation on the registry keys I've analyzed for future reference.
2024-03-21 15:09:05 -04:00
Jacob Thorne
8ed8f3daa7
Fix Incorrect Helm Chart Keys in MySQL Installation Documentation (#17160)
This PR addresses an issue in the documentation for installing the MySQL
chart using Helm. Previously, the documentation provided a Helm install
command that incorrectly referenced mysqlUser and mysqlDatabase.
However, these keys don't exist in the chart's values.yaml file anymore.
2024-03-21 13:59:45 -05:00
Katheryn Satterlee
f018f68e46
Update script execution documentation (#17147)
Removed reference to **Scripts** tab and added instructions for
accessing the **Run Script** modal from the host detail page.

# Checklist for submitter

Docs-only change

---------

Co-authored-by: Brock Walters <153771548+nonpunctual@users.noreply.github.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-03-21 13:50:18 -05:00
Roberto Dip
85209ae758
document permissions changes for Puppet gitops (#17367)
#15337

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-03-21 13:38:06 -05:00
Noah Talerman
4a0c62613f
API design: See macOS hosts that failed DEP profile assignment (#15461) (#16166)
API changes for the "See macOS hosts that failed DEP profile assignment"
(#15461) story
2024-03-21 13:33:35 -05:00
Marko Lisica
14786afe20
API design: Increase character limit for saved scripts (#16699)
API design for:
#16668

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-03-21 13:30:48 -05:00
Martin Angers
813a831a08
Add mention of the environment variable to disable logs in integration tests (#17524) 2024-03-18 09:24:02 -04:00
Noah Talerman
7afe341017
Update Supported-host-operating-systems.md (#17661)
For the following bug: #12334

- Call out that, currently on Ubuntu, Fleet Desktop only supports
display number of `0`
2024-03-15 18:03:33 -04:00
Eric
29e66efc19
Website: Add required meta tag to page in contributing documentation (#17668)
Changes:
- Added a `pageOrderInSection` `<meta>` tag to the
`windows-mdm-glossary-and-protocol.md`
2024-03-15 13:19:54 -05:00
Dante Catalfamo
58dc1d4502
Create initial windows MDM glossary and diagram document (#17507)
```mermaid
sequenceDiagram
    participant windows as Windows
    participant orbit as Orbit
    participant server as fleet server
    loop every 30 seconds
        orbit->>+server: POST /api/fleet/orbit/config
        server-->>-orbit: pending notifications
    end
    note over orbit: receive enrollment notification
    orbit->>windows: mdmregistration.dll<br/>RegisterDeviceWithManagement
    windows->>+server: POST /api/mdm/microsoft/discovery
    server-->>-windows: EnrollmentServiceURL, EnrollmentPolicyServiceUrl
    windows->>+server: POST /api/mdm/microsoft/policy<br/>DeviceEnrollmentUserToken
    server-->>-windows: Policy Schema, Certificate requirements
    activate windows
    note left of windows: Generate keypair
    deactivate windows
    windows->>+server: POST /api/mdm/microsoft/enroll<br/>Self-signed CSR & cert values
    note right of server: Creates certificate signed by WSTEP ident key
    server-->>-windows: Signed certificate, management endpoint, enrollment parameters
    loop SYNCML MDM Protocol (mTLS)
        windows->>+server: POST /api/mdm/microsoft/management
        server-->>-windows: Response
    end
```
2024-03-15 10:02:47 -04:00
Dante Catalfamo
797e12983c
Add diagram to texting-and-local-development explaining internal certificate generation flow (#17396)
```mermaid
sequenceDiagram
    participant user as user email
    participant fleetctl as fleetctl
    participant server as fleet server
    participant fleetdm as fleetdm.com sails app
    participant apple as identity.apple.com
    link apple: PushCert @ https://identity.apple.com/pushcert
    note over fleetctl: fleetctl login
    fleetctl->>+server: login
    server-->>-fleetctl: token
    note over fleetctl: fleetctl generate mdm_apple
    fleetctl->>+server: generate certificates
    server->>server: generate self-signed SCEP cert & key
    server->>server: generate APNs key
    server->>server: generate APNs CSR
    server-)+fleetdm: request vendor signature on APNs CSR
    server-->>-fleetctl: SCEP cert, SCEP key, APNs key
    note over fleetdm: calls /ee/tools/mdm/cert
    fleetdm--)-user: vendor-signed APNs CSR
    user->>+apple: vendor-signed APNs CSR
    note right of apple: managed through web ui
    apple-->>-user: Apple-signed APNs certificate
```
2024-03-15 10:01:51 -04:00
Lucas Manuel Rodriguez
01dfce56cf
Doc changes for VSCode extensions (#17639)
Doc changes for #17003
2024-03-14 17:00:07 -03:00
Rachael Shaw
5349403374
API design: Wipe host (#17107)
REST API updates for remote wipe
([#9951](https://github.com/fleetdm/fleet/issues/9951)).
2024-03-14 14:30:16 -04:00
Rachael Shaw
bc034b6bb2
#15919 API design: Vulnerabilities page (#16443)
REST API changes for #15919

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Tim Lee <timlee@fleetdm.com>
2024-03-14 13:27:07 -05:00
Rachael Shaw
ee7dbaa5a0
#1642 API design: Populate policy data in GET /hosts API (#16582)
- Adds a `populate_policies` parameter to the "List hosts" endpoint
2024-03-14 14:07:03 -04:00
Sam Pfluger
7e4964385c
DRIs (#17614)
...
2024-03-14 10:24:53 -05:00
Rachael Shaw
42aeb9f75e
Sentence-case fix (#17611)
+ Fix casing of "External activity audit logging"
+ Fix a nearby typo
2024-03-13 18:00:06 -05:00
Luke Heath
3217e4ccf8
Specify node version required to build Fleet (#17578) 2024-03-13 17:29:15 -05:00
Austin Culter
917b8b0d85
Update broken URL to fleet-deployment.yml on "Deploy Fleet on Kubernetes" docs (#17486)
The _"Fleet's best practice `fleet-deployment.yml` file"_ link on the
["Deploy Fleet on Kubernetes" docs
page](https://fleetdm.com/docs/deploy/deploy-fleet-on-kubernetes)
doesn't actually target the YAML file it purports to and, instead, it
just points to the Markdown version of the "Deploy Fleet on Kubernetes"
docs on GitHub.

This PR changes the target URL so that link actually goes to the place
where one would expect it to (the YAML file).
2024-03-08 10:46:30 -06:00
Roberto Dip
7d0513000f
fix link in scripts docs (#17488) 2024-03-08 13:45:45 -03:00
Lucas Manuel Rodriguez
37885d0932
Remove filtering of private IPs in public IP field (#17352)
#11102

- [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-03-08 12:57:18 -03:00
Noah Talerman
d52643b3eb
Add OS updates to permissions table (#17384)
- Maintainers and up can edit OS udpates
2024-03-07 17:47:54 -05:00
Luke Heath
70d369dcf7
Update Releasing-Fleet.md (#17436) 2024-03-07 15:17:37 -06:00
Victor Lyuboslavsky
165917b492
Doc changes for running live queries with team_id=0 (No team) (#17267)
Doc changes for #16350
2024-03-07 14:23:18 -06:00
Sharon Katz
2be6a32295
Update Releasing-Fleet.md (#17233)
Swap steps 1 and 3

---------

Co-authored-by: Luke Heath <luke@fleetdm.com>
2024-03-07 15:07:00 -05:00
Eric
dcaf2d0a4c
Website: update relative link validation in markdown content (#17213)
Closes: #16797

Changes:
- Updated `build-static-content` to throw an error if an extensionless
Markdown link containing a hash link is found.
- Fixed two broken relative links in the contributing documentation
2024-03-07 13:45:41 -06:00
Victor Lyuboslavsky
e01c79ca7f
Updating server config docs. (#17214)
Server config doc updates for:
https://github.com/fleetdm/fleet/issues/16331
2024-03-07 13:22:03 -06:00
Victor Lyuboslavsky
58f30aaf99
Allowing GitOps role to read org configs -- doc change. (#17238)
Allowing GitOps role to read org configs.

Docs for https://github.com/fleetdm/fleet/pull/17223
2024-03-07 13:21:14 -06:00
Rachael Shaw
6f7fd8f881
Docs: Fix some links in the hosts API section (#17449)
Noticed a few links in the hosts section of the REST API docs that were
out-of-date or missing.
2024-03-06 16:34:29 -06:00
RachelElysia
316321e889
[released bug] Fleet Full stack: Allow teams filter when transferring hosts by filters (#17241) 2024-03-04 15:48:19 -05:00
Dante Catalfamo
e30640d701
Add mention of distutils in Building-Fleet (#17343)
Python >= 3.12 no longer ships with the `distutils` module out of the
box. It can be installed using `pip install setuptools`.

This may be fixed when updating node packages that rely on python, but
until then it may come up during `make deps`.

Reference: https://stackoverflow.com/a/76691103
2024-03-04 14:32:32 -05:00
Victor Lyuboslavsky
7a20da1f2f
Moving mdm_profiles to it-and-security/lib/mdm_profiles (#17268)
Moving mdm_profiles to it-and-security/lib/mdm_profiles so that they are
together with other gitops config files.

---------

Co-authored-by: Noah Talerman <noahtal@umich.edu>
2024-03-01 15:18:54 -06:00
Gabriel Hernandez
4fa50778ac merge main into feat-mdm-wipe-host 2024-03-01 17:08:41 +00:00
Noah Talerman
fc6fca60c7
Tweak custom OS settings docs (#17277)
- Add a link to Microsoft's docs that explain the error codes. We link
to the same page on the [MDM commands doc
page](https://fleetdm.com/docs/using-fleet/mdm-commands)
2024-03-01 12:05:36 -05:00
Rachael Shaw
dd2d6eb4d0
Update "Team member" wording in docs to reference users instead. (#17116)
+ Changed a bunch of instances of "member" to "user" to match the
updated UI (https://github.com/fleetdm/fleet/issues/15893)
+ Cut some step-by-step instructions for using the team UI from the
"Segment hosts" docs
2024-02-29 16:07:59 -05:00
Gabriel Hernandez
4ee65ce184 Merge branch 'main' into feat-mdm-wipe-host 2024-02-29 11:22:31 +00:00
Rachael Shaw
4751e6652a
API docs: Add missing Fleet Premium clarification (#17255)
+ Add some missing "_Available in Fleet Premium_." flags to `team_id`
parameter descriptions for API endpoints available in Fleet Free.
+ Remove one duplicate instance of `team_id`
2024-02-28 15:15:10 -06:00
Gabriel Hernandez
b692d7fa05 Merge branch 'main' into feat-mdm-wipe-host 2024-02-28 11:54:45 +00:00
Noah Talerman
2a60823a93
Update Kubernetes best practice docs (#16807)
- Remove example YAML file from docs to deduplicate
- Update "Prepare a new version of Fleet" handbook instructions to point
to the best practice YAML
- Add README to point to docs
- Move tools for deploying Fleet on Kubernetes to `Deploy/` folder.
- Add @dherder as CODEOWNER so that Dave gets pinged every time a
contributor wants to make a change to the Kubernetes

---------

Co-authored-by: Dave Herder <27025660+dherder@users.noreply.github.com>
Co-authored-by: Luke Heath <luke@fleetdm.com>
2024-02-27 22:49:48 -06:00
Rachael Shaw
d50ee081f2
API docs: Remove mdm.device_status and mdm.pending_action from list hosts response (#17222)
The "List hosts" endpoint doesn't actually include this information.
2024-02-27 16:05:10 -06:00
Gabriel Hernandez
01af4b78cd Merge branch 'main' into feat-mdm-wipe-host 2024-02-27 14:23:43 +00:00
Noah Talerman
4b5a84b2f1
Add page to contributor docs for custom configuration web URL (#17081)
- Move instructions for how to use custom configuration_web_url (#15633)
to contributor docs so that change to instructions go through code
review.
2024-02-27 09:06:35 -05:00
Noah Talerman
c0e27ea115
API docs: Add note to Get host by identifier (#17097)
- `hostname` isn't always unique
2024-02-27 09:06:15 -05:00
Rachael Shaw
094392798d
Fix "Team policies" API docs heading (#17191)
Change from h3 to h2 so it's visible in the side navigation.
2024-02-26 16:27:24 -06: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
Martin Angers
a01241ec2e
Remote wipe: add API endpoint and activity (#17060) 2024-02-26 11:31:00 -05:00
Brock Walters
28d4991a46
Update standard-query-library.yml (#17142)
Removing entry. 1) failed to build again. Now that this is "device
health" this query probably doesn't really fit with the rest of the list
anyway. Sorry for all the approvals...

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-02-23 17:28:31 -06:00
Rachael Shaw
1146141f2d
Fix formatting in a few places in the REST API docs (#17145)
+ Fixed some indentation
+ Added some missing commas & quotation marks
2024-02-23 17:26:39 -06:00
Brock Walters
dbed680af7
Update standard-query-library.yml (#17141)
Fixed schema error. Was missing "platform".
2024-02-23 15:44:52 -06:00
Brock Walters
308a1549eb
Update standard-query-library.yml (#17123)
Added query for listing all table names in the schema of the currently
installed Fleet version per customer request.
2024-02-23 15:58:31 -05:00
Brock Walters
a430194969
Update standard-query-library.yml (#17122)
1. Updated 1password query with final version
2024-02-23 15:58:04 -05:00
Marko Lisica
290ffd48d7
Improve fleetctl CLI docs page (#16877)
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-02-23 13:14:47 -06:00
Rachael Shaw
6a975b479e
Small grammatical fix (#17131)
Missing "the" in a note in the REST API docs and tweaked wording a
little bit.
2024-02-23 13:00:23 -06:00
Marko Lisica
489b45368e
API design: enable profiles based on labels (#15117)
API changes for the following story: 
- #14715

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
Co-authored-by: Roberto Dip <me@roperzh.com>
2024-02-23 12:54:18 -06:00
Victor Lyuboslavsky
ad6b16fa3e
Updating docs for enroll secret in system keystore (#16985)
#13832
2024-02-23 11:39:17 -06:00
Rachael Shaw
6cd2ae32dc
Document team host expiry config (#17114)
Add `host_expiry` to team configuration file example.
2024-02-22 17:52:43 -06:00
Noah Talerman
3eadde131a
Scripts are free (#17093)
- Update docs
- Update pricing page
2024-02-22 16:07:57 -06:00
Marko Lisica
12f519c853
Docs: Script library for Linux (#15484)
Docs changes for:
- #15283

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2024-02-22 13:20:04 -06:00
Marko Lisica
47e584da4f
API design: Improve troubleshooting workflow for Windows custom MDM commands and profiles (#16408)
API design for:
- #15769

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2024-02-22 13:17:37 -06:00
Rachael Shaw
07d8829d78
API design: Lock & unlock hosts (#16157)
REST API updates for remote lock
([#9949](https://github.com/fleetdm/fleet/issues/9949)).

---------

Co-authored-by: George Karr <georgekarrv@users.noreply.github.com>
2024-02-22 13:06:47 -06:00
Zak Scholl
e173e23d08
fix: update k8s manifests for kubernetes install (#16570)
When attempting to follow the kubernetes install directions I
encountered a few issues.

1. The image version was no longer hosted on dockerhub. And new versions
now are tagged with a "v" prefix.
2. The webserver was not able to bind to port 443 on a managed version
of k8s.
3. The dns name(s) for the latest redis helm chart have changed. They
are now `{release}-master` for read-write and `{release}-replica` for
read only nodes.
4. The deployment API is out of date.

This PR fixes those issues.
2024-02-21 14:57:05 -05:00
Marko Lisica
e8f979d7cf
Move "Troubleshooting live queries" page to contributors docs (#16775)
- Cut down on user facing doc content so first time Fleet users can find
the right information. This could be moved into an "Advanced" section in
the future.
2024-02-19 16:39:12 +01:00
Rachael Shaw
f3cbea355a
#4345 API design: macOS and Windows OS vulnerabilities (#15492)
Updates "Get host OS versions" endpoint to include vulnerabilities
(https://github.com/fleetdm/fleet/issues/4345)

---------

Co-authored-by: Tim Lee <timlee@fleetdm.com>
2024-02-16 18:40:33 -06:00
Noah Talerman
50edcc07d0
Docs: Windows OS updates (#16270)
Docs for the "Windows OS updates" (#11951) user story

- Update "macOS updates" doc page to cross-platform "OS updates" page
- Update pricing page
- Update copy in the UI to clarify behavior of Windows updates

---------

Co-authored-by: Eric <eashaw@sailsjs.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-02-16 14:30:00 -06:00
Noah Talerman
c723bd48b5
Configuration files page (#16937)
- Update interface to match what Fleet accepts today
2024-02-16 14:10:03 -06:00
Jahziel Villasana-Espinoza
42cb32d005
feat: update permissions docs for lock/unlock/wipe (#16892)
Part of #9949

# 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] Documented any permissions changes (docs/Using
Fleet/manage-access.md)
2024-02-16 13:26:33 -05:00
Rachael Shaw
06b0c4fee4
API design: Live query endpoint for ad-hoc queries (#16792)
API docs for https://github.com/fleetdm/fleet/issues/16805
2024-02-16 12:21:15 -06:00
Luke Heath
e74b7b9201
Add Fleetd Chrome Extension to anatomy docs (#16762) 2024-02-16 09:14:00 -06:00
Eric
dcf562c45c
Website: Fix broken docs and handbook links (#16798)
Changes:
- Updated two (broken) relative links on the "macOS updates"
documentation page to point to the documentation page on fleetdm.com
- Added a redirect to fix broken links to the product design handbook
page (/handbook/product » /handbook/product-design)
2024-02-13 16:50:12 -06:00
Martin Angers
9082438580
Feature: Remote Lock for macOS, Windows and Linux (#16783)
Feature branch for the #9949  story.

---------

Co-authored-by: Jahziel Villasana-Espinoza <jahziel@fleetdm.com>
Co-authored-by: Roberto Dip <me@roperzh.com>
Co-authored-by: Gabriel Hernandez <ghernandez345@gmail.com>
Co-authored-by: Sarah Gillespie <sarah@fleetdm.com>
2024-02-13 13:03:53 -05:00
Noah Talerman
157863a544
Update supported hosts operating systems (#16673)
Addresses the following subtask: #16073

Fleet is investing in more automated testing for MDM features.

Update the table to reflect the versions that Fleet is running tests
against:
- macOS 13 and 14
- Windows 10 and 11
- Ubuntu Linux 20+
2024-02-13 10:10:08 -05:00
Zach Wasserman
d6ef0841ec
Clarify Fleet Premium for self-hosted extension updates. (#16714) 2024-02-12 14:57:08 -08:00
Victor Lyuboslavsky
95437f9044
gitops role authorization changes for fleetctl gitops (#16710)
To support `fleetctl gitops`, gitops role can now read policies/queries
and write scripts.

# 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] Documented any permissions changes (docs/Using
Fleet/manage-access.md)
- [x] Added/updated tests
- [x] Manual QA for all new/changed functionality
2024-02-12 16:44:35 -06:00
Rachael Shaw
3c06a0e6bf
Fix "Get manual enrollment profile" formatting (#16720)
Should be an h3 and have a link @ the top of the section like other API
endpoints.
2024-02-09 15:16:52 -06:00
Eric
14010452f8
Fix broken links in documentation (#16708)
Closes: #16493

Changes:
- Fixed five broken links in Fleet's documentation
2024-02-09 15:00:04 -06:00
Rachael Shaw
102d80e463
Document how to list all hosts on "No team" (#16635)
Example of documentation work for
https://github.com/fleetdm/fleet/issues/16350
2024-02-08 16:27:38 -05:00
Eric
5c7574964f
Website: Update confusing/outdated links. (#16522)
Closes: #16451

Changes:
- Updated the "spin up for yourself" link in the FAQ to go to the
deploying docs.
- Updated the custom idp integration card link to go to the IDP
configuration section of the SSO docs page.
2024-02-07 16:56:33 -06:00
Noah Talerman
633768676a
Docs: Windows custom OS settings (profiles) (#16398)
- Update "Custom macOS settings" page to cross-platform "Custom OS
settings" page
- Match format w/ "Disk encryption" and "OS updates" pages
- Cut content and make the docs more of reference
- Link to best practice GitOps
- Update pricing page
- Add redirects
2024-02-07 17:51:23 -05:00
Sabrina Coy
33563fba6e
Update rest-api.md (#16630)
Corrected status code from `2000` to `200`
2024-02-06 17:17:26 -05:00
Brock Walters
b3acc96c4f
Update standard-query-library.yml (#16271)
It is very easy for data collection like this to veer into double /
triple negative mulitverse of madness stuff...

That said, I may have a lack of understanding about how the product
works, i.e., that a query literally must return a 0 value & not null in
order to "pass" in a policy. If so, then this works as expected.

However, if a query just needs to return empty (null) & 0 is implied in
the logic that sets a policy flag to green or red, then, as a rule,
queries like this should be always be simplified & should default to
using "positive" as opposed to "negative" logic, i.e., check if
something exists, never check if a thing does NOT exist.

# Checklist for submitter

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

- [x] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements)

- [x] Added/updated tests: Tested by adding dummy Emergency Kit.pdf
files to Desktop & Downloads, running query, then, removing files &
running query.
2024-02-06 16:27:21 -05:00
RachelElysia
f076769ee2
Documentation: Spelling and grammar fixes (#16403)
---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2024-02-06 09:19:42 -05:00
Noah Talerman
7fdda53dca
API design: Upcoming activities: Run scripts on online/offline hosts (#15931)
API changes for the "Upcoming activities: Run scripts on online/offline
hosts" (#15529) story

Changes:
- Script endpoints are available in Fleet Free and Fleet Premium
- Update `POST /scripts/run` to add a script to the bottom of the
upcoming activities
- Update `POST /scripts/run/sync`
- Add `GET /hosts/:id/activities` to show past activity feed
- Add `GET /hosts/:id/activities/upcoming` to show upcoming activity
feed
- Move docs for `GET /hosts/:id/scripts` to a new "Get host's scripts
section" under "Hosts"
2024-02-05 18:37:35 -05:00
Noah Talerman
c0f6e1f1cb
API design: Add API endpoint to get manual enrollment profile (#16252) (#16255)
API changes for the "Add API endpoint to get manual enrollment profile"
story: #16252
2024-02-05 18:35:44 -05:00
Noah Talerman
9069850585
Docs and articles: Remove Windows MDM feature flag (#16399)
- Remove feature flag from the docs and articles (it no longer exists)
- Remove mention of Windows MDM not being ready for production
2024-02-05 09:11:45 -05:00