Commit graph

1435 commits

Author SHA1 Message Date
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
Marko Lisica
5f9a7df518
Update manage-access.md (#13426)
Updated table rows related to MDM commands permission. Right now there
are just calling out macOS hosts and we're implementing MDM commands for
Windows. Additionally, there was a duplicate row in the table which I
removed.

# 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
- [ ] 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-22 12:55:14 +02:00
Mo Zhu
cc14de012d
4.35 upgrade notes (#13392)
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-08-21 13:30:56 -07:00
Martin Angers
de32faefdb
Add /scripts/run and scripts/run/sync API endpoints to run scripts (part 1) (#13417) 2023-08-21 14:47:19 -04:00
Eric
ba6dc0b524
Docs: Update tutorials and guides page (#13379)
Closes: #13126
2023-08-18 14:04:33 -05:00
Noah Talerman
6ea5455078
MDM docs: fix bug (#13370)
- Correct statuses for macOS settings
2023-08-18 13:39:52 -04:00
Eric
5c4f38d28a
Docs: Split server installation page into multiple deployment guides (#13321)
Related to #12627 

Changes:
- Removed the `docs/deploy/server-installation` page and moved the
content into three deployment guides.
- Updated links to the server installation page
- Renamed the Cloud.gov page ("Cloud.gov" » "Deploy Fleet on Cloud.gov")
2023-08-16 17:26:27 -05:00
Noah Talerman
a36cb76733
MDM docs: Add end user migration workflow (#13261)
- Add instructions for setting up end user migration workflow
- Break out a separate section to default migration workflow for
automatically enrolled (DEP hosts)
- Break out separate end user instructions for manually enrolled hosts,
automatically enrolled hosts - default migration workflow, and
automatically enrolled hosts - end user migration workflow.
2023-08-15 22:32:46 -04:00
Rachael Shaw
c5ce89f546
Docs: Update FAQ section about the "Packs" UI (#13194)
Update FAQ answer to better align with [more recent content about
packs](https://fleetdm.com/handbook/company/why-this-way#why-does-fleet-support-query-packs).
2023-08-09 11:57:00 -07:00
Martin Angers
37ba43d404
Add fleetctl upgrade-packs command to migrate 2017 packs to queries (#13078) 2023-08-08 08:21:57 -04:00
Noah Talerman
c18d04b5e0
MDM docs: typo (#13159)
Fix typo
2023-08-04 17:17:13 -04:00
RachelElysia
21961397f6
Fleet Documentation: Clarify SCEP docs (#13141) 2023-08-04 16:22:41 -04:00
Noah Talerman
06319f7453
MDM docs: End user auth (#13130)
- Add instructions for how to enable end user auth during automatic
enrollment for Macs
- Add instructions for how to add bootstrap package via UI
2023-08-04 15:44:14 -04:00
RachelElysia
b64f1b0d7a
Fleet Documentation: Remove docs about cgroups (#13143) 2023-08-04 14:40:29 -04:00
Eric
3a9d80b6a3
Docs: Update content on tutorials and guides documentation page (#13131)
Changes:
- Added links to guides to the tutorials and guides page.
2023-08-03 16:57:59 -05:00
RachelElysia
799792584a
MDM Docs: Update docs to include scep challenge and clarify environment variable naming (#13112)
---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-08-03 12:42:09 -04:00
Gabriel Hernandez
926bdd30af
doc updates for oncall and mdm migration light/dark logo feature (#12964)
quick doc change to oncall and product feature mdm migration light/dark
logos

---------

Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2023-08-03 10:38:41 +01:00
Mo Zhu
f4bf8ba8bf
Format markdown to be a bulleted list. (#13097) 2023-08-02 17:00:43 -07:00
Mo Zhu
0098baa4cc
confirm that some packages may not have installed paths because we're… (#13105)
https://fleetdm.slack.com/archives/C01EZVBHFHU/p1689371170727919
2023-08-02 16:35:37 -07:00
Mo Zhu
43f5fc1c97
Describe 4.35 migration in deployment FAQs (#12971)
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-08-01 13:36:07 -07:00
Eric
ee4ce28c02
Docs: Update documentation to reflect scheduled query changes. (#12884) 2023-07-31 16:06:07 -07:00
Mo Zhu
388d6511db
Updated REST API docs to reflect combined schedule and queries (#11742)
Co-authored-by: Rachael Shaw <r@rachael.wtf>
Co-authored-by: Lucas Rodriguez <lucas@fleetdm.com>
2023-07-31 16:05:16 -07:00
Dave Herder
d0caf81bca
Update API-for-contributors.md (#13027)
Updated the name options for the trigger endpoint
2023-07-28 14:18:45 -04:00
Eric
8fb22579ea
Reorganize Fleet documentation (#12871)
Closes: #12611

Changes:
- Added three new documentation sections `/docs/get-started/`,
`/docs/configuration` and `/docs/rest api/`
- Updated folder names: `/docs/Using-Fleet/` » `/docs/Using Fleet` and
`/docs/deploying` » `/docs/deploy/`
- Moved `/docs/using-fleet/process-events.md` to `/articles` and updated
the meta tags to change it into a guide.
- Added support for a new meta tag: `navSection`. This meta tag is used
to organize pages in the sidebar navigation on fleetdm.com/docs
- Moved `docs/using-fleet/application-security.md` and
`docs/using-fleet/security-audits.md` to the security handbook.
- Moved `docs/deploying/load-testing.md` and
`docs/deploying/debugging.md` to the engineering handbook.
- Moved the following files/folders:
- `docs/using-fleet/configuration-files/` »
`docs/configuration/configuration-files/`
- `docs/deploying/configuration.md` »
`docs/configuration/fleet-server-configuration.md`
    -  `docs/using-fleet/rest-api.md` » `docs/rest-api/rest-api.md`
- `docs/using-fleet/monitoring-fleet.md` » `docs/deploy/rest-api.md`
- Updated filenames:
- `docs/using-fleet/permissions.md` »
`docs/using-fleet/manage-access.md`
- `docs/using-fleet/adding-hosts.md` »
`docs/using-fleet/enroll-hosts.md`
    -  `docs/using-fleet/teams.md` » `docs/using-fleet/segment-hosts.md`
- `docs/using-fleet/fleet-ctl-agent-updates.md` »
`docs/using-fleet/update-agents.md`
- `docs/using-fleet/chromeos.md` »
`docs/using-fleet/enroll-chromebooks.md`
- Updated the generated markdown in `server/fleet/gen_activity_doc.go`
and `server/service/osquery_utils/gen_queries_doc.go`
- Updated the navigation sidebar and mobile dropdown links on docs pages
to group pages by their `navSection` meta tag.
- Updated fleetdm.com/docs not to show pages in the `docs/contributing/`
folder in the sidebar navigation
- Added redirects for docs pages that have moved.

.

---------

Co-authored-by: Mike Thomas <mthomas@fleetdm.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-07-27 17:40:01 -05:00
gillespi314
09e6bf9807
Update detail query ingestion and UI related to Windows MDM status (#12960) 2023-07-26 17:35:55 -05:00
Mo Zhu
8a2f44bc81
Close meta tag on "deploying fleet" > "FAQ" page (#12970) 2023-07-26 11:32:31 -05:00
Roberto Dip
02f70eb528
add instructions to develop and test the Puppet module (#12945) 2023-07-26 10:23:03 -03:00