Skip to content

Commit aabd716

Browse files
stirbystirby
committed
added telemetry to admin/setup, fixed up setup README
1 parent 4ab42ef commit aabd716

File tree

3 files changed

+58
-9
lines changed

3 files changed

+58
-9
lines changed

‎docs/admin/setup/README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Coder server's primary configuration is done via environment variables. For a
44
full list of the options, run `coder server --help` or see our
5-
[CLI documentation](../reference/cli/server.md).
5+
[CLI documentation](../../reference/cli/server.md).
66

77
## Access URL
88

@@ -40,8 +40,8 @@ coder server
4040
## Wildcard access URL
4141

4242
`CODER_WILDCARD_ACCESS_URL` is necessary for
43-
[port forwarding](../admin/networking/port-forwarding.md#dashboard) via the
44-
dashboard or running [coder_apps](../admin/templates/README.md) on an absolute
43+
[port forwarding](../networking/port-forwarding.md#dashboard) via the
44+
dashboard or running [coder_apps](../templates/README.md) on an absolute
4545
path. Set this to a wildcard subdomain that resolves to Coder (e.g.
4646
`*.coder.example.com`).
4747

@@ -51,8 +51,8 @@ If you are providing TLS certificates directly to the Coder server, either
5151
2. Configure multiple certificates and keys via
5252
[`coder.tls.secretNames`](https://github.com/coder/coder/blob/main/helm/coder/values.yaml)
5353
in the Helm Chart, or
54-
[`--tls-cert-file`](../reference/cli/server.md#--tls-cert-file) and
55-
[`--tls-key-file`](../reference/cli/server.md#--tls-key-file) command line
54+
[`--tls-cert-file`](../../reference/cli/server.md#--tls-cert-file) and
55+
[`--tls-key-file`](../../reference/cli/server.md#--tls-key-file) command line
5656
options (these both take a comma separated list of files; list certificates
5757
and their respective keys in the same order).
5858

@@ -145,10 +145,10 @@ integrations with git providers, such as GitHub, GitLab, and Bitbucket etc.
145145
External authentication can also be used to integrate with external services
146146
like JFrog Artifactory and others.
147147

148-
Please refer to the [external authentication](../admin/external-auth.md) section
148+
Please refer to the [external authentication](../external-auth.md) section
149149
for more information.
150150

151151
## Up Next
152152

153-
- [Learn how to setup and manage templates](./templates/README.md)
154-
- [Setup external provisioners](./provisioners.md)
153+
- [Learn how to setup and manage templates](../templates/README.md)
154+
- [Setup external provisioners](../provisioners.md)

‎docs/admin/setup/telemetry.md

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Telemetry
2+
3+
<blockquote class="info">
4+
TL;DR: disable telemetry by setting <code>CODER_TELEMETRY=false</code>.
5+
</blockquote>
6+
7+
Coder collects telemetry from all installations by default. We believe our users
8+
should have the right to know what we collect, why we collect it, and how we use
9+
the data.
10+
11+
## What we collect
12+
13+
You can find a full list of the data we collect in our source code
14+
[here](https://github.com/coder/coder/blob/main/coderd/telemetry/telemetry.go).
15+
In particular, look at the struct types such as `Template` or `Workspace`.
16+
17+
As a rule, we **do not collect** the following types of information:
18+
19+
- Any data that could make your installation less secure
20+
- Any data that could identify individual users
21+
22+
For example, we do not collect parameters, environment variables, or user email
23+
addresses.
24+
25+
## Why we collect
26+
27+
Telemetry helps us understand which features are most valuable, what use cases
28+
to focus on, and which bugs to fix first.
29+
30+
Most cloud-based software products collect far more data than we do. They often
31+
offer little transparency and configurability. It's hard to imagine our favorite
32+
SaaS products existing without their creators having a detailed understanding of
33+
user interactions. We want to wield some of that product development power to
34+
build self-hosted, open-source software.
35+
36+
## Security
37+
38+
In the event we discover a critical security issue with Coder, we will use
39+
telemetry to identify affected installations and notify their administrators.
40+
41+
## Toggling
42+
43+
You can turn telemetry on or off using either the `CODER_TELEMETRY=[true|false]`
44+
environment variable or the `--telemetry=[true|false]` command-line flag.

‎docs/manifest.json

+6-1
Original file line numberDiff line numberDiff line change
@@ -159,8 +159,13 @@
159159
{
160160
"title": "Appearance",
161161
"description": "Learn how to configure the appearance of Coder",
162-
"path": "./admin/appearance.md",
162+
"path": "./admin/setup/appearance.md",
163163
"state": ["enterprise", "premium"]
164+
},
165+
{
166+
"title": "Telemetry",
167+
"description": "Learn what usage telemetry Coder collects",
168+
"path": "./admin/setup/telemetry.md"
164169
}
165170
]
166171
},

0 commit comments

Comments
 (0)