Skip to content

Commit 57cc333

Browse files
authored
(chore) alphabetize sidenav; .env.local --> env; clean up /account-portal/overview#sign-in-or-up (#2060)
1 parent 22bdbaf commit 57cc333

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+331
-449
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -420,7 +420,7 @@ You can use the following shortcodes within a code block to inject information f
420420
- `{{fapi_url}}` – Frontend API URL
421421

422422
````mdx
423-
```sh {{ filename: '.env.local' }}
423+
```sh {{ filename: '.env' }}
424424
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY={{pub_key}}
425425
CLERK_SECRET_KEY={{secret}}
426426
```

docs/advanced-usage/satellite-domains.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ To access authentication state from a satellite domain, users will be transparen
6969
- In the `.env` file associated with your primary domain:
7070

7171
<CodeBlockTabs options={["Next.js", "Remix"]}>
72-
```env {{ filename: '.env.local' }}
72+
```env {{ filename: '.env' }}
7373
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY={{pub_key}}
7474
CLERK_SECRET_KEY={{secret}}
7575
NEXT_PUBLIC_CLERK_SIGN_IN_URL=/sign-in
@@ -85,7 +85,7 @@ To access authentication state from a satellite domain, users will be transparen
8585
- In the `.env` file associated with your other (satellite) domain:
8686

8787
<CodeBlockTabs options={["Next.js", "Remix"]}>
88-
```env {{ filename: '.env.local' }}
88+
```env {{ filename: '.env' }}
8989
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY={{pub_key}}
9090
CLERK_SECRET_KEY={{secret}}
9191
NEXT_PUBLIC_CLERK_IS_SATELLITE=true

docs/advanced-usage/using-proxies.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -184,11 +184,11 @@ When using a proxy, all requests to the Frontend API will be made through your d
184184

185185
#### Environment variables
186186

187-
To configure your proxy setup using environment variables, your `.env.local` file should look like this:
187+
To configure your proxy setup using environment variables, your `.env` file should look like this:
188188

189189
<Tabs items={["Next.js", "Remix", "JavaScript"]}>
190190
<Tab>
191-
```env {{ filename: '.env.local' }}
191+
```env {{ filename: '.env' }}
192192
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY={{pub_key}}
193193
CLERK_SECRET_KEY={{secret}}
194194
@@ -197,7 +197,7 @@ When using a proxy, all requests to the Frontend API will be made through your d
197197
</Tab>
198198

199199
<Tab>
200-
```env {{ filename: '.env.local' }}
200+
```env {{ filename: '.env' }}
201201
CLERK_PUBLISHABLE_KEY={{pub_key}}
202202
CLERK_SECRET_KEY={{secret}}
203203
@@ -208,7 +208,7 @@ When using a proxy, all requests to the Frontend API will be made through your d
208208
<Tab>
209209
You will only need to set environment variables in your JavaScript application if you are using a bundler (the `NPM module` method for ClerkJS installation). If you are using the `<script>` method, configure your proxy setup using [properties in your application](#properties-in-your-application) instead.
210210

211-
```env {{ filename: '.env.local' }}
211+
```env {{ filename: '.env' }}
212212
CLERK_PUBLISHABLE_KEY={{pub_key}}
213213
CLERK_SECRET_KEY={{secret}}
214214

docs/authentication/configuration/legal-compliance.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Legal compliance
33
description: Learn how to configure your legal compliance settings in the Clerk Dashboard.
44
---
55

6-
Clerk provides a legal compliance setting that allows you to require users to agree to your terms of service or privacy policy before they can sign up to your application. After enabling the setting, there will be a checkbox to accept the terms in your [`<SignUp />` component](/docs/components/authentication/sign-up) or [Account Portal sign-up page](/docs/account-portal/overview#sign-in-or-up).
6+
Clerk provides a legal compliance setting that allows you to require users to agree to your terms of service or privacy policy before they can sign up to your application. After enabling the setting, there will be a checkbox to accept the terms in your [`<SignUp />` component](/docs/components/authentication/sign-up) or [Account Portal sign-up page](/docs/account-portal/overview#sign-up).
77

88
To configure the setting:
99

docs/authentication/configuration/sign-up-sign-in-options.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ To enable social connections:
170170

171171
## Web3 authentication
172172

173-
Clerk provides [Web3 authentication](/docs/users/web3) with either MetaMask, Coinbase Wallet or OKX Wallet. As part of validating the accuracy of the returned Web3 account address, Clerk handles the signing of a message and verifying the signature. Because sign-in with Web3 uses the same abstraction as our other authentication factors, like passwords or email links, other Clerk features like multi-factor authentication and profile enrichment work for Web3 users out-of-the-box.
173+
Clerk provides Web3 authentication with either [MetaMask](/docs/authentication/web3/metamask), [Coinbase Wallet](/docs/authentication/web3/coinbase-wallet), or [OKX Wallet](/docs/authentication/web3/okx-wallet). As part of validating the accuracy of the returned Web3 account address, Clerk handles the signing of a message and verifying the signature. Because sign-in with Web3 uses the same abstraction as our other authentication factors, like passwords or email links, other Clerk features like multi-factor authentication and profile enrichment work for Web3 users out-of-the-box.
174174

175175
To enable Web3 authentication:
176176

docs/authentication/overview.mdx

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,24 @@ Clerk supports multiple authentication strategies so that you can implement the
77

88
## Configuration
99

10-
Clerk's configuration settings affect how the users of your application can [sign up and sign in](/docs/authentication/configuration/sign-up-sign-in-options) and which properties are editable via their user profile. You can also manage [user sessions](/docs/authentication/configuration/session-options), [control who gets access](/docs/authentication/configuration/restrictions) to your application, and [customize the email & SMS messages](/docs/authentication/configuration/email-sms-templates) that are sent by Clerk during authentication flows. All of these settings can be found under the **User & Authentication** section in the [Clerk Dashboard](https://dashboard.clerk.com/).
10+
Configuring your application is done through the [Clerk Dashboard](https://dashboard.clerk.com). The Clerk Dashboard is where you, as the application owner, can manage your application's settings, users, and organizations. For example, if you want to enable phone number authentication, multi-factor authentication, social providers like Google, delete users, or create organizations, you can do all of this and more in the Clerk Dashboard. You can even invite other users to join your [organization workspace](/docs/organizations/organization-workspaces) and help configure and manage your application with you.
1111

12-
For more information on how to set up your application, see the [setup guide](/docs/quickstarts/setup-clerk).
12+
## SSO authentication
13+
14+
SSO authentication allows users to sign in to your application using an existing account from an external identity provider (IdP), such as Google.
15+
16+
Clerk supports the following SSO types:
17+
18+
- [OAuth SSO, also known as social connections or social providers](/docs/authentication/social-connections/overview)
19+
- [Enterprise SSO](/docs/authentication/enterprise-connections/overview)
20+
- SAML
21+
- OIDC
22+
- EASIE
23+
24+
## Web3 authentication
25+
26+
Clerk supports the following Web3 providers:
27+
28+
- [Coinbase Wallet](/docs/authentication/web3/coinbase-wallet)
29+
- [Metamask](/docs/authentication/web3/metamask)
30+
- [OKX Wallet](/docs/authentication/web3/okx-wallet)

docs/authentication/social-connections/oauth.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ The easiest way to add social connections to your Clerk app is by using [prebuil
1717

1818
## Enable a social connection
1919

20+
### Development instances
21+
2022
For **development** instances, Clerk uses pre-configured shared OAuth credentials and redirect URIs to make the development flow as smooth as possible. This means that you can enable most social providers without additional configuration.
2123

2224
To enable a social connection:
@@ -26,6 +28,8 @@ To enable a social connection:
2628
1. In the **Choose provider** dropdown, select the provider you want to use.
2729
1. Select **Add connection**.
2830

31+
### Production instances
32+
2933
For **production** instances, you will need to configure the provider with custom OAuth credentials. See the social provider's [dedicated guide](/docs/authentication/social-connections/overview) for more information.
3034

3135
## Configure additional OAuth scopes

docs/backend-requests/resources/cookies.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Cookies
33
description: Learn how cookies enable secure authentication and manage browser-server interactions.
44
---
55

6-
Cookies play a vital role in authentication, state management, and browser-server communication. By understanding their attributes, developers can ensure secure and efficient use in their applications. Clerk leverages cookies in a secure, privacy-compliant manner to facilitate seamless user authentication across domains and subdomains.
6+
Cookies play a vital role in authentication, state management, and browser-server communication. By understanding their attributes, developers can ensure secure and efficient use in their applications.
77

88
## What are cookies?
99

@@ -101,3 +101,7 @@ Cookies **explicitly** set with a domain appear in devtools with a leading perio
101101
## Controlling JavaScript access with `HttpOnly`
102102

103103
By default, cookies can be accessed via `document.cookie` in JavaScript. While this can be useful, it exposes cookies to risks like [Cross-Site Scripting (XSS) attacks](https://owasp.org/www-community/attacks/xss/). Setting the [`HttpOnly`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#httponly) flag prevents JavaScript from accessing the cookie, enhancing security. These cookies are still sent with HTTP requests but are inaccessible to client-side scripts.
104+
105+
## How Clerk uses cookies
106+
107+
Clerk leverages cookies in a secure, privacy-compliant manner to facilitate seamless user authentication across domains and subdomains. See the [guide on Clerk cookies](/docs/how-clerk-works/cookies) for more details.

docs/components/clerk-provider.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ The recommended approach is to wrap your entire app with `<ClerkProvider>` at th
5555
const PUBLISHABLE_KEY = import.meta.env.VITE_CLERK_PUBLISHABLE_KEY
5656

5757
if (!PUBLISHABLE_KEY) {
58-
throw new Error('Add your Clerk Publishable Key to the .env.local file')
58+
throw new Error('Add your Clerk Publishable Key to the .env file')
5959
}
6060

6161
ReactDOM.createRoot(document.getElementById('root')!).render(

docs/components/control/redirect-to-signin.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ The `<RedirectToSignIn />` component will navigate to the sign in URL which has
6767
const PUBLISHABLE_KEY = import.meta.env.VITE_CLERK_PUBLISHABLE_KEY
6868

6969
if (!PUBLISHABLE_KEY) {
70-
throw new Error('Add your Clerk Publishable Key to the .env.local file')
70+
throw new Error('Add your Clerk Publishable Key to the .env file')
7171
}
7272

7373
function PrivatePage() {

0 commit comments

Comments
 (0)