Skip to content

Commit

Permalink
Update path example for install_software.package_path (#25895)
Browse files Browse the repository at this point in the history
Related to #25867 

Paths are relative. Fixed in
[4.58.0](https://github.com/fleetdm/fleet/blob/main/CHANGELOG.md?plain=1#L308).

---------

Co-authored-by: Noah Talerman <[email protected]>
  • Loading branch information
marko-lisica and noahtalerman authored Jan 31, 2025
1 parent 78a9fda commit d30b8fd
Showing 1 changed file with 3 additions and 10 deletions.
13 changes: 3 additions & 10 deletions docs/Configuration/yaml-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,22 +62,21 @@ policies:
critical: false
calendar_event_enabled: false
run_script:
path: "../lib/disable-guest-account.sh"
path: "./disable-guest-account.sh"
- name: Firefox on Linux installed and up to date
platform: linux
description: "This policy checks that Firefox is installed and up to date."
resolution: "Install Firefox version 129.0.2 or higher."
query: "SELECT 1 FROM deb_packages WHERE name = 'firefox' AND version_compare(version, '129.0.2') >= 0;"
install_software:
package_path: "../lib/linux-firefox.deb.package.yml"
package_path: "./linux-firefox.deb.package.yml"
```

`default.yml` (for policies that neither install software nor run scripts), `teams/team-name.yml`, or `teams/no-team.yml`

```yaml
policies:
- path: ../lib/policies-name.policies.yml
# path is relative to default.yml, teams/team-name.yml, or teams/no-team.yml
```

> Currently, the `run_script` and `install_software` policy automations can only be configured for a team (`teams/team-name.yml`) or "No team" (`teams/no-team.yml`). The automations can only be added to policies in which the script (or software) is defined in the same team (or "No team"). `calendar_event_enabled` can only be configured for policies on a team.
Expand Down Expand Up @@ -135,7 +134,6 @@ queries:
```yaml
queries:
- path: ../lib/queries-name.queries.yml
# path is relative to default.yml, teams/team-name.yml, or teams/no-team.yml
```

## agent_options
Expand Down Expand Up @@ -192,9 +190,8 @@ config:
> We want `-` for policies and queries because it’s an array. Agent Options we do not use `-` for `path`.

```yaml
queries:
agent_options:
path: ../lib/agent-options.yml
# path is relative to default.yml, teams/team-name.yml, or teams/no-team.yml
```

## controls
Expand Down Expand Up @@ -256,7 +253,6 @@ controls:
enable: true
mode: voluntary
webhook_url: https://example.org/webhook_handler
# paths are relative to default.yml or teams/team-name.yml
```

### macos_updates
Expand Down Expand Up @@ -336,7 +332,6 @@ software:
labels_include_any:
- Engineering
- Customer Support
# path is relative to default.yml, teams/team-name.yml, or teams/no-team.yml
app_store_apps:
- app_store_id: '1091189122'
```
Expand Down Expand Up @@ -746,8 +741,6 @@ The `yara_rules` section lets you define [YARA rules](https://virustotal.github.
YARA rule functionality. Learn more about authenticated YARA rules in Fleet
[here](https://fleetdm.com/guides/remote-yara-rules).

Each entry should be the relative path to a valid YARA rule file.

##### Example

```yaml
Expand Down

0 comments on commit d30b8fd

Please sign in to comment.