History

docs: ship production T3 Connect public config in .env.example (#5573)

Theo Browne committed 3 months ago

Commit 4a07c1c1 parent cf5c9942 files · +22 −11Browse files

Unified · Split

2 files
  1. .env.example +12 −9
  2. docs/internals/t3-connect.md +10 −2
.env.example+12−9
@@ -1,12 +1,14 @@
11 # Optional: T3 Connect source builds
2−# Leave these unset to disable optional T3 Connect features in local source builds.
3−# Release builds inject their public values at build time. Do not add server-side
4−# secrets to this file.
2+# `cp .env.example .env` enables T3 Connect against the production deployment.
3+# These are the same public identifiers baked into official release builds, not
4+# secrets. Remove or comment them out to build with cloud features disabled.
5+# Do not add server-side secrets to this file.
56
6−# Get these from the Clerk Dashboard under API keys, JWT templates, and OAuth applications.
7−# T3CODE_CLERK_PUBLISHABLE_KEY=pk_test_...
8−# T3CODE_CLERK_JWT_TEMPLATE=t3-relay
9−# T3CODE_CLERK_CLI_OAUTH_CLIENT_ID=oauthapp_...
7+# Production Clerk instance. To use your own, get these from the Clerk Dashboard
8+# under API keys, JWT templates, and OAuth applications.
9+T3CODE_CLERK_PUBLISHABLE_KEY=pk_live_Y2xlcmsudDMuY29kZXMk
10+T3CODE_CLERK_JWT_TEMPLATE=t3-relay
11+T3CODE_CLERK_CLI_OAUTH_CLIENT_ID=hzxSgY2cH10sDU2r
1012
1113 # Optional: signed macOS passkey builds. The RP domain defaults to the Frontend API
1214 # hostname encoded in T3CODE_CLERK_PUBLISHABLE_KEY. Set the override only when Clerk
@@ -15,8 +17,9 @@ · 2 unmodified lines
1517 # T3CODE_MACOS_PROVISIONING_PROFILE=/absolute/path/to/t3code.provisionprofile
1618 # T3CODE_CLERK_PASSKEY_RP_DOMAINS=example.clerk.accounts.dev,clerk.example.com
1719
18−# Get this from your relay deployment. `infra/relay` deploys update it automatically.
19−# T3CODE_RELAY_URL=https://relay.example.com
20+# Production relay. For a self-hosted relay, `infra/relay` deploys update it
21+# automatically.
22+T3CODE_RELAY_URL=https://relay.t3.codes
2023
2124 # Optional: hosted app origin used by the CLI's out-of-band OAuth flow.
2225 # Defaults to https://app.t3.codes; override to test against a staging deployment.
docs/internals/t3-connect.md+10−2
@@ -14,8 +14,16 @@ For the wider system diagram, see · 13 unmodified lines
1414
1515 ## Application Keys
1616
17−T3 Connect is disabled in a fresh clone. To enable it for source builds, add a repository-root `.env`
18−or `.env.local` file:
17+T3 Connect is disabled in a fresh clone. To enable it for source builds against the production
18+deployment, copy the repository-root example file:
19+
20+```sh
21+cp .env.example .env
22+```
23+
24+`.env.example` carries the production public identifiers (the same values baked into official
25+release builds). To target a different Clerk application or relay, set the values yourself in a
26+repository-root `.env` or `.env.local` file:
1927
2028 ```dotenv
2129 T3CODE_CLERK_PUBLISHABLE_KEY=<publishable key>