mirror of
https://github.com/fleetdm/fleet
synced 2026-04-21 13:37:30 +00:00
fleetctl guide: install Node.js (#22396)
- Install w/ npm was missing prereq: install Node.js - Also use "fleetctl" instead of `fleetctl` when referring the the tool/noun and not the command - Added this to the handbook here: https://github.com/fleetdm/fleet/pull/22397 --------- Co-authored-by: JD <spokanemac@users.noreply.github.com>
This commit is contained in:
Noah Talerman
GitHub
parent
9e8bb24f6d
commit
d748b3bbf7
1 changed files with 18 additions and 14 deletions
|
|
@ -10,15 +10,19 @@ fleetctl also provides a quick way to work with all the data exposed by Fleet wi
|
|||
|
||||
## Installing fleetctl
|
||||
|
||||
Install fleetctl with npm or download the binary from [GitHub](https://github.com/fleetdm/fleet/releases).
|
||||
Download and install [Node.js](https://nodejs.org/en).
|
||||
|
||||
Install fleetctl with npm (included in Node.js).
|
||||
|
||||
```sh
|
||||
npm install -g fleetctl
|
||||
sudo npm install -g fleetctl
|
||||
```
|
||||
|
||||
To install fleetctl on Windows or Linux, download the fleectl binary here on [GitHub](https://github.com/fleetdm/fleet/releases).
|
||||
|
||||
### Upgrading fleetctl
|
||||
|
||||
The easiest way to update fleetctl is by running the installation command again.
|
||||
The easiest way to update fleetctl is by rerunning the installation command.
|
||||
|
||||
```sh
|
||||
npm install -g fleetctl@latest
|
||||
|
|
@ -30,7 +34,7 @@ npm install -g fleetctl@latest
|
|||
### Available commands
|
||||
|
||||
|
||||
Much of the functionality available in the Fleet UI is also available in `fleetctl`. You can run queries, add and remove users, generate Fleet's agent (fleetd) to add new hosts, get information about existing hosts, and more!
|
||||
Much of the functionality available in the Fleet UI is also available in fleetctl. You can run queries, add and remove users, generate Fleet's agent (fleetd) to add new hosts, get information about existing hosts, and more!
|
||||
|
||||
> Note: Unless a logging infrastructure is configured on your Fleet server, osquery-related logs will be stored locally on each device. Read more [here](https://fleetdm.com/guides/log-destinations)
|
||||
|
||||
|
|
@ -74,7 +78,7 @@ This section walks you through authentication, assuming you already have a runni
|
|||
|
||||
### Login
|
||||
|
||||
To log in to your Fleet instance, run following commands:
|
||||
To log in to your Fleet instance, run the following commands:
|
||||
|
||||
1. Set the Fleet instance address
|
||||
|
||||
|
|
@ -93,11 +97,11 @@ Password:
|
|||
[+] Fleet login successful and context configured!
|
||||
```
|
||||
|
||||
Once your local context is configured, you can use `fleetctl` normally.
|
||||
Once your local context is configured, you can use fleetctl normally.
|
||||
|
||||
### Log in with SAML (SSO) authentication
|
||||
|
||||
Users that authenticate to Fleet via SSO should retrieve their API token from the UI and set it manually in their `fleetctl` configuration (instead of logging in via `fleetctl login`).
|
||||
Users that authenticate to Fleet via SSO should retrieve their API token from the UI and manually set it in their fleetctl configuration (instead of logging in via `fleetctl login`).
|
||||
|
||||
**Fleet UI:**
|
||||
1. Go to the **My account** page (https://fleet.example.com/profile)
|
||||
|
|
@ -116,13 +120,13 @@ The token can also be set with `fleetctl config set --token`, but this may leak
|
|||
|
||||
## Using fleetctl with an API-only user
|
||||
|
||||
When running automated workflows using the Fleet API, we recommend an API-only user's API key rather than the API key of a regular user. A regular user's API key expires frequently for security purposes, requiring routine updates. Meanwhile, an API-only user's key does not expire.
|
||||
When running automated workflows using the Fleet API, we recommend using an API-only user's API key rather than a regular user's API key. A regular user's API key expires frequently for security purposes, requiring routine updates. Meanwhile, an API-only user's key does not expire.
|
||||
|
||||
An API-only user does not have access to the Fleet UI. Instead, it's only purpose is to interact with the API programmatically or from fleetctl.
|
||||
|
||||
### Create API-only user
|
||||
|
||||
Before creating the API-only user, log in to `fleetctl` as an admin. See [authentication](https://#authentication) above for details.
|
||||
Before creating the API-only user, log in to fleetctl as an admin. See [authentication](https://#authentication) above for details.
|
||||
|
||||
To create your new API-only user, use `fleetctl user create`:
|
||||
|
||||
|
|
@ -154,12 +158,12 @@ fleetctl user create --name "API User" --email api@example.com --password temp@p
|
|||
|
||||
#### Changing permissions
|
||||
|
||||
To change roles of a current user, log into the Fleet UI as an admin and navigate to **Settings > Users**.
|
||||
> Suggestion: To disable/enable a user's access to the UI (converting a regular user to an API-only user or vice versa), create a new user.
|
||||
To change the role of a current user, log into the Fleet UI as an admin and navigate to Settings > Users.
|
||||
> Suggestion: Create a new user to disable/enable a user's access to the UI (converting a regular user to an API-only user or vice versa).
|
||||
|
||||
### Switching users
|
||||
|
||||
To use `fleetctl` with your regular user account but occasionally use your API-only user for specific cases, you can set up your `fleetctl` config with a new `context` to hold the credentials of your API-only user:
|
||||
To use fleetctl with your regular user account but occasionally use your API-only user for specific cases, you can set up your fleetctl config with a new `context` to hold the credentials of your API-only user:
|
||||
|
||||
```sh
|
||||
fleetctl config set --address https://dogfood.fleetdm.com --context api
|
||||
|
|
@ -181,7 +185,7 @@ Running a command with no context will use the default profile.
|
|||
|
||||
## Debugging Fleet
|
||||
|
||||
`fleetctl` provides debugging capabilities about the running Fleet server via the `debug` command. To see a complete list of all the options run:
|
||||
fleetctl provides debugging capabilities about the running Fleet server via the `debug` command. To see a complete list of all the options, run:
|
||||
|
||||
```sh
|
||||
fleetctl debug --help
|
||||
|
|
@ -204,4 +208,4 @@ This will generate a `tar.gz` file with:
|
|||
<meta name="authorFullName" value="Noah Talerman">
|
||||
<meta name="publishedOn" value="2024-07-04">
|
||||
<meta name="articleTitle" value="fleetctl">
|
||||
<meta name="description" value="Read about fleetctl, a CLI tool for managing Fleet and osquery configurations, running queries, generating Fleet's agent (fleetd) and more.">
|
||||
<meta name="description" value="Read about fleetctl, a CLI tool for managing Fleet and osquery configurations, running queries, generating Fleet's agent (fleetd), and more.">
|
||||
|
|
|
|||
Loading…
Reference in a new issue