Add opt-out backend telemetry

Infisical · Nov 24, 2022 · b0eff2a · b0eff2a
1 parent e02fa7b
commit b0eff2a
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 4 deletions.
diff --git a/docs/self-hosting/configuration/envars.mdx b/docs/self-hosting/configuration/envars.mdx
@@ -22,12 +22,12 @@ Configuring Infisical requires setting some environment variables. There is a fi
 | `MONGO_URL`                  | ❗️ MongoDB instance connection string either to container instance or MongoDB Cloud                        | `None`           |
 | `MONGO_USERNAME`             | MongoDB username if using container                                                                         | `None`           |
 | `MONGO_PASSWORD`             | MongoDB password if using container                                                                         | `None`           |
-| `ENV`                        | ❗️ `production` or `development`                                                                           | `None`           |
 | `SITE_URL`                   | ❗️ Site URL - should be an absolute URL including the protocol (e.g. `https://app.infisical.com`)          | `None`           |
 | `SMT_HOST`                   | Whether the user joined the community                                                                       | `smtp.gmail.com` |
-| `SMTP_NAME`                  | ❗️ Whether the user joined the community                                                                   | `None`           |
-| `SMTP_USERNAME`              | ❗️ Whether the user joined the community                                                                   | `None`           |
-| `SMTP_PASSWORD`              | ❗️ Whether the user joined the community                                                                   | `None`           |
+| `SMTP_NAME`                  | Hostname to connect to for establishing SMTP connections (e.g. `Team`)                                      | `None`           |
+| `SMTP_USERNAME`              | ❗️ Credential to connect to host (e.g. `[email protected]`)                                               | `None`           |
+| `SMTP_PASSWORD`              | ❗️ Credential to connect to host                                                                           | `None`           |
+| `TELEMETRY_ENABLED`          | `true` or `false`. [More](../overview).                                                                     | `true`           |
 | `OAUTH_CLIENT_SECRET_HEROKU` | OAuth client secret for Heroku integration                                                                  | `None`           |
 | `OAUTH_TOKEN_URL_HEROKU`     | OAuth token URL for Heroku integration                                                                      | `None`           |
 | `SENTRY_DSN`                 | DSN for error-monitoring with Sentry                                                                        | `None`           |
diff --git a/docs/self-hosting/overview.mdx b/docs/self-hosting/overview.mdx
@@ -16,3 +16,11 @@ Infisical Cloud also comes with some extra features unavailabe in the self-hoste
 ## Deployment options
 
 Infisical can be deployed on a Linux VM with docker-compose. We're rolling out more specific deployment options for DigitalOcean, AWS, GCP, and Azure soon.
+
+## Telemetry
+
+Infisical collects telemetry data about general usage.
+
+The data helps us understand how the product is doing and guide our product development to create the best possible platform; it also helps us demonstrate growth for investors as we support Infisical as open-source software.
+
+To opt out of telemetry, you can set `TELEMETRY_ENABLED=false` within the [environment variables](./configuration/envars).