Commit Graph

39 Commits

Author SHA1 Message Date
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
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
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
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
Noah Talerman
1d2f5ae42a
Update Fleet server configuration docs (#15776) 2023-12-20 16:13:48 -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
Marko Lisica
6e1dfca816
Removing duplicated "Command line flags" section (#15514) 2023-12-08 16:10:30 +01:00
Martin Angers
6fd06d6486
Add back Windows Profiles documentation changes (#15358) 2023-12-04 08:41:37 -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
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
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
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
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
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
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
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
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
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
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
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
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
Isabell Reedy
14d0df0f85
Specify that enroll secrets should be alphanumeric (#14030) 2023-09-26 14:38:35 -04: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
9ec5aae288
Docs - Add bytes option for Windows MDM config (#13933) 2023-09-25 17:22:52 -04: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
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
Isabell Reedy
35d233eee2
Docs - Automatically set enroll secret for team created via fleetctl apply (#13928) 2023-09-15 10:56:18 -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
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
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
RachelElysia
21961397f6
Fleet Documentation: Clarify SCEP docs (#13141) 2023-08-04 16:22:41 -04:00
Mo Zhu
f4bf8ba8bf
Format markdown to be a bulleted list. (#13097) 2023-08-02 17:00:43 -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
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