Commit graph

50 commits

Author SHA1 Message Date
Dante Catalfamo
f8de2d9e50
Follow redis redirects by default (#26043)
#22791

This will prevent the occasional redirect from breaking live queries.
Customers can still disable the redirects by setting
`redis.cluster_follow_redirections` to `false`.
2025-02-06 13:32:31 -05:00
Rachael Shaw
33b481fdc8
Docs v4.63.0 (#26019)
Documentation changes for 4.63.0

---------

Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
Co-authored-by: Eugene <eugene@fleetdm.com>
Co-authored-by: Ian Littman <iansltx@gmail.com>
Co-authored-by: Scott Gress <scottmgress@gmail.com>
Co-authored-by: Victor Lyuboslavsky <victor.lyuboslavsky@gmail.com>
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2025-02-04 12:38:54 -06:00
Harrison Ravazzolo
71c8467a28
Fix typos in server config documentation (#25036)
Co-authored-by: Harrison John <harrisonjohn@Harrisons-MacBook-Pro.local>
2024-12-30 13:00:43 +01:00
Rachael Shaw
c4a2bb4d6b
4.61 documentation changes (#24833)
Co-authored-by: Ian Littman <iansltx@gmail.com>
Co-authored-by: Zach Wasserman <zach@fleetdm.com>
Co-authored-by: Lucas Manuel Rodriguez <lucas@fleetdm.com>
Co-authored-by: Konstantin Sykulev <konst@sykulev.com>
Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
2024-12-17 15:39:24 -06:00
Noah Talerman
6b6eb19bb0
Fleet server configuration docs: capitalize "S3" (#24794) 2024-12-16 10:42:20 -06:00
Victor Lyuboslavsky
c4c1b65492
NDES REST API and config doc changes (#22968) 2024-11-12 11:05:33 -06:00
Noah Talerman
dabdb81be1
Update reference doc page: Fleet server configuration (#23551)
- Update section headers so that config options show up in the right
side bar. Today, there's only one header that shows up in the sidebar:
![Screenshot 2024-11-05 at 3 29
29 PM](https://github.com/user-attachments/assets/a208f6fa-d48d-482d-b689-36ba36fb8764)
- Remove "Example YAML" sections b/c they're redundant. More to maintain
2024-11-06 16:38:35 -06:00
Rachael Shaw
8fa5aafa9d
Update configuration docs (#22990)
Move `license.enforce_host_limit` to contributor docs
2024-10-23 10:50:08 -05:00
Noah Talerman
527021641b
Reference docs: Store bootstrap package outside the Fleet database (#20671)
Reference docs and website redirect for the following story:
- #19037
2024-09-11 13:59:55 -05:00
Victor Lyuboslavsky
5eab74709d
Doc updates for #21038 (#21125) 2024-09-11 09:28:18 -04:00
Noah Talerman
e9b2217ae8
Update Fleet server configuration docs (#21283)
- Osquery configuration isn't server config
- Condense top section by removing examples
2024-08-13 13:56:04 -07:00
Dante Catalfamo
5e1a3d03ae
MySQL 8.0 Migration (#20225)
#17249
2024-07-22 16:27:36 -04:00
Benjamin Edwards
e52f6c8291
update GCP terraform code to be compatible with software installers updates (#20585) 2024-07-22 11:23:44 -04:00
Austin Culter
137f58eae3
Minor Fix Fleet Server Configuration Docs Markdown Docs (#20498)
- Removes _"Optional unique identifier that can be used by the principal
assuming the role to assert its identity."_ text as it:
1. Is (possibly?) duplicative of _"AWS STS External ID to use for
Firehose authentication. This is typically used in conjunction with an
STS role ARN to ensure that only the intended AWS account can assume the
role."_
2. Seems ill-placed (even if it should persist, if should probably be
nested under the [`firehose​_sts​_external​_id`
heading](https://fleetdm.com/docs/configuration/fleet-server-configuration#firehose-sts-external-id))
- Fixes markdown formatting on `firehose_sts_assume_role_arn` by adding
another newline char so the resulting HTML gets properly rendered (as an
`<h5>`) _outside the `<ul>` tag:_

![image](https://github.com/user-attachments/assets/ace319f7-a2ac-4a6b-93d7-ef19414e2c46)

Currently looks like this on [Fleet Server Configuration
page](https://fleetdm.com/docs/configuration/fleet-server-configuration):

![image](https://github.com/user-attachments/assets/95114996-41af-4ea8-9cc5-677b49fdcf84)

# Checklist for submitter

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

(None of the checklist items applied to this change.
2024-07-17 16:51:38 -04:00
Noah Talerman
36f7406eda
Server configuration docs: Comment out section (#20034)
- See commented out section for context
2024-06-28 17:11:02 -04:00
Noah Talerman
e9d4749eb8
Server configuration docs: S3 for software and carves (#20032)
Docs from changes to address following bug:
- #19526
2024-06-28 10:40:02 -04: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
6aef9520e9
MDM setup docs: APNs and ABM in the UI (#19463) 2024-06-07 14:33:00 -07: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
Roberto Dip
178c0d565f Merge remote-tracking branch 'origin/main' into feat-save-certs 2024-05-30 18:34:40 -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
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
Benjamin Edwards
677835e2c3
support external id in STS Assume Role calls (#18901) 2024-05-21 13:19:35 -04: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
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
42aeb9f75e
Sentence-case fix (#17611)
+ Fix casing of "External activity audit logging"
+ Fix a nearby typo
2024-03-13 18:00:06 -05: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
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
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
Noah Talerman
ffa929b24d
Server configuration docs: enable_scheduled_query_stats (#16571)
- Clearly document the behavior for `enable_scheduled_query_stats`
2024-02-02 15:49:53 -05:00
Noah Talerman
2132c7ee17
Update Fleet server configuration docs (#16054)
- Pull info about duration-based settings to the top to make it clear.
For this bug: #15926
- Add info about self-managed v. managed-cloud customers
- Cut content
2024-01-12 17:28:18 -05:00
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
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
Noah Talerman
e8a3643abf
Update configuration docs (#15211)
Use capital "MB"
2023-11-27 16:54:53 -05: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
Mike Thomas
1f73ea6d6a
Guide for which API endpoints to expose (#15118)
Added a guide for which API endpoints to expose and fixed an associated
broken link. See https://github.com/fleetdm/fleet/issues/15115 for
context.

# Checklist for submitter

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

- [x] Manual QA for all new/changed functionality
2023-11-13 11:43:18 -06:00
Eric
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
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
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
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
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
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
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
Renamed from docs/Deploying/Configuration.md (Browse further)