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