mirror of
https://github.com/fleetdm/fleet
synced 2026-04-21 13:37:30 +00:00
Note Docker/Docker Compose dependencies in fleetctl (#22903)
#21447 Validated based on looking through code. If I need to try running fleetctl with a bare OS to confirm these are all the packages we need in each case let me know. --------- Co-authored-by: Noah Talerman <47070608+noahtalerman@users.noreply.github.com>
This commit is contained in:
parent
9dbe04da49
commit
24bac36143
6 changed files with 18 additions and 8 deletions
|
|
@ -10,15 +10,21 @@ Fleet supports the [latest version of osquery](https://github.com/osquery/osquer
|
|||
|
||||
## CLI
|
||||
|
||||
> You must have `fleetctl` installed. [Learn how to install `fleetctl`](https://fleetdm.com/docs/using-fleet/fleetctl-cli#installing-fleetctl).
|
||||
> You must have `fleetctl` installed. [Learn how to install `fleetctl`](https://fleetdm.com/guides/fleetctl#installing-fleetctl).
|
||||
|
||||
The `fleetctl package` command is used to generate Fleet's agent (fleetd) install package..
|
||||
|
||||
The `--type` flag is used to specify the fleetd installer type. Note that Windows can only generate an MSI package:
|
||||
The `--type` flag is used to specify the fleetd installer type.
|
||||
|
||||
- macOS: .pkg
|
||||
- Generating a .pkg on Linux requires [Docker](https://docs.docker.com/get-docker) to be installed and running.
|
||||
- Windows: .msi
|
||||
- Generating a .msi on Windows, Intel Macs, or Linux requires [Docker](https://docs.docker.com/get-docker) to be installed and running. On Windows, you can [use WiX without Docker instead](https://fleetdm.com/guides/enroll-hosts#generating-fleetd-for-windows-using-local-wix-toolset).
|
||||
- Generating a .msi on Apple Silicon Macs requires [Wine](https://fleetdm.com/install-wine) to be installed.
|
||||
- Linux: .deb or .rpm
|
||||
|
||||
|
||||
> `fleetctl` on Windows can only generate MSI packages.
|
||||
|
||||
A `--fleet-url` (Fleet instance URL) and `--enroll-secret` (Fleet enrollment secret) must be specified in order to communicate with Fleet instance.
|
||||
|
||||
#### Example
|
||||
|
|
|
|||
|
|
@ -18,7 +18,9 @@ Install fleetctl with npm (included in Node.js).
|
|||
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).
|
||||
To install fleetctl on Windows or Linux, download the fleectl binary from [GitHub](https://github.com/fleetdm/fleet/releases).
|
||||
|
||||
> To generate `fleetd` packages to enroll hosts, you may need [additional dependencies](https://fleetdm.com/guides/enroll-hosts#cli), depending on both your operating system and the OS you're packaging `fleetd` for.
|
||||
|
||||
### Upgrading fleetctl
|
||||
|
||||
|
|
|
|||
|
|
@ -257,7 +257,7 @@ const PlatformWrapper = ({
|
|||
Run this command with the{" "}
|
||||
<a
|
||||
className={`${baseClass}__command-line-tool`}
|
||||
href="https://fleetdm.com/learn-more-about/fleetctl"
|
||||
href="https://fleetdm.com/learn-more-about/installing-fleetctl"
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
>
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ To sign and notarize a generated `pkg` you must have:
|
|||
2. An Apple Store Connect API key
|
||||
|
||||
> Note: the Developer ID certificate must be in PEM format because this image
|
||||
> can be run in automated enviroments where secrets are passed via environment
|
||||
> can be run in automated environments where secrets are passed via environment
|
||||
> variables, and thus they must be in plain text.
|
||||
>
|
||||
> To convert a PKCS 12 certificate to PEM, you can run the following command:
|
||||
|
|
|
|||
|
|
@ -6,6 +6,8 @@ Use the `fleetctl` CLI to interact with Fleet, the lightweight telemetry platfor
|
|||
|
||||
From the command line, install `fleetctl` with `npm install -g fleetctl`.
|
||||
|
||||
See the [documentation on enrolling hosts](https://fleetdm.com/guides/enroll-hosts#cli) for additional requirements for using `fleetctl package`.
|
||||
|
||||
## Usage
|
||||
|
||||
See the [fleetctl documentation](https://fleetdm.com/docs/using-fleet/fleetctl-cli) or `fleetctl --help` for usage instructions.
|
||||
See the [fleetctl documentation](https://fleetdm.com/guides/fleetctl) or `fleetctl --help` for usage instructions.
|
||||
|
|
|
|||
2
website/config/routes.js
vendored
2
website/config/routes.js
vendored
|
|
@ -580,7 +580,7 @@ module.exports.routes = {
|
|||
'GET /learn-more-about/uninstall-scripts': '/guides/deploy-software-packages#uninstall-script',
|
||||
'GET /learn-more-about/read-package-version': '/guides/deploy-software-packages#add-a-software-package-to-a-team',
|
||||
'GET /learn-more-about/fleetctl': '/guides/fleetctl',
|
||||
|
||||
'GET /learn-more-about/installing-fleetctl': '/guides/fleetctl#installing-fleetctl',
|
||||
|
||||
// Sitemap
|
||||
// =============================================================================================================
|
||||
|
|
|
|||
Loading…
Reference in a new issue