mirror of
https://github.com/fleetdm/fleet
synced 2026-04-21 13:37:30 +00:00
Update links to documentation so that they use main branch (#1151)
* Update to main branch * Update link to releasing Fleet
This commit is contained in:
noahtalerman
GitHub
parent
17a6c21224
commit
e02b88d010
15 changed files with 23 additions and 23 deletions
4
.github/ISSUE_TEMPLATE/bug-report.md
vendored
4
.github/ISSUE_TEMPLATE/bug-report.md
vendored
|
|
@ -31,6 +31,6 @@ assignees: ''
|
|||
### More info
|
||||
<!-- Any ideas? -->
|
||||
|
||||
<!-- If this is an issue with the Fleet UI: Please also [answer this question](https://github.com/fleetdm/fleet/blob/master/CONTRIBUTING.md#6-is-this-an-issue-with-the-fleet-ui). -->
|
||||
<!-- If this is an issue with the Fleet UI: Please also [answer this question](https://github.com/fleetdm/fleet/blob/main/CONTRIBUTING.md#6-is-this-an-issue-with-the-fleet-ui). -->
|
||||
|
||||
<!-- If this is a performance issue: Please [follow these steps](https://github.com/fleetdm/fleet/blob/master/docs/1-Using-Fleet/6-Monitoring-Fleet.md#debugging-performance-issues) to generate and attach a debug archive. -->
|
||||
<!-- If this is a performance issue: Please [follow these steps](https://github.com/fleetdm/fleet/blob/main/docs/1-Using-Fleet/6-Monitoring-Fleet.md#debugging-performance-issues) to generate and attach a debug archive. -->
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@
|
|||
|
||||
* Improve Fleet performance by batch updating host seen time instead of updating synchronously. This improvement reduces MySQL CPU usage by ~33% with 4,000 simulated hosts and MySQL running in Docker.
|
||||
|
||||
* Add support for software inventory, introducing a list of installed software items on each host's respective _Host details_ page. This feature is flagged off by default (for now). Check out [the feature flag documentation for instructions on how to turn this feature on](https://github.com/fleetdm/fleet/blob/master/docs/2-Deploying/2-Configuration.md#software-inventory).
|
||||
* Add support for software inventory, introducing a list of installed software items on each host's respective _Host details_ page. This feature is flagged off by default (for now). Check out [the feature flag documentation for instructions on how to turn this feature on](https://github.com/fleetdm/fleet/blob/main/docs/2-Deploying/2-Configuration.md#software-inventory).
|
||||
|
||||
* Add Windows support for `fleetctl` agent autoupdates. The `fleetctl updates` command provides the ability to self-manage an agent update server. Available for Fleet Basic customers.
|
||||
|
||||
|
|
@ -496,7 +496,7 @@ to 2.0.0.
|
|||
|
||||
## Kolide Fleet 2.0.0 (currently preparing for release)
|
||||
|
||||
The primary new addition in Fleet 2 is the new `fleetctl` CLI and file-format, which dramatically increases the flexibility and control that administrators have over their osquery deployment. The CLI and the file format are documented [in the Fleet documentation](https://github.com/fleetdm/fleet/blob/master/docs/1-Using-Fleet/2-fleetctl-CLI.md).
|
||||
The primary new addition in Fleet 2 is the new `fleetctl` CLI and file-format, which dramatically increases the flexibility and control that administrators have over their osquery deployment. The CLI and the file format are documented [in the Fleet documentation](https://github.com/fleetdm/fleet/blob/main/docs/1-Using-Fleet/2-fleetctl-CLI.md).
|
||||
|
||||
### New Features
|
||||
|
||||
|
|
|
|||
|
|
@ -49,6 +49,6 @@ Please join us in the #fleet channel on [osquery Slack](https://osquery.slack.co
|
|||
|
||||
#### Contributing
|
||||
|
||||
Contributions are welcome, whether you answer questions on Slack/GitHub/StackOverflow/Twitter, improve the documentation or website, write a tutorial, give a talk, start a local osquery meetup, troubleshoot reported issues, or [submit a patch](https://github.com/fleetdm/fleet/blob/master/CONTRIBUTING.md). The Fleet code of conduct is [on GitHub](https://github.com/fleetdm/fleet/blob/master/CODE_OF_CONDUCT.md).
|
||||
Contributions are welcome, whether you answer questions on Slack/GitHub/StackOverflow/Twitter, improve the documentation or website, write a tutorial, give a talk, start a local osquery meetup, troubleshoot reported issues, or [submit a patch](https://github.com/fleetdm/fleet/blob/main/CONTRIBUTING.md). The Fleet code of conduct is [on GitHub](https://github.com/fleetdm/fleet/blob/main/CODE_OF_CONDUCT.md).
|
||||
|
||||
<a href="https://fleetdm.com"><img alt="Banner featuring a futuristic cloud city with the Fleet logo" src="https://user-images.githubusercontent.com/618009/98254443-eaf21100-1f41-11eb-9e2c-63a0545601f3.jpg"/></a>
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ Each set of objects follows a similar REST access pattern.
|
|||
|
||||
Queries, packs, scheduled queries, labels, invites, users, sessions all behave this way. Some objects, like invites, have additional HTTP methods for additional functionality. Some objects, such as scheduled queries, are merely a relationship between two other objects (in this case, a query and a pack) with some details attached.
|
||||
|
||||
All of these objects are put together and distributed to the appropriate osquery agents at the appropriate time. At this time, the best source of truth for the API is the [HTTP handler file](https://github.com/fleetdm/fleet/blob/master/server/service/handler.go) in the Go application. The REST API is exposed via a transport layer on top of an RPC service which is implemented using a micro-service library called [Go Kit](https://github.com/go-kit/kit). If using the Fleet API is important to you right now, being familiar with Go Kit would definitely be helpful.
|
||||
All of these objects are put together and distributed to the appropriate osquery agents at the appropriate time. At this time, the best source of truth for the API is the [HTTP handler file](https://github.com/fleetdm/fleet/blob/main/server/service/handler.go) in the Go application. The REST API is exposed via a transport layer on top of an RPC service which is implemented using a micro-service library called [Go Kit](https://github.com/go-kit/kit). If using the Fleet API is important to you right now, being familiar with Go Kit would definitely be helpful.
|
||||
|
||||
## Authentication
|
||||
|
||||
|
|
@ -475,7 +475,7 @@ This is the callback endpoint that the identity provider will use to send securi
|
|||
| order_direction | string | query | **Requires `order_key`**. The direction of the order given the order key. Options include `asc` and `desc`. Default is `asc`. |
|
||||
| status | string | query | Indicates the status of the hosts to return. Can either be `new`, `online`, `offline`, or `mia`. |
|
||||
| query | string | query | Search query keywords. Searchable fields include `hostname`, `machine_serial`, `uuid`, and `ipv4`. |
|
||||
| additional_info_filters | string | query | A comma-delimited list of fields to include in each host's additional information object. See [Fleet Configuration Options](https://github.com/fleetdm/fleet/blob/master/docs/1-Using-Fleet/2-fleetctl-CLI.md#fleet-configuration-options) for an example configuration with hosts' additional information. Use `*` to get all stored fields. |
|
||||
| additional_info_filters | string | query | A comma-delimited list of fields to include in each host's additional information object. See [Fleet Configuration Options](https://github.com/fleetdm/fleet/blob/main/docs/1-Using-Fleet/2-fleetctl-CLI.md#fleet-configuration-options) for an example configuration with hosts' additional information. Use `*` to get all stored fields. |
|
||||
|
||||
If `additional_info_filters` is not specified, no `additional` information will be returned.
|
||||
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ It is possible to revoke all session tokens for a user by forcing a password res
|
|||
By default, all traffic between user clients (such as the web browser and fleetctl) and the Fleet server is encrypted with TLS. By default, all traffic between osqueryd clients and the Fleet server is encrypted with TLS. Fleet does not encrypt any data at rest (*however a user could separately configure encryption for the MySQL database and logs that Fleet writes*).
|
||||
|
||||
## Broken access controls – how restrictions on what authorized users are allowed to do/access are enforced.
|
||||
Each session is associated with a viewer context that is used to determine the access granted to that user. Access controls can easily be applied as middleware in the routing table, so the access to a route is clearly defined in the same place where the route is attached to the server see [https://github.com/fleetdm/fleet/blob/master/server/service/handler.go#L114-L189](https://github.com/fleetdm/fleet/blob/master/server/service/handler.go#L114-L189).
|
||||
Each session is associated with a viewer context that is used to determine the access granted to that user. Access controls can easily be applied as middleware in the routing table, so the access to a route is clearly defined in the same place where the route is attached to the server see [https://github.com/fleetdm/fleet/blob/main/server/service/handler.go#L114-L189](https://github.com/fleetdm/fleet/blob/main/server/service/handler.go#L114-L189).
|
||||
|
||||
## Cross-site scripting – ensure an attacker can’t execute scripts in the user’s browser
|
||||
We render the frontend with React and benefit from built-in XSS protection in React's rendering. This is not sufficient to prevent all XSS, so we also follow additional best practices as discussed in [https://stackoverflow.com/a/51852579/491710](https://stackoverflow.com/a/51852579/491710).
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ Make note of the SHA256 checksum output at the end of this build command to past
|
|||
|
||||
### Upgrading
|
||||
|
||||
Please visit our [update guide](https://github.com/fleetdm/fleet/blob/master/docs/1-Using-Fleet/8-Updating-Fleet.md) for upgrade instructions.
|
||||
Please visit our [update guide](https://github.com/fleetdm/fleet/blob/main/docs/1-Using-Fleet/8-Updating-Fleet.md) for upgrade instructions.
|
||||
|
||||
### Documentation
|
||||
|
||||
|
|
|
|||
|
|
@ -57,7 +57,7 @@ component's PropTypes.
|
|||
The default export of the kolide directory is the API client. More info can be
|
||||
found at the [API client documentation page](./kolide/README.md).
|
||||
|
||||
### [layouts](https://github.com/fleetdm/fleet/tree/master/frontend/layouts)
|
||||
### [layouts](https://github.com/fleetdm/fleet/tree/main/frontend/layouts)
|
||||
|
||||
The Fleet application has only 1 layout, the [Core Layout](./layouts/CoreLayout/CoreLayout.jsx).
|
||||
The Layout is rendered from the [router](./router/index.jsx) and are used to set up the general app UI (header, sidebar) and render child components.
|
||||
|
|
|
|||
|
|
@ -121,7 +121,7 @@ class AddHostModal extends Component {
|
|||
<div className={`${baseClass}__documentation-link`}>
|
||||
<h4>
|
||||
<a
|
||||
href="https://github.com/fleetdm/fleet/blob/master/docs/1-Using-Fleet/4-Adding-hosts.md"
|
||||
href="https://github.com/fleetdm/fleet/blob/main/docs/1-Using-Fleet/4-Adding-hosts.md"
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
>
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ class UserMenu extends Component {
|
|||
label: "Documentation",
|
||||
onClick: () =>
|
||||
window.open(
|
||||
"https://github.com/fleetdm/fleet/blob/master/docs/README.md",
|
||||
"https://github.com/fleetdm/fleet/blob/main/docs/README.md",
|
||||
"_blank"
|
||||
),
|
||||
},
|
||||
|
|
|
|||
|
|
@ -73,7 +73,7 @@ export class OsqueryOptionsPage extends Component {
|
|||
overrides option.
|
||||
</p>
|
||||
<a
|
||||
href="https://github.com/fleetdm/fleet/blob/master/docs/1-Using-Fleet/2-fleetctl-CLI.md#osquery-configuration-options"
|
||||
href="https://github.com/fleetdm/fleet/blob/main/docs/1-Using-Fleet/2-fleetctl-CLI.md#osquery-configuration-options"
|
||||
target="_blank"
|
||||
rel="noreferrer"
|
||||
>
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ One week before the release date, the individual tasked with managing the releas
|
|||
|
||||
The Changelog section of the release issue acts as a short term roadmap and will be used as the public facing Changelog included in the release.
|
||||
|
||||
To construct the Changelog, first, head to the [commit history for fleetdm/fleet](https://github.com/fleetdm/fleet/commits/master). Next, navigate to the commit made to prepare for the previous release. This commit is usually titled something like “Prepare for `<release number>`.” Finally, add a bullet point to the Changelog for each commit, according to the following:
|
||||
To construct the Changelog, first, head to the [commit history for fleetdm/fleet](https://github.com/fleetdm/fleet/commits/main). Next, navigate to the commit made to prepare for the previous release. This commit is usually titled something like “Prepare for `<release number>`.” Finally, add a bullet point to the Changelog for each commit, according to the following:
|
||||
|
||||
1. Only include changes that are relevant to Fleet users. This is because the Changelog serves as a tool to both inform _and_ excite users of Fleet. This means that changes made to the development infrastructure, documentation, and contribution experience shouldn’t be included.
|
||||
2. Each bullet should start with a verb. For example, “Add,” or “Fix.”
|
||||
|
|
@ -66,8 +66,8 @@ At this point, the individual managing the release should reserve 30 minutes to
|
|||
|
||||
After all changes required for release have been merged into the `master` branch, the individual tasked with managing the release should perform a manual quality assurance pass.
|
||||
|
||||
Documentation on conducting the manual QA pass can be found here: https://github.com/fleetdm/fleet/blob/f725a4e7f5ef994ecf18145fa284497dcfbb4333/handbook/manual-qa.md
|
||||
Documentation on conducting the manual QA pass can be found [here](./manual-qa.md).
|
||||
|
||||
## Release day
|
||||
|
||||
Documentation on completing the release process can be found here: https://github.com/fleetdm/fleet/blob/f725a4e7f5ef994ecf18145fa284497dcfbb4333/docs/3-Contributing/5-Releasing-Fleet.md
|
||||
Documentation on completing the release process can be found [here](../docs/3-Contributing/5-Releasing-Fleet.md).
|
||||
|
|
|
|||
|
|
@ -10,4 +10,4 @@ Simply install `fleetctl` with `npm install -g fleetctl`.
|
|||
|
||||
## Usage
|
||||
|
||||
See the [fleetctl documentation](https://github.com/fleetdm/fleet/blob/master/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/1-Using-Fleet/2-fleetctl-CLI.md) or `fleetctl --help` for usage instructions.
|
||||
|
|
|
|||
4
website/config/routes.js
vendored
4
website/config/routes.js
vendored
|
|
@ -17,8 +17,8 @@ module.exports.routes = {
|
|||
'GET /company/contact': { action: 'view-contact' },
|
||||
'GET /get-started': { action: 'view-pricing' },
|
||||
|
||||
'GET /install': 'https://github.com/fleetdm/fleet/blob/master/README.md', // « FUTURE: When ready, bring back { action: 'view-get-started' }
|
||||
'/documentation': 'https://github.com/fleetdm/fleet/tree/master/docs',
|
||||
'GET /install': 'https://github.com/fleetdm/fleet/blob/main/README.md', // « FUTURE: When ready, bring back { action: 'view-get-started' }
|
||||
'/documentation': 'https://github.com/fleetdm/fleet/tree/main/docs',
|
||||
'/hall-of-fame': 'https://github.com/fleetdm/fleet/pulse',
|
||||
'/company/about': '/blog', // FUTURE: brief "about" page explaining the origins of the company
|
||||
|
||||
|
|
|
|||
4
website/views/layouts/layout.ejs
vendored
4
website/views/layouts/layout.ejs
vendored
|
|
@ -74,7 +74,7 @@
|
|||
<div class="d-flex justify-content-between">
|
||||
<a href="/">
|
||||
<img alt="Fleet logo" src="/images/logo-blue-162x92@2x.png" style="height: 92px; width: 162px;" class="mt-3"/>
|
||||
</a>
|
||||
</a>
|
||||
<button style="font-size: 16px; text-decoration: none;" class="header-btn btn btn-link d-flex align-items-center" data-toggle="collapse" data-target="#navbarToggleExternalContent">
|
||||
<img alt="An 'X' icon indicating that this can be interacted with to close the navigation menu." src="/images/icon-close-16x16@2x.png" style="width: 16px;" />
|
||||
</button>
|
||||
|
|
@ -153,7 +153,7 @@
|
|||
</div>
|
||||
<div class="row flex-row-reverse">
|
||||
<div style="font-family: 'Lato', sans-serif; font-size: 13px;" class="col-md text-center text-xl-right pt-0 pb-3 pt-xl-0 mb-1 mb-md-0">
|
||||
<a href="https://github.com/fleetdm/fleet/tree/master/docs" style="color: #fff; text-decoration: underline;" class="mr-1">Documentation</a>
|
||||
<a href="https://github.com/fleetdm/fleet/tree/main/docs" style="color: #fff; text-decoration: underline;" class="mr-1">Documentation</a>
|
||||
<a target="_blank" href="https://github.com/fleetdm/fleet" style="color: #fff; text-decoration: underline;" class="mr-1">Contribute</a>
|
||||
<a target="_blank" href="https://fleetdm.com/apply" style="color: #fff; text-decoration: underline;">Jobs at Fleet</a>
|
||||
</div>
|
||||
|
|
|
|||
4
website/views/pages/get-started.ejs
vendored
4
website/views/pages/get-started.ejs
vendored
|
|
@ -48,7 +48,7 @@
|
|||
Target some of the sample hosts included, and give it a try.
|
||||
<br />Unsure of what questions to ask?
|
||||
<a
|
||||
href="https://github.com/fleetdm/fleet/tree/master/handbook/queries"
|
||||
href="https://github.com/fleetdm/fleet/tree/main/handbook/queries"
|
||||
target="_blank"
|
||||
>Here’s a few queries to get you started.</a
|
||||
>
|
||||
|
|
@ -81,7 +81,7 @@
|
|||
>
|
||||
<a
|
||||
target="_blank"
|
||||
href="https://github.com/fleetdm/fleet/tree/master/docs"
|
||||
href="https://github.com/fleetdm/fleet/tree/main/docs"
|
||||
style="max-width: 150px"
|
||||
class="btn btn-block btn-md btn-primary my-1 mr-2"
|
||||
id="primary-button"
|
||||
|
|
|
|||
Loading…
Reference in a new issue