Skip to content

Document PROJECT_OWNER_ENABLED #758

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ComfortablyCoding wants to merge 1 commit into
base: main
Choose a base branch
from
+19 −4
Open

Document PROJECT_OWNER_ENABLED #758

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion content/configuration/1.general.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ description: Configuration for the general system, server, first admin user, and
| `GRAPHQL_SCHEMA_GENERATION_MAX_CONCURRENT` | How many GraphQL schemas can be generated simultaneously. | `5` |
| `ROBOTS_TXT` | What the `/robots.txt` endpoint should return. | `User-agent: *\nDisallow: /` |
| `TEMP_PATH` | Where Directus' temporary files should be managed. | `./node_modules/.directus` |
| `PROJECT_OWNER` | Registered owner and primary contact responsible for your Directus instance. | |


::callout{icon="i-lucide-triangle-alert" color="warning"}
Expand Down Expand Up @@ -77,3 +76,17 @@ To more accurately gauge the frequency of installation, version fragmentation, a
::callout{icon="i-lucide-book-open" color="primary" to="/licensing/telemetry"}
For a full breakdown of what is collected, when it is sent, and how to opt out, see [Telemetry](/licensing/telemetry).
::

## Project Owner Registration

The first time an owner is set for your instance, Directus sends a one-time registration that associates the project with a point of contact. Alongside the owner, this includes details such as organization name, how the project is used, and whether you opted in to product updates.

| Variable | Description | Default Value |
| ----------------------- | ---------------------------------------------------------------------------- | ------------- |
| `PROJECT_OWNER` | Registered owner and primary contact responsible for your Directus instance. | |
| `PROJECT_OWNER_ENABLED` | Whether Directus sends the project owner registration information. | `true` |

::callout{icon="i-lucide-book-open" color="primary" to="/licensing/telemetry#project-owner-registration"}
For a full breakdown of what the registration contains, and when it is sent, see [Project Owner Registration](/licensing/telemetry#project-owner-registration).
::

8 changes: 5 additions & 3 deletions content/licensing/2.telemetry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,9 @@ The registration is sent to `https://telemetry.directus.io`.

This registration is independent of both the usage report and the licensing service:

- It is not controlled by the `TELEMETRY` environment variable. Setting `TELEMETRY=false` stops the usage report (entitlement permitting) but does not currently prevent the project owner registration from being sent.
- It does not contact or depend on the licensing service.
- It is controlled by its own `PROJECT_OWNER_ENABLED` environment variable, not by `TELEMETRY`. Setting `TELEMETRY=false` stops the usage report (entitlement permitting) but does not affect the project owner registration.
- It does not contact or depend on the licensing service.

The only way to avoid sending the registration is to not set a project owner, which means skipping the onboarding form and leaving `PROJECT_OWNER` unset.
### How to Opt Out

Set `PROJECT_OWNER_ENABLED=false` to stop the registration from being sent. This works the same way `TELEMETRY=false` disables the usage report.
Loading