Commit graph

1461 commits

Author SHA1 Message Date
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
Noah Talerman
3dd85c6a6d
MDM docs: MDM commands (#13745)
- Add "NotNow" MDM status
2023-09-08 09:44:03 -04:00
Martin Angers
55148df9db
Update docs for the patch /config behavior of integrations (#13758)
Companion docs-only PR for https://github.com/fleetdm/fleet/pull/13743
2023-09-06 16:09:57 -04:00
Dave Herder
2edc04d60a
Update MDM-macOS-setup.md (#13513)
added clarification on SSO settings for EU Auth (MDM)

---------

Co-authored-by: Noah Talerman <noahtal@umich.edu>
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2023-09-06 10:45:11 -07:00
Roberto Dip
3e61342e73
add docs for scripts results API (#13720)
sibling PR https://github.com/fleetdm/fleet/pull/13701

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-09-06 11:47:25 -03:00
Roberto Dip
541cc638e4
Add an activity log when an script execution is requested (#13655)
For #9553
2023-09-05 20:09:29 -03:00
Tim Lee
055f8847fd
Fix policies api doc (#13721) 2023-09-05 15:37:43 -06:00
Martin Angers
d2f8e16d7e
Add documentation for env var preventing orbit from deleting the script directory (#13602) 2023-09-05 08:53:51 -04:00
Mike Thomas
bca456eba4
migrate agent options docs content to agent configuration page (#13562)
See https://github.com/fleetdm/fleet/issues/13561 for context.

Changes:

- Created new docs page `agent-configuration.md` and migrated `agent
options` content from
https://fleetdm.com/docs/configuration/configuration-files#agent-options
- Added stub linking to the new page in the original agent options
location.
- Moved content "Update agent options" out of
[fleet-ui.md](https://fleetdm.com/docs/using-fleet/fleet-ui)
- ~Renamed `fleet-ui.md` to `queries.md` to reflect its content and set
up a redirect `'GET /docs/using-fleet/fleet-ui':
'/docs/using-fleet/queries',`~
- ~Added and updated `NavSection` and `pageOrderInSection` meta tags to
reflect new navigation structure.~
- Updated
[docs/Configuration/README.md](https://github.com/fleetdm/fleet/compare/docs-migrate-agent-options-to-agent-configuration-page?expand=1#diff-acd0a2b368992abbb3fd7b55a7a159ad824706e27e24aebed50a2d48e87b5ae2)
to include a link and description for the new agent-configuration page.

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-09-04 10:00:59 +09:00
Rachael Shaw
d7586a5742
Docs: Update deployment guide title (#13621)
Update page title for Cloud.gov deployment guide to match the other
deployment guides.
2023-08-31 10:52:06 -05:00
Rachael Shaw
7d0a85bd0a
Docs: Rename "Deploy Fleet on Cloud.gov" page in nav (#13619)
Rename "Deploy Fleet on Cloud.gov" to "Cloud.gov" to match updated names
for other deployment guides:
![Screenshot 2023-08-31 at 10 22 27
AM](https://github.com/fleetdm/fleet/assets/3065949/50e7e1a2-c439-46bc-a8f8-74a3a71e016b)
2023-08-31 10:23:06 -05:00
Mike Thomas
4e1218ba42
Migrate Deploy Fleet on Render to docs. (#13017)
Migrated the "Deploy Fleet on Render" guide to the docs.

- Moved content from `/articles/deploying-fleet-on-render.md` to
`/docs/deploy-on-render.md`
- Removed `/articles/deploy-fleet-on-render.md`
- moved images from the guide to `/docs/images` and renamed
- deleted redundant article cover image
- set up redirect in `routes.js` `/deploy/deploying-fleet-on-render` =>
`/docs/deploy/deploy-on-render`

# Checklist for submitter

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

---------

Co-authored-by: Eric <eashaw@sailsjs.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-08-31 10:15:52 -05:00
Martin Angers
cbc3f32e9d
Adjust response payload, messages and validations for /scripts/run/* endpoints. (#13607) 2023-08-31 09:08:50 -05:00
Noah Talerman
6637ea6517
MDM docs: disk encryption (FileVault) (#13609)
- Update statuses to match updates we made to the UI (double check disk
encryption)
2023-08-31 09:23:22 -04:00
Mike Thomas
458dcfd366
Migrate Deploy Fleet on Hetzner Cloud (#13021)
This is the last of three PRs to migrate the deployment guides into the
docs.

Changes:

- Moved content from `/articles/deploying-fleet-on-hetzner-cloud.md` to
`/docs/deploy-on-hetzner-cloud.md`.
- Removed `/articles/deploy-fleet-on-hetzner-cloud.md`.
- Moved images from the guide to `/docs/images` and renamed.
- Deleted redundant images and article cover image.
- Set up a redirect `/deploy/deploying-fleet-on-hetzner-cloud` =>
`/docs/deploy/deploy-on-hetzner-cloud`.
- Set up a redirect `/deploy` => `/docs/deploy` to redirect "Deployment
guides" in the main nav to the docs.
- Updated display names (in the docs nav) for existing deployment guides
in the docs to match the naming convention (E.g., "Deploy Fleet on
CentOS" => "CentOS")
- Removed the deployment guides article category from the blog.

# Checklist for submitter

- [ ] Manual QA for all new/changed functionality

---------

Co-authored-by: Eric <eashaw@sailsjs.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-08-30 19:17:22 -05:00
Mike Thomas
79512076ae
Migrate Deploy Fleet on AWS to docs (#13020)
Migrated the "Deploy Fleet on AWS with Terraform" guide to the docs.

- Moved content from
`/articles/deploying-fleet-on-aws-with-terraform.md` to
`/docs/deploy-on-aws.md`.
- Removed `/articles/deploy-fleet-on-aws-with-terraform.md`.
- Moved images from the guide to `/docs/images` and renamed.
- Deleted redundant image and article cover image.
- Set up a redirect in `routes.js`
`/deploy/deploying-fleet-on-aws-with-terraform` =>
`/docs/deploy/deploy-on-aws`.

# Checklist for submitter

- [ ] Manual QA for all new/changed functionality

---------

Co-authored-by: Eric <eashaw@sailsjs.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-08-30 19:11:19 -05:00
Rachael Shaw
34474b2e1d
Docs: Move parameters tables for count policies REST API docs (#13610)
Moved "Parameters" section above "Example" for consistent order across
the page
2023-08-30 17:35:26 -05:00
Tim Lee
222b8f9f5c
paginate the policies API (#13459) 2023-08-30 16:30:17 -06:00
Roberto Dip
e6dbdf3855
document script execution flags (#13577)
docs for https://github.com/fleetdm/fleet/issues/13304 and it's sibling
PR: https://github.com/fleetdm/fleet/pull/13564
2023-08-30 10:34:45 -03:00
Sabrina Coy
9fe298700f
Update rest-api.md (#13545)
Removed superfluous "an" from line 3926.
2023-08-28 15:38:23 -04:00
Andrew Baker
ba25c5ef43
Update FAQ.md (#13529)
# 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-08-25 17:37:49 -04:00
Mo Zhu
479976460b
Clarify error logs will appear when not setting --fleet-url or --enroll-secret flags (#13500)
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-08-25 10:04:28 -07:00
Roberto Dip
71c06f69f0
add links to RFC spec in docs (#13506) 2023-08-25 13:17:18 -03:00
Roberto Dip
4be557bb57
allow padded strings in mdm/apple/enqueue endpoint (#13502)
for #11384
2023-08-24 15:17:05 -03:00
Roberto Dip
5c7019cfc4
allow clients to report errors back to the server (#13478)
for #13189, #13238 and #13239
2023-08-24 13:04:27 -03:00
Martin Angers
4045116fac
Add orbit notification and API endpoints to send/receive scripts to hosts (part 2 of ticket) (#13447) 2023-08-23 16:47:47 -04:00
TomOstertag
699701a2db
Added note about Fleet’s webhook notifications about failing policies (#13207)
Added note to clairify the default policy time intervals for the Fleet
product, and help end-users configure a more personalized experience
with Fleet.

@Sampfluger88 @mikermcneil
2023-08-23 12:25:47 -05:00
Isabell Reedy
9d99b7fb05
Documentation: Modifying built-in labels with fleetctl or REST API (#13302)
Documenting closed bug: modifying built-in labels with fleetctl or REST
API causes UI errors (#12479)
2023-08-22 20:47:56 -07:00