Elgato_dark/fleet
1
0
Fork 0
mirror of https://github.com/fleetdm/fleet synced 2026-05-21 16:08:47 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 100
fleet/docs/Configuration/README.md

14 lines
500 B
Markdown
Raw Normal View History

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 22:40:01 +00:00
# Configuration
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 01:00:59 +00:00
## Fleet server
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 22:40:01 +00:00
### [Fleet server configuration](./fleet-server-configuration)
Documentation for configuring the Fleet binary, managing osquery configurations, and running with systemd.
### [Configuration files](./configuration-files/README.md)
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 01:00:59 +00:00
How to use configuration files and the fleetctl command line tool to configure Fleet.
## Agent
### [Agent configuration](./agent-configuration)
Learn how to set agent options with `config` YAML file and the fleetctl command line tool.
Reference in a new issue Copy permalink