Skip to content
This repository has been archived by the owner on Oct 22, 2023. It is now read-only.

Commit

Permalink
Add documentation for forbid_telemetry.
Browse files Browse the repository at this point in the history
  • Loading branch information
charleskorn committed Oct 26, 2021
1 parent 151a044 commit 8736a8a
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 3 deletions.
18 changes: 15 additions & 3 deletions docs/reference/cli.mdx
Expand Up @@ -328,18 +328,24 @@ Example:

### `--no-telemetry`

If you would like to disable [telemetry collection](/privacy#in-app-telemetry) or uploading for a single invocation of Batect, pass the `--no-telemetry` flag.

By default, Batect uses the permission you granted it when it ran for the first time.

If you would like to disable telemetry collection or uploading for a single invocation, pass the `--no-telemetry` flag, for example:
Example:

```shell
./batect --no-telemetry the-task
```

Note that this does not cause any data that has been collected from other invocations but not uploaded to be removed - it will be uploaded the next time
Batect runs without the `--no-telemetry` flag.
Batect runs without the `--no-telemetry` flag. To disable telemetry permanently and remove any collected data pending upload, use
[`--permanently-disable-telemetry`](#--permanently-disable-telemetry).

You can also disable telemetry collection and reporting in other ways:

You can also set the `BATECT_ENABLE_TELEMETRY` environment variable to `false` to disable telemetry collection and uploading.
- set the `BATECT_ENABLE_TELEMETRY` environment variable to `false`
- set [`forbid_telemetry`](/docs/reference/config#forbid_telemetry) to `true` in your project's configuration file

### `--no-update-notification`

Expand Down Expand Up @@ -447,6 +453,12 @@ remove any data that has been collected but not yet uploaded.
This also resets your telemetry user ID, ensuring that if you do ever re-enable telemetry, any previous data uploaded is not associated with any
new data.

You can also disable telemetry collection and reporting in other ways:

- set the `BATECT_ENABLE_TELEMETRY` environment variable to `false`
- set [`forbid_telemetry`](/docs/reference/config#forbid_telemetry) to `true` in your project's configuration file
- use [`--no-telemetry`](#--no-telemetry) to disable telemetry for a single invocation of `./batect`

### `--permanently-enable-telemetry`

If you would like to opt-in to [telemetry](/privacy#in-app-telemetry), run `./batect --permanently-enable-telemetry` to enable collecting telemetry data.
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/config/overview.md
Expand Up @@ -127,6 +127,12 @@ Task names must meet the following requirements:

[Detailed reference for `tasks`](tasks.md)

### `forbid_telemetry`

Set to `true` to disable [telemetry collection](/privacy#in-app-telemetry) whenever this project is used.

Setting this to `true` takes precedence over any consent you may have provided in the past or any of the telemetry-related command line options.

## Expressions

Some fields support expressions - references to environment variables on the host or [config variables](config-variables.md).
Expand Down
2 changes: 2 additions & 0 deletions src/pages/privacy.md
Expand Up @@ -295,6 +295,8 @@ To opt-out after this initial run, do any of the following:

- Set the `BATECT_ENABLE_TELEMETRY` environment variable to `false`

- Set [`forbid_telemetry`](/docs/reference/config#forbid_telemetry) to `true` in your project's configuration file

If you wish to block telemetry data uploads at the network level, block access to `api.abacus.batect.dev`. Note that the IP address of this host name
can change at any time, so it is best to block the host name, not the IP address. (Do not block access to `batect.dev`, as that will block access to this site.)

Expand Down

0 comments on commit 8736a8a

Please sign in to comment.