From ca27bd9d5c1b11eff474b4f8b0924f09636bda06 Mon Sep 17 00:00:00 2001 From: Renee Jackson <44620612+rlynnj11@users.noreply.github.com> Date: Wed, 22 Sep 2021 13:28:25 -0300 Subject: [PATCH] fix broken links by adding missing 0 (#2187) * fix broken links by adding missing 0 * fix broken links take 2 gather links missed in first pass --- README.md | 2 +- cypress/README.md | 4 +-- docs/01-Using-Fleet/01-Fleet-UI.md | 2 +- docs/01-Using-Fleet/02-fleetctl-CLI.md | 4 +-- docs/01-Using-Fleet/04-Adding-hosts.md | 2 +- docs/01-Using-Fleet/05-Osquery-logs.md | 14 +++++----- docs/01-Using-Fleet/06-Monitoring-Fleet.md | 4 +-- .../07-Security-best-practices.md | 2 +- docs/01-Using-Fleet/08-Updating-Fleet.md | 4 +-- docs/01-Using-Fleet/10-Teams.md | 2 +- .../13-Vulnerability-Processing.md | 2 +- docs/01-Using-Fleet/FAQ.md | 28 +++++++++---------- docs/01-Using-Fleet/README.md | 16 +++++------ docs/02-Deploying/01-Installation.md | 10 +++---- .../03-Example-deployment-scenarios.md | 18 ++++++------ docs/02-Deploying/FAQ.md | 8 +++--- docs/02-Deploying/README.md | 8 +++--- docs/03-Contributing/02-Testing.md | 4 +-- docs/03-Contributing/04-Committing-Changes.md | 2 +- docs/03-Contributing/FAQ.md | 2 +- docs/03-Contributing/README.md | 10 +++---- docs/README.md | 6 ++-- frontend/README.md | 2 +- frontend/README_deprecated.md | 2 +- handbook/README.md | 2 +- handbook/manual-qa.md | 4 +-- handbook/release-process.md | 4 +-- handbook/support-process.md | 2 +- orbit/README.md | 2 +- tools/backup_db/README.md | 2 +- tools/fleetctl-npm/README.md | 2 +- 31 files changed, 88 insertions(+), 88 deletions(-) diff --git a/README.md b/README.md index 6b622672a..c3f8ce93e 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ The Fleet UI is now available at http://localhost:1337. #### Now what? -Check out the [Ask questions about your devices tutorial](./docs/1-Using-Fleet/tutorials/Ask-questions-about-your-devices.md) to learn where to see your devices in Fleet, how to add Fleet's standard query library, and how to ask questions about your devices by running queries. +Check out the [Ask questions about your devices tutorial](./docs/01-Using-Fleet/00-Learn-how-to-use-Fleet.md#how-to-ask-questions-about-your-devices) to learn where to see your devices in Fleet, how to add Fleet's standard query library, and how to ask questions about your devices by running queries. ## Team Fleet is [independently backed](https://linkedin.com/company/fleetdm) and actively maintained with the help of many amazing [contributors](https://github.com/fleetdm/fleet/graphs/contributors). diff --git a/cypress/README.md b/cypress/README.md index c67e59da6..ab80dd206 100644 --- a/cypress/README.md +++ b/cypress/README.md @@ -1,6 +1,6 @@ # Cypress Testing -Cypress tests are designed solely for end-to-end testing. If this is your first time developing or running end-to-end tests, [Fleet testing documentation](../docs/3-Contributing/2-Testing.md) includes git instructions for test preparation and running tests. +Cypress tests are designed solely for end-to-end testing. If this is your first time developing or running end-to-end tests, [Fleet testing documentation](../docs/03-Contributing/02-Testing.md) includes git instructions for test preparation and running tests. ## Fleet Cypress directories @@ -37,6 +37,6 @@ As much as possible, assert that the code is only selecting 1 item or that the f ## Resources -- [Fleet testing documentation](../docs/3-Contributing/2-Testing.md) +- [Fleet testing documentation](../docs/03-Contributing/02-Testing.md) - [Cypress documentation](https://docs.cypress.io/api/table-of-contents) - [React testing-library query documentation](https://testing-library.com/docs/queries/about) diff --git a/docs/01-Using-Fleet/01-Fleet-UI.md b/docs/01-Using-Fleet/01-Fleet-UI.md index e6e0c6895..b90b2b2e8 100644 --- a/docs/01-Using-Fleet/01-Fleet-UI.md +++ b/docs/01-Using-Fleet/01-Fleet-UI.md @@ -27,7 +27,7 @@ To add queries to a pack, use the right-hand sidebar. You can take an existing s ![Schedule Query Sidebar](https://raw.githubusercontent.com/fleetdm/fleet/main/docs/images/schedule-query-sidebar.png) -Once you've scheduled queries and curated your packs, you can read our guide to [Working With Osquery Logs](../1-Using-Fleet/5-Osquery-logs.md). +Once you've scheduled queries and curated your packs, you can read our guide to [Working With Osquery Logs](../01-Using-Fleet/05-Osquery-logs.md). ## Configuring agent options diff --git a/docs/01-Using-Fleet/02-fleetctl-CLI.md b/docs/01-Using-Fleet/02-fleetctl-CLI.md index 396280f34..9e7ef885a 100644 --- a/docs/01-Using-Fleet/02-fleetctl-CLI.md +++ b/docs/01-Using-Fleet/02-fleetctl-CLI.md @@ -24,7 +24,7 @@ This guide illustrates: ### Running Fleet -For the sake of this tutorial, we will be using the local development Docker Compose infrastructure to run Fleet locally. This is documented in some detail in the [developer documentation](../3-Contributing/1-Building-Fleet.md#development-infrastructure), but the following are the minimal set of commands that you can run from the root of the repository (assuming that you have a working Go/JavaScript toolchain installed along with Docker Compose): +For the sake of this tutorial, we will be using the local development Docker Compose infrastructure to run Fleet locally. This is documented in some detail in the [developer documentation](../03-Contributing/01-Building-Fleet.md#development-infrastructure), but the following are the minimal set of commands that you can run from the root of the repository (assuming that you have a working Go/JavaScript toolchain installed along with Docker Compose): ``` docker-compose up -d @@ -186,7 +186,7 @@ spec: Fleet supports osquery's file carving functionality as of Fleet 3.3.0. This allows the Fleet server to request files (and sets of files) from osquery agents, returning the full contents to Fleet. -File carving data can be either stored in Fleet's database or to an external S3 bucket. For information on how to configure the latter, consult the [configuration docs](../2-Deploying/2-Configuration.md#s3-file-carving-backend). +File carving data can be either stored in Fleet's database or to an external S3 bucket. For information on how to configure the latter, consult the [configuration docs](../02-Deploying/02-Configuration.md#s3-file-carving-backend). ### Configuration diff --git a/docs/01-Using-Fleet/04-Adding-hosts.md b/docs/01-Using-Fleet/04-Adding-hosts.md index 4872b7a20..9ea6e02e3 100644 --- a/docs/01-Using-Fleet/04-Adding-hosts.md +++ b/docs/01-Using-Fleet/04-Adding-hosts.md @@ -135,4 +135,4 @@ Multiple enroll secrets can be set to allow different groups of hosts to authenticate with Fleet. When a host enrolls, the corresponding enroll secret is recorded and can be used to segment hosts. -To set the enroll secret, use the `fleetctl` tool to apply an [enroll secret spec](../1-Using-Fleet/2-fleetctl-CLI.md#enroll-secrets) +To set the enroll secret, use the `fleetctl` tool to apply an [enroll secret spec](../01-Using-Fleet/02-fleetctl-CLI.md#enroll-secrets) diff --git a/docs/01-Using-Fleet/05-Osquery-logs.md b/docs/01-Using-Fleet/05-Osquery-logs.md index 96109f95c..48223c68c 100644 --- a/docs/01-Using-Fleet/05-Osquery-logs.md +++ b/docs/01-Using-Fleet/05-Osquery-logs.md @@ -22,21 +22,21 @@ Fleet supports the following logging plugins for osquery logs: - [PubSub](#pubsub) - Logs are written to Google Cloud PubSub topics. - [Stdout](#stdout) - Logs are written to stdout. -To set the osquery logging plugins, use the `--osquery_result_log_plugin` and `--osquery_status_log_plugin` flags (or [equivalents for environment variables or configuration files](../2-Deploying/2-Configuration.md#options)). +To set the osquery logging plugins, use the `--osquery_result_log_plugin` and `--osquery_status_log_plugin` flags (or [equivalents for environment variables or configuration files](../02-Deploying/02-Configuration.md#options)). ### Filesystem The default logging plugin. - Plugin name: `filesystem` -- Flag namespace: [filesystem](../2-Deploying/2-Configuration.md#filesystem) +- Flag namespace: [filesystem](../02-Deploying/02-Configuration.md#filesystem) With the filesystem plugin, osquery result and/or status logs are written to the local filesystem on the Fleet server. This is typically used with a log forwarding agent on the Fleet server that will push the logs into a logging pipeline. Note that if multiple load-balanced Fleet servers are used, the logs will be load-balanced across those servers (not duplicated). ### Firehose - Plugin name: `firehose` -- Flag namespace: [firehose](../2-Deploying/2-Configuration.md#firehose) +- Flag namespace: [firehose](../02-Deploying/02-Configuration.md#firehose) With the Firehose plugin, osquery result and/or status logs are written to [AWS Firehose](https://aws.amazon.com/kinesis/data-firehose/) streams. This is a very good method for aggregating osquery logs into AWS S3 storage. @@ -45,7 +45,7 @@ Note that Firehose logging has limits [discussed in the documentation](https://d ### Kinesis - Plugin name: `kinesis` -- Flag namespace: [kinesis](../2-Deploying/2-Configuration.md#kinesis) +- Flag namespace: [kinesis](../02-Deploying/02-Configuration.md#kinesis) With the Kinesis plugin, osquery result and/or status logs are written to [AWS Kinesis](https://aws.amazon.com/kinesis/data-streams) streams. @@ -58,7 +58,7 @@ output in the Fleet logs and those logs _will not_ be sent to Kinesis. ### Lambda - Plugin name: `lambda` -- Flag namespace: [lambda](../2-Deploying/2-Configuration.md#lambda) +- Flag namespace: [lambda](../02-Deploying/02-Configuration.md#lambda) With the Lambda plugin, osquery result and/or status logs are written to [AWS Lambda](https://aws.amazon.com/lambda/) functions. @@ -79,7 +79,7 @@ Keep this in mind when using Lambda, as you're charged based on the number of re ### PubSub - Plugin name: `pubsub` -- Flag namespace: [pubsub](../2-Deploying/2-Configuration.md#pubsub) +- Flag namespace: [pubsub](../02-Deploying/02-Configuration.md#pubsub) With the PubSub plugin, osquery result and/or status logs are written to [PubSub](https://cloud.google.com/pubsub/) topics. @@ -88,7 +88,7 @@ Note that messages over 10MB will be dropped, with a notification sent to the fl ### Stdout - Plugin name: `stdout` -- Flag namespace: [stdout](../2-Deploying/2-Configuration.md#stdout) +- Flag namespace: [stdout](../02-Deploying/02-Configuration.md#stdout) With the stdout plugin, osquery result and/or status logs are written to stdout on the Fleet server. This is typically used for debugging or with a log diff --git a/docs/01-Using-Fleet/06-Monitoring-Fleet.md b/docs/01-Using-Fleet/06-Monitoring-Fleet.md index 99d1ac1ef..391db8812 100644 --- a/docs/01-Using-Fleet/06-Monitoring-Fleet.md +++ b/docs/01-Using-Fleet/06-Monitoring-Fleet.md @@ -54,7 +54,7 @@ Scaling Fleet horizontally is as simple as running more Fleet server processes c The Fleet/osquery system is resilient to loss of availability. Osquery agents will continue executing the existing configuration and buffering result logs during downtime due to lack of network connectivity, server maintenance, or any other reason. Buffering in osquery can be configured with the `--buffered_log_max` flag. -Note that short downtimes are expected during [Fleet server upgrades](./8-Updating-Fleet.md)-fleet.md) that require database migrations. +Note that short downtimes are expected during [Fleet server upgrades](./08-Updating-Fleet.md)-fleet.md) that require database migrations. ### Debugging performance issues @@ -68,7 +68,7 @@ For performance issues in the Fleet server process, please [file an issue](https ##### Generate debug archive (Fleet 3.4.0+) -Use the `fleetctl archive` command to generate an archive of Fleet's full suite of debug profiles. See the [fleetctl setup guide](./2-fleetctl-CLI.md)) for details on configuring `fleetctl`. +Use the `fleetctl archive` command to generate an archive of Fleet's full suite of debug profiles. See the [fleetctl setup guide](./02-fleetctl-CLI.md)) for details on configuring `fleetctl`. The generated `.tar.gz` archive will be available in the current directory. diff --git a/docs/01-Using-Fleet/07-Security-best-practices.md b/docs/01-Using-Fleet/07-Security-best-practices.md index 4311907ce..caa13d02b 100644 --- a/docs/01-Using-Fleet/07-Security-best-practices.md +++ b/docs/01-Using-Fleet/07-Security-best-practices.md @@ -33,7 +33,7 @@ Passwords are never stored in plaintext in the database. We store a `bcrypt`ed h ### Authentication tokens -The size and expiration time of session tokens is admin-configurable. See [The documentation on session duration](../2-Deploying/2-Configuration.md#session_duration). +The size and expiration time of session tokens is admin-configurable. See [The documentation on session duration](../02-Deploying/02-Configuration.md#session_duration). It is possible to revoke all session tokens for a user by forcing a password reset. diff --git a/docs/01-Using-Fleet/08-Updating-Fleet.md b/docs/01-Using-Fleet/08-Updating-Fleet.md index af4172402..65d9c6e49 100644 --- a/docs/01-Using-Fleet/08-Updating-Fleet.md +++ b/docs/01-Using-Fleet/08-Updating-Fleet.md @@ -7,7 +7,7 @@ ## Overview -This guide explains how to update and run new versions of Fleet. For initial installation instructions, see [Installing Fleet](../2-Deploying/1-Installation.md). +This guide explains how to update and run new versions of Fleet. For initial installation instructions, see [Installing Fleet](../02-Deploying/01-Installation.md). There are two steps to perform a typical Fleet update. If any other steps are required, they will be noted in the release notes. @@ -18,7 +18,7 @@ As with any enterprise software update, it's a good idea to back up your MySQL d ## Updating the Fleet binary -To update to a new version of Fleet, follow the [same binary install instructions](../2-Deploying/1-Installation.md) from the original installation method you used to install Fleet. +To update to a new version of Fleet, follow the [same binary install instructions](../02-Deploying/01-Installation.md) from the original installation method you used to install Fleet. ### Raw binaries diff --git a/docs/01-Using-Fleet/10-Teams.md b/docs/01-Using-Fleet/10-Teams.md index 86591f105..4904e900d 100644 --- a/docs/01-Using-Fleet/10-Teams.md +++ b/docs/01-Using-Fleet/10-Teams.md @@ -94,7 +94,7 @@ To add users to a team: 4. Select one or more users by searching for their full name and confirm the action. -Users will be given the [Observer role](./9-Permissions.md#team-member-permissions) when added to the team. The [Edit a member's role](#edit-a-members-role) provides instructions on changing the permission level of users on a team. +Users will be given the [Observer role](./09-Permissions.md#team-member-permissions) when added to the team. The [Edit a member's role](#edit-a-members-role) provides instructions on changing the permission level of users on a team. ## Edit a member's role diff --git a/docs/01-Using-Fleet/13-Vulnerability-Processing.md b/docs/01-Using-Fleet/13-Vulnerability-Processing.md index 70092798c..acb02e5a8 100644 --- a/docs/01-Using-Fleet/13-Vulnerability-Processing.md +++ b/docs/01-Using-Fleet/13-Vulnerability-Processing.md @@ -69,6 +69,6 @@ FLEET_VULNERABILITIES_DATABASES_PATH=/some/path The path specified needs to exist and Fleet needs to be able to read and write to and from it. This is the only mandatory configuration needed for vulnerability processing to work. Additional options, like vulnerability check frequency, can be -found in the [configuration documentation](../2-Deploying/2-Configuration.md#vulnerabilities). +found in the [configuration documentation](../02-Deploying/02-Configuration.md#vulnerabilities). You'll need to restart the Fleet instances after changing these settings. \ No newline at end of file diff --git a/docs/01-Using-Fleet/FAQ.md b/docs/01-Using-Fleet/FAQ.md index 99e0b6931..62771ea3e 100644 --- a/docs/01-Using-Fleet/FAQ.md +++ b/docs/01-Using-Fleet/FAQ.md @@ -21,7 +21,7 @@ The upgrade from kolide/fleet to fleetdm/fleet works the same as any minor versi Minor version upgrades in Kolide Fleet often included database migrations and the recommendation to back up the database before migrating. The same goes for FleetDM Fleet versions. -To migrate from Kolide Fleet to FleetDM Fleet, please follow the steps outlined in the [Updating Fleet section](./8-Updating-Fleet.md) of the documentation. +To migrate from Kolide Fleet to FleetDM Fleet, please follow the steps outlined in the [Updating Fleet section](./08-Updating-Fleet.md) of the documentation. ## Has anyone stress tested Fleet? How many clients can the Fleet server handle? @@ -33,13 +33,13 @@ It’s standard deployment practice to have multiple Fleet servers behind a load No, currently, there’s no way to retrieve the name of the enroll secret with a query. This means that there's no way to create a label using your hosts' enroll secrets and then use this label as a target for queries or query packs. -Typically folks will use some other unique identifier to create labels that distinguish each type of device. As a workaround, [Fleet's manual labels](./2-fleetctl-CLI.md#host-labels) provide a way to create groups of hosts without a query. These manual labels can then be used as targets for queries or query packs. +Typically folks will use some other unique identifier to create labels that distinguish each type of device. As a workaround, [Fleet's manual labels](./02-fleetctl-CLI.md#host-labels) provide a way to create groups of hosts without a query. These manual labels can then be used as targets for queries or query packs. There is, however, a way to accomplish this even though the answer to the question remains "no": Teams. As of Fleet v4.0.0, you can group hosts in Teams either by enrolling them with a team specific secret, or by transferring hosts to a team. One the hosts you want to target are part of a team, you can create a query and target the team in question. ## How often do labels refresh? Is the refresh frequency configurable? -The update frequency for labels is configurable with the [—osquery_label_update_interval](../2-Deploying/2-Configuration.md#osquery_label_update_interval) flag (default 1 hour). +The update frequency for labels is configurable with the [—osquery_label_update_interval](../02-Deploying/02-Configuration.md#osquery_label_update_interval) flag (default 1 hour). ## How do I revoke the authorization tokens for a user? @@ -51,7 +51,7 @@ Fleet can live query the `osquery_schedule` table. Performing this live query al ## How do I monitor a Fleet server? -Fleet provides standard interfaces for monitoring and alerting. See the [Monitoring Fleet](./6-Monitoring-Fleet.md) documentation for details. +Fleet provides standard interfaces for monitoring and alerting. See the [Monitoring Fleet](./06-Monitoring-Fleet.md) documentation for details. ## Why is the “Add User” button disabled? @@ -76,7 +76,7 @@ Live query results (executed in the web UI or `fleetctl query`) are pushed direc ### Scheduled Queries -Scheduled query results (queries that are scheduled to run in Packs) are typically sent to the Fleet server, and will be available on the filesystem of the server at the path configurable by [`--osquery_result_log_file`](../2-Deploying/2-Configuration.md#osquery_result_log_file). This defaults to `/tmp/osquery_result`. +Scheduled query results (queries that are scheduled to run in Packs) are typically sent to the Fleet server, and will be available on the filesystem of the server at the path configurable by [`--osquery_result_log_file`](../02-Deploying/02-Configuration.md#osquery_result_log_file). This defaults to `/tmp/osquery_result`. It is possible to configure osqueryd to log query results outside of Fleet. For results to go to Fleet, the `--logger_plugin` flag must be set to `tls`. @@ -84,7 +84,7 @@ It is possible to configure osqueryd to log query results outside of Fleet. For Folks typically use Fleet to ship logs to data aggregation systems like Splunk, the ELK stack, and Graylog. -The [logger configuration options](../2-Deploying/2-Configuration.md#osquery_status_log_plugin) allow you to select the log output plugin. Using the log outputs you can route the logs to your chosen aggregation system. +The [logger configuration options](../02-Deploying/02-Configuration.md#osquery_status_log_plugin) allow you to select the log output plugin. Using the log outputs you can route the logs to your chosen aggregation system. ### Troubleshooting @@ -94,7 +94,7 @@ Expecting results, but not seeing anything in the logs? - Check whether the query is scheduled in differential mode. If so, new results will only be logged when the result set changes. - Ensure that the query is scheduled to run on the intended platforms, and that the tables queried are supported by those platforms. - Use live query to `SELECT * FROM osquery_schedule` to check whether the query has been scheduled on the host. -- Look at the status logs provided by osquery. In a standard configuration these are available on the filesystem of the Fleet server at the path configurable by [`--filesystem_status_log_file`](../2-Deploying/2-Configuration.md#filesystem_status_log_file). This defaults to `/tmp/osquery_status`. The host will output a status log each time it executes the query. +- Look at the status logs provided by osquery. In a standard configuration these are available on the filesystem of the Fleet server at the path configurable by [`--filesystem_status_log_file`](../02-Deploying/02-Configuration.md#filesystem_status_log_file). This defaults to `/tmp/osquery_status`. The host will output a status log each time it executes the query. ## Why aren’t my live queries being logged? @@ -104,17 +104,17 @@ Live query results are never logged to the filesystem of the Fleet server. See [ You cannot. Scheduled query results are logged to whatever logging plugin you have configured and are not stored in the Fleet DB. -However, the Fleet API exposes a significant amount of host information via the [`api/v1/fleet/hosts`](./3-REST-API.md#list-hosts) and the [`api/v1/fleet/hosts/{id}`](./3-REST-API.md#get-host) API endpoints. The `api/v1/fleet/hosts` [can even be configured to return additional host information](https://github.com/fleetdm/fleet/blob/9fb9da31f5462fa7dda4819a114bbdbc0252c347/docs/1-Using-Fleet/2-fleetctl-CLI.md#fleet-configuration-options). +However, the Fleet API exposes a significant amount of host information via the [`api/v1/fleet/hosts`](./03-REST-API.md#list-hosts) and the [`api/v1/fleet/hosts/{id}`](./03-REST-API.md#get-host) API endpoints. The `api/v1/fleet/hosts` [can even be configured to return additional host information](https://github.com/fleetdm/fleet/blob/9fb9da31f5462fa7dda4819a114bbdbc0252c347/docs/1-Using-Fleet/2-fleetctl-CLI.md#fleet-configuration-options). As an example, let's say you want to retrieve a host's OS version, installed software, and kernel version: -Each host’s OS version is available using the `api/v1/fleet/hosts` API endpoint. [Check out the API documentation for this endpoint](./3-REST-API.md#list-hosts). +Each host’s OS version is available using the `api/v1/fleet/hosts` API endpoint. [Check out the API documentation for this endpoint](./03-REST-API.md#list-hosts). -The ability to view each host’s installed software was released behind a feature flag in Fleet 3.11.0 and called Software inventory. [Check out the feature flag documentation for instructions on turning on Software inventory in Fleet](../2-Deploying/2-Configuration.md#feature-flags). +The ability to view each host’s installed software was released behind a feature flag in Fleet 3.11.0 and called Software inventory. [Check out the feature flag documentation for instructions on turning on Software inventory in Fleet](../02-Deploying/02-Configuration.md#feature-flags). -Once the Software inventory feature is turned on, a list of a specific host’s installed software is available using the `api/v1/fleet/hosts/{id}` endpoint. [Check out the documentation for this endpoint](./3-REST-API.md#get-host). +Once the Software inventory feature is turned on, a list of a specific host’s installed software is available using the `api/v1/fleet/hosts/{id}` endpoint. [Check out the documentation for this endpoint](./03-REST-API.md#get-host). -It’s possible in Fleet to retrieve each host’s kernel version, using the Fleet API, through `additional_queries`. The Fleet configuration options yaml file includes an `additional_queries` property that allows you to append custom query results to the host details returned by the `api/v1/fleet/hosts` endpoint. [Check out an example configuration file with the additional_queries field](./2-fleetctl-CLI.md#fleet-configuration-options). +It’s possible in Fleet to retrieve each host’s kernel version, using the Fleet API, through `additional_queries`. The Fleet configuration options yaml file includes an `additional_queries` property that allows you to append custom query results to the host details returned by the `api/v1/fleet/hosts` endpoint. [Check out an example configuration file with the additional_queries field](./02-fleetctl-CLI.md#fleet-configuration-options). ## How do I automatically add hosts to packs when the hosts enroll to Fleet? @@ -122,10 +122,10 @@ You can accomplish this by adding specific labels as targets of your pack. First When your hosts enroll to Fleet, they will become a member of the label and, because the label is a target of your pack, these hosts will automatically become targets of the pack. -You can also do this by setting the `targets` field in the [YAML configuration file](./2-fleetctl-CLI.md#query-packs) that manages the packs that are added to your Fleet instance. +You can also do this by setting the `targets` field in the [YAML configuration file](./02-fleetctl-CLI.md#query-packs) that manages the packs that are added to your Fleet instance. ## How do I resolve an "unknown column" error when upgrading Fleet? The `unknown column` error typically occurs when the database migrations haven't been run during the upgrade process. -Check out the [documentation on running database migrations](./8-Updating-Fleet.md#running-database-migrations) to resolve this issue. +Check out the [documentation on running database migrations](./08-Updating-Fleet.md#running-database-migrations) to resolve this issue. diff --git a/docs/01-Using-Fleet/README.md b/docs/01-Using-Fleet/README.md index 9dbd331a0..1edfbc95e 100644 --- a/docs/01-Using-Fleet/README.md +++ b/docs/01-Using-Fleet/README.md @@ -1,27 +1,27 @@ # Using Fleet -### [Fleet UI](./1-Fleet-UI.md) +### [Fleet UI](./01-Fleet-UI.md) Provides documentation about running and scheduling queries from within the Fleet UI -### [fleetctl CLI](./2-fleetctl-CLI.md) +### [fleetctl CLI](./02-fleetctl-CLI.md) Includes resources for setting up and configuring Fleet via the fleetctl CLI -### [REST API](./3-REST-API.md) +### [REST API](./03-REST-API.md) Provides resources for working with Fleet's API and includes example code for endpoints -### [Adding hosts](./4-Adding-hosts.md) +### [Adding hosts](./04-Adding-hosts.md) Provides resources for enrolling your hosts to Fleet -### [Osquery logs](./5-Osquery-logs.md) +### [Osquery logs](./05-Osquery-logs.md) Includes documentation on the plugin options for working with osquery logs -### [Monitoring Fleet](./6-Monitoring-Fleet.md) +### [Monitoring Fleet](./06-Monitoring-Fleet.md) Provides documentation for load balancer health checks and working with Fleet server metrics and performance -### [Security best practices](./7-Security-best-practices.md) +### [Security best practices](./07-Security-best-practices.md) Includes resources for ways to mitigate against the OWASP top 10 issues -### [Updating Fleet](./8-Updating-Fleet.md) +### [Updating Fleet](./08-Updating-Fleet.md) Includes a guide for how to update and run new versions of Fleet ### [FAQ](./FAQ.md) diff --git a/docs/02-Deploying/01-Installation.md b/docs/02-Deploying/01-Installation.md index 7a1f0f89c..d59018f35 100644 --- a/docs/02-Deploying/01-Installation.md +++ b/docs/02-Deploying/01-Installation.md @@ -15,7 +15,7 @@ The Fleet application is distributed as a single static binary. This binary serv - The Fleet application API endpoints - The osquery TLS server API endpoints -All of these are served via a built-in HTTP server, so there is no need for complex web server configurations. Once you've installed the `fleet` binary and it's infrastructure dependencies as illustrated below, refer to the [Configuration](./2-Configuration.md) documentation for information on how to use and configure the Fleet application. +All of these are served via a built-in HTTP server, so there is no need for complex web server configurations. Once you've installed the `fleet` binary and it's infrastructure dependencies as illustrated below, refer to the [Configuration](./02-Configuration.md) documentation for information on how to use and configure the Fleet application. ## Installing the Fleet binary @@ -29,7 +29,7 @@ Pull the latest Fleet docker image: docker pull fleetdm/fleet ``` -For more information on using Fleet, refer to the [Configuration](./2-Configuration.md) documentation. +For more information on using Fleet, refer to the [Configuration](./02-Configuration.md) documentation. ### Raw binaries @@ -47,7 +47,7 @@ unzip fleet.zip 'linux/*' -d fleet ./fleet/linux/fleet_linux_amd64 --help ``` -For more information on using Fleet, refer to the [Configuration](./2-Configuration.md) documentation. +For more information on using Fleet, refer to the [Configuration](./02-Configuration.md) documentation. ## TLS configuration @@ -65,7 +65,7 @@ Fleet currently has two infrastructure dependencies in addition to the `fleet` w ### MySQL -Fleet uses MySQL extensively as its main database. Many cloud providers (such as [AWS](https://aws.amazon.com/rds/mysql/) and [GCP](https://cloud.google.com/sql/)) host reliable MySQL services which you may consider for this purpose. A well supported MySQL [Docker container](https://hub.docker.com/_/mysql/) also exists if you would rather run MySQL in a container. For more information on how to configure the `fleet` binary to use the correct MySQL instance, see the [Configuration](./2-Configuration.md) document. +Fleet uses MySQL extensively as its main database. Many cloud providers (such as [AWS](https://aws.amazon.com/rds/mysql/) and [GCP](https://cloud.google.com/sql/)) host reliable MySQL services which you may consider for this purpose. A well supported MySQL [Docker container](https://hub.docker.com/_/mysql/) also exists if you would rather run MySQL in a container. For more information on how to configure the `fleet` binary to use the correct MySQL instance, see the [Configuration](./02-Configuration.md) document. Fleet requires at least MySQL version 5.7. @@ -73,4 +73,4 @@ For host expiry configuration, the [event scheduler](https://dev.mysql.com/doc/r ### Redis -Fleet uses Redis to ingest and queue the results of distributed queries, cache data, etc. Many cloud providers (such as [AWS](https://aws.amazon.com/elasticache/) and [GCP](https://console.cloud.google.com/launcher/details/click-to-deploy-images/redis)) host reliable Redis services which you may consider for this purpose. A well supported Redis [Docker container](https://hub.docker.com/_/redis/) also exists if you would rather run Redis in a container. For more information on how to configure the `fleet` binary to use the correct Redis instance, see the [Configuration](./2-Configuration.md) document. +Fleet uses Redis to ingest and queue the results of distributed queries, cache data, etc. Many cloud providers (such as [AWS](https://aws.amazon.com/elasticache/) and [GCP](https://console.cloud.google.com/launcher/details/click-to-deploy-images/redis)) host reliable Redis services which you may consider for this purpose. A well supported Redis [Docker container](https://hub.docker.com/_/redis/) also exists if you would rather run Redis in a container. For more information on how to configure the `fleet` binary to use the correct Redis instance, see the [Configuration](./02-Configuration.md) document. diff --git a/docs/02-Deploying/03-Example-deployment-scenarios.md b/docs/02-Deploying/03-Example-deployment-scenarios.md index b1b004859..7dde2f46d 100644 --- a/docs/02-Deploying/03-Example-deployment-scenarios.md +++ b/docs/02-Deploying/03-Example-deployment-scenarios.md @@ -48,7 +48,7 @@ vagrant ssh ### Installing Fleet -To [install Fleet](https://github.com/fleetdm/fleet/blob/main/docs/2-Deploying/1-Installation.md), download, unzip, and move the latest Fleet binary to your desired install location. +To [install Fleet](https://github.com/fleetdm/fleet/blob/main/docs/02-Deploying/01-Installation.md), download, unzip, and move the latest Fleet binary to your desired install location. For example, after downloading: ```sh @@ -190,11 +190,11 @@ Now, if you go to [https://localhost:8080](https://localhost:8080) in your local ### Running Fleet with systemd -See [Running with systemd](./2-Configuration.md#running-with-systemd) for documentation on running fleet as a background process and managing the fleet server logs. +See [Running with systemd](./02-Configuration.md#running-with-systemd) for documentation on running fleet as a background process and managing the fleet server logs. ### Installing and running osquery -> Note that this whole process is outlined in more detail in the [Adding Hosts To Fleet](../1-Using-Fleet/4-Adding-hosts.md) document. The steps are repeated here for the sake of a continuous tutorial. +> Note that this whole process is outlined in more detail in the [Adding Hosts To Fleet](../01-Using-Fleet/04-Adding-hosts.md) document. The steps are repeated here for the sake of a continuous tutorial. To install osquery on CentOS, you can run the following: @@ -357,11 +357,11 @@ Now, if you go to [https://localhost:8080](https://localhost:8080) in your local ### Running Fleet with systemd -See [Running with systemd](./2-Configuration.md#running-with-systemd) for documentation on running fleet as a background process and managing the fleet server logs. +See [Running with systemd](./02-Configuration.md#running-with-systemd) for documentation on running fleet as a background process and managing the fleet server logs. ### Installing and running osquery -> Note that this whole process is outlined in more detail in the [Adding Hosts To Fleet](../1-Using-Fleet/4-Adding-hosts.md) document. The steps are repeated here for the sake of a continuous tutorial. +> Note that this whole process is outlined in more detail in the [Adding Hosts To Fleet](../01-Using-Fleet/04-Adding-hosts.md) document. The steps are repeated here for the sake of a continuous tutorial. To install osquery on Ubuntu, you can run the following: @@ -453,14 +453,14 @@ We will use this address when we configure the Kubernetes deployment and databas The last step is to run the Fleet database migrations on your new MySQL server. To do this, run the following: ``` -kubectl create -f ./docs/1-Using-Fleet/configuration-files/kubernetes/fleet-migrations.yml +kubectl create -f ./docs/01-Using-Fleet/configuration-files/kubernetes/fleet-migrations.yml ``` In Kubernetes, you can only run a job once. If you'd like to run it again (i.e.: you'd like to run the migrations again using the same file), you must delete the job before re-creating it. To delete the job and re-run it, you can run the following commands: ``` -kubectl delete -f ./docs/1-Using-Fleet/configuration-files/kubernetes/fleet-migrations.yml -kubectl create -f ./docs/1-Using-Fleet/configuration-files/kubernetes/fleet-migrations.yml +kubectl delete -f ./docs/01-Using-Fleet/configuration-files/kubernetes/fleet-migrations.yml +kubectl create -f ./docs/01-Using-Fleet/configuration-files/kubernetes/fleet-migrations.yml ``` #### Redis @@ -536,7 +536,7 @@ ts=2017-11-16T02:48:38.441148166Z transport=https address=0.0.0.0:443 msg=listen Now that the Fleet server is running on our cluster, we have to expose the Fleet webservers to the internet via a load balancer. To create a Kubernetes `Service` of type `LoadBalancer`, run the following: ``` -kubectl apply -f ./docs/1-Using-Fleet/configuration-files/kubernetes/fleet-service.yml +kubectl apply -f ./docs/01-Using-Fleet/configuration-files/kubernetes/fleet-service.yml ``` #### Configure DNS diff --git a/docs/02-Deploying/FAQ.md b/docs/02-Deploying/FAQ.md index 4514a88d9..f9580cbb6 100644 --- a/docs/02-Deploying/FAQ.md +++ b/docs/02-Deploying/FAQ.md @@ -25,7 +25,7 @@ Yes. Fleet scales horizontally out of the box as long as all of the Fleet server Note that osquery logs will be distributed across the Fleet servers. -Read the [performance documentation](../1-Using-Fleet/6-Monitoring-Fleet.md#fleet-server-performance) for more. +Read the [performance documentation](../01-Using-Fleet/06-Monitoring-Fleet.md#fleet-server-performance) for more. ## Why aren't my osquery agents connecting to Fleet? @@ -71,15 +71,15 @@ These configurations cannot be managed centrally from Fleet. ## What do I do about "too many open files" errors? -This error usually indicates that the Fleet server has run out of file descriptors. Fix this by increasing the `ulimit` on the Fleet process. See the `LimitNOFILE` setting in the [example systemd unit file](./2-Configuration.md#runing-with-systemd) for an example of how to do this with systemd. +This error usually indicates that the Fleet server has run out of file descriptors. Fix this by increasing the `ulimit` on the Fleet process. See the `LimitNOFILE` setting in the [example systemd unit file](./02-Configuration.md#runing-with-systemd) for an example of how to do this with systemd. -Some deployments may benefit by setting the [`--server_keepalive`](./2-Configuration.md#server_keepalive) flag to false. +Some deployments may benefit by setting the [`--server_keepalive`](./02-Configuration.md#server_keepalive) flag to false. This was also seen as a symptom of a different issue: if you're deploying on AWS on T type instances, there are different scenarios where the activity can increase and the instances will burst. If they run out of credits, then they'll stop processing leaving the file descriptors open. ## I upgraded my database, but Fleet is still running slowly. What could be going on? -This could be caused by a mismatched connection limit between the Fleet server and the MySQL server that prevents Fleet from fully utilizing the database. First [determine how many open connections your MySQL server supports](https://dev.mysql.com/doc/refman/8.0/en/too-many-connections.html). Now set the [`--mysql_max_open_conns`](./2-Configuration.md#mysql_max_open_conns) and [`--mysql_max_idle_conns`](./2-Configuration.md#mysql_max_idle_conns) flags appropriately. +This could be caused by a mismatched connection limit between the Fleet server and the MySQL server that prevents Fleet from fully utilizing the database. First [determine how many open connections your MySQL server supports](https://dev.mysql.com/doc/refman/8.0/en/too-many-connections.html). Now set the [`--mysql_max_open_conns`](./02-Configuration.md#mysql_max_open_conns) and [`--mysql_max_idle_conns`](./02-Configuration.md#mysql_max_idle_conns) flags appropriately. ## Why am I receiving a database connection error when attempting to "prepare" the database? diff --git a/docs/02-Deploying/README.md b/docs/02-Deploying/README.md index 19ad6389e..5b62992f4 100644 --- a/docs/02-Deploying/README.md +++ b/docs/02-Deploying/README.md @@ -1,15 +1,15 @@ # Deployment -### [Installation](./1-Installation.md) +### [Installation](./01-Installation.md) Provides documentation on installing the Fleet binary and Fleet’s infrastructure dependencies -### [Configuration](./2-Configuration.md) +### [Configuration](./02-Configuration.md) Includes resources for configuring the Fleet binary, managing osquery configurations, and running with systemd -### [Example deployment scenarios](./3-Example-deployment-scenarios.md) +### [Example deployment scenarios](./03-Example-deployment-scenarios.md) Includes deployment walkthroughs for Fleet on CentOS, Ubuntu, and Kubernetes. -### [Self-managed agent updates](./4-fleetctl-agent-updates.md) +### [Self-managed agent updates](./04-fleetctl-agent-updates.md) Information about running an update server with fleetctl. ### [FAQ](./FAQ.md) diff --git a/docs/03-Contributing/02-Testing.md b/docs/03-Contributing/02-Testing.md index 21e880f35..1aae17579 100644 --- a/docs/03-Contributing/02-Testing.md +++ b/docs/03-Contributing/02-Testing.md @@ -7,7 +7,7 @@ - [Test hosts](#test-hosts) - [Email](#email) - [Database backup/restore](#database-backuprestore) -- [Seeding Data](./6-Seeding-Data.md) +- [Seeding Data](./06-Seeding-Data.md) - [MySQL shell](#mysql-shell) - [Testing SSO](#testing-sso) @@ -137,7 +137,7 @@ E2E tests are run using Docker and Cypress. #### Preparation -Make sure dependencies are up to date and the [Fleet binaries are built locally](./1-Building-Fleet.md). +Make sure dependencies are up to date and the [Fleet binaries are built locally](./01-Building-Fleet.md). For Fleet Free tests: diff --git a/docs/03-Contributing/04-Committing-Changes.md b/docs/03-Contributing/04-Committing-Changes.md index 88694c9b3..73ed37ff0 100644 --- a/docs/03-Contributing/04-Committing-Changes.md +++ b/docs/03-Contributing/04-Committing-Changes.md @@ -19,7 +19,7 @@ Fleet Device Management team members may not copy queries from external sources Each developer (internal or external) creates a fork of the Fleet repository, committing changes to a branch within their fork. Changes are submitted by PR to be merged into Fleet. -GitHub Actions automatically runs testers and linters on each PR. Please ensure that these checks pass. Checks can be run locally as described in [2-Testing.md](./2-Testing.md). +GitHub Actions automatically runs testers and linters on each PR. Please ensure that these checks pass. Checks can be run locally as described in [02-Testing.md](./02-Testing.md). For features that are still in-progress, the Pull Request can be marked as a "Draft". This helps make it clear which PRs are ready for review and merge. diff --git a/docs/03-Contributing/FAQ.md b/docs/03-Contributing/FAQ.md index 4020cd085..68c8d53b1 100644 --- a/docs/03-Contributing/FAQ.md +++ b/docs/03-Contributing/FAQ.md @@ -25,7 +25,7 @@ server/fleet/emails.go:90:23: undefined: Asset make: *** [fleet] Error 2 ``` -If you get an `undefined: Asset` error it is likely because you did not run `make generate` before `make build`. See [Building Fleet](./1-Building-Fleet.md) for additional documentation on compiling the `fleet` binary. +If you get an `undefined: Asset` error it is likely because you did not run `make generate` before `make build`. See [Building Fleet](./01-Building-Fleet.md) for additional documentation on compiling the `fleet` binary. ## Adding hosts for testing diff --git a/docs/03-Contributing/README.md b/docs/03-Contributing/README.md index 159d3045b..98a9b3885 100644 --- a/docs/03-Contributing/README.md +++ b/docs/03-Contributing/README.md @@ -1,18 +1,18 @@ # Contribution -### [Building Fleet](./1-Building-Fleet.md) +### [Building Fleet](./01-Building-Fleet.md) Provides documentation about building the code, development infrastructure, and database migrations -### [Testing](./2-Testing.md) +### [Testing](./02-Testing.md) Includes documentation about Fleet's full test suite and integration tests -### [Migrations](./3-Migrations.md) +### [Migrations](./03-Migrations.md) Information about creating and updating database migrations -### [Committing Changes](./4-Committing-Changes.md) +### [Committing Changes](./04-Committing-Changes.md) Contains information about how to merge changes into the codebase -### [Releasing Fleet](./5-Releasing-Fleet.md) +### [Releasing Fleet](./05-Releasing-Fleet.md) Provides a guide for Fleet's release process ### [FAQ](./FAQ.md) diff --git a/docs/README.md b/docs/README.md index 3da7649ef..5e29c0c96 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,13 +2,13 @@ Welcome to the documentation for the Fleet osquery fleet manager. -### [Using Fleet](./1-Using-Fleet/README.md) +### [Using Fleet](./01-Using-Fleet/README.md) Resources for using the Fleet UI, fleetctl CLI, and Fleet REST API. -### [Deploying](./2-Deploying/README.md) +### [Deploying](./02-Deploying/README.md) Resources for installing Fleet's infrastructure dependencies, configuring Fleet, deploying osquery to hosts, and viewing example deployment scenarios. -### [Contributing](./3-Contributing/README.md) +### [Contributing](./03-Contributing/README.md) If you're interested in interacting with the Fleet source code, you'll find information on modifying and building the code here. --- diff --git a/frontend/README.md b/frontend/README.md index e7770abd4..147b24000 100644 --- a/frontend/README.md +++ b/frontend/README.md @@ -17,7 +17,7 @@ The Fleet front-end is a Single Page Application using React with Typescript and ## Running the Fleet web app For details instruction on building and serving the Fleet web application -consult the [Contributing documentation](../docs/3-Contributing/README.md). +consult the [Contributing documentation](../docs/03-Contributing/README.md). ## Directory Structure diff --git a/frontend/README_deprecated.md b/frontend/README_deprecated.md index 4b1360d1d..79ac72db7 100644 --- a/frontend/README_deprecated.md +++ b/frontend/README_deprecated.md @@ -9,7 +9,7 @@ The Fleet front-end is a Single Page Application using React and Redux. ## Running the Fleet web app For details instruction on building and serving the Fleet web application -consult the [Contributing documentation](../docs/3-Contributing/README.md). +consult the [Contributing documentation](../docs/03-Contributing/README.md). ## Directory Structure diff --git a/handbook/README.md b/handbook/README.md index 3ea51a385..d33d6ed6f 100644 --- a/handbook/README.md +++ b/handbook/README.md @@ -98,7 +98,7 @@ If the action fails, please complete the following steps: ##### Browser compatibility checking -A browser compatibility check of [fleetdm.com](https://fleetdm.com/) should be carried out monthly to verify that the website looks, and functions as expected across all [supported browsers](../docs/1-Using-Fleet/12-Supported-browsers.md). +A browser compatibility check of [fleetdm.com](https://fleetdm.com/) should be carried out monthly to verify that the website looks, and functions as expected across all [supported browsers](../docs/01-Using-Fleet/12-Supported-browsers.md). - We use [BrowserStack](https://www.browserstack.com/users/sign_in) (logins can be found in [1Password](https://start.1password.com/open/i?a=N3F7LHAKQ5G3JPFPX234EC4ZDQ&v=3ycqkai6naxhqsylmsos6vairu&i=nwnxrrbpcwkuzaazh3rywzoh6e&h=fleetdevicemanagement.1password.com)) for our cross-browser checks. - Check for issues against the latest version of Google Chrome (macOS). We use this as our baseline for quality assurance. diff --git a/handbook/manual-qa.md b/handbook/manual-qa.md index 6af722b19..0c769e22e 100644 --- a/handbook/manual-qa.md +++ b/handbook/manual-qa.md @@ -94,13 +94,13 @@ Add a query as a saved query to the pack. Remove this query. Delete the pack. As an admin user, select the "Settings" tab in the top navigation and then select "Organization settings". -Follow [the instructions outlined in the Testing documentation](../docs/3-Contributing/2-Testing.md#email) to set up a local SMTP server. +Follow [the instructions outlined in the Testing documentation](../docs/03-Contributing/02-Testing.md#email) to set up a local SMTP server. Successfully edit your organization's name in Fleet. ### Manage users flow -Invite a new user. To be able to invite users, you must have your local SMTP server configured. Instructions for setting up a local SMTP server are outlined in [the Testing documentation](../docs/3-Contributing/2-Testing.md#email) +Invite a new user. To be able to invite users, you must have your local SMTP server configured. Instructions for setting up a local SMTP server are outlined in [the Testing documentation](../docs/03-Contributing/02-Testing.md#email) Logout of your current admin user and accept the invitation for the newly invited user. With your local SMTP server configured, head to https://localhost:8025 to view and select the invitation link. diff --git a/handbook/release-process.md b/handbook/release-process.md index 52b5c6aae..9e7d01f26 100644 --- a/handbook/release-process.md +++ b/handbook/release-process.md @@ -28,7 +28,7 @@ Check out the [Fleet 4.1.0 blog post](https://blog.fleetdm.com/fleet-4-1-0-57dfa **More improvements** - Includes each additional feature's name, availability (Free v. Premium), and 1-2 sentences that answer the 'why should the user care?' questions. -**Upgrade plan** - Once sentence that links to user to the upgrading Fleet documentation here: https://github.com/fleetdm/fleet/blob/main/docs/1-Using-Fleet/8-Updating-Fleet.md +**Upgrade plan** - Once sentence that links to user to the upgrading Fleet documentation here: https://github.com/fleetdm/fleet/blob/main/docs/01-Using-Fleet/08-Updating-Fleet.md ### Manual QA @@ -38,4 +38,4 @@ Documentation on conducting the manual QA pass can be found [here](./manual-qa.m ## Release day -Documentation on completing the release process can be found [here](../docs/3-Contributing/5-Releasing-Fleet.md). +Documentation on completing the release process can be found [here](../docs/03-Contributing/05-Releasing-Fleet.md). diff --git a/handbook/support-process.md b/handbook/support-process.md index cbacf8587..58d09e964 100644 --- a/handbook/support-process.md +++ b/handbook/support-process.md @@ -90,6 +90,6 @@ There are four sources that the individual on-call should monitor for activity: There are several locations in Fleet's public and internal documentation that can be helpful when answering questions raised by the community: -1. The frequently asked question (FAQ) documents in each section found in the `/docs` folder. These documents are the [Using Fleet FAQ](../docs/1-Using-Fleet/FAQ.md), [Deploying FAQ](../docs/2-Deploying/FAQ.md), and [Contributing FAQ](../docs/3-Contributing/FAQ.md). +1. The frequently asked question (FAQ) documents in each section found in the `/docs` folder. These documents are the [Using Fleet FAQ](../docs/01-Using-Fleet/FAQ.md), [Deploying FAQ](../docs/02-Deploying/FAQ.md), and [Contributing FAQ](../docs/03-Contributing/FAQ.md). 2. The [Internal FAQ](https://docs.google.com/document/d/1I6pJ3vz0EE-qE13VmpE2G3gd5zA1m3bb_u8Q2G3Gmp0/edit#heading=h.ltavvjy511qv) document. diff --git a/orbit/README.md b/orbit/README.md index 18cd740e5..3b3d1da3b 100644 --- a/orbit/README.md +++ b/orbit/README.md @@ -192,7 +192,7 @@ Yes! Orbit is licensed under an MIT license and all uses are encouraged. ### How does orbit update osquery? And how do the stable and edge channels get triggered to update osquery on a self hosted Fleet instance? -Orbit uses a configurable update server. We expect that many folks will just use the update server we manage (similar to what Kolide does with Launcher's update server). We are also offering [tooling for self-managing an update server](https://github.com/fleetdm/fleet/blob/main/docs/2-Deploying/4-fleetctl-agent-updates.md) as part of Fleet Premium (the subscription offering). +Orbit uses a configurable update server. We expect that many folks will just use the update server we manage (similar to what Kolide does with Launcher's update server). We are also offering [tooling for self-managing an update server](https://github.com/fleetdm/fleet/blob/main/docs/02-Deploying/04-fleetctl-agent-updates.md) as part of Fleet Premium (the subscription offering). ## Community diff --git a/tools/backup_db/README.md b/tools/backup_db/README.md index 39f52ea04..11d7ad61a 100644 --- a/tools/backup_db/README.md +++ b/tools/backup_db/README.md @@ -1,3 +1,3 @@ These scripts are for backing up and restore the Docker development MySQL database. -Usage is documented [here](../../docs/3-Contributing/2-Testing.md#database-backuprestore). +Usage is documented [here](../../docs/03-Contributing/02-Testing.md#database-backuprestore). diff --git a/tools/fleetctl-npm/README.md b/tools/fleetctl-npm/README.md index 52ff50a02..e303e10c5 100644 --- a/tools/fleetctl-npm/README.md +++ b/tools/fleetctl-npm/README.md @@ -10,4 +10,4 @@ Simply install `fleetctl` with `npm install -g fleetctl`. ## Usage -See the [fleetctl documentation](https://github.com/fleetdm/fleet/blob/main/docs/1-Using-Fleet/2-fleetctl-CLI.md) or `fleetctl --help` for usage instructions. +See the [fleetctl documentation](https://github.com/fleetdm/fleet/blob/main/docs/01-Using-Fleet/02-fleetctl-CLI.md) or `fleetctl --help` for usage instructions.