Skip to content
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.

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

Add chrome extension docs #1004

Open
wants to merge 146 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
146 commits
Select commit Hold shift + click to select a range
f4d174f
Added Chrome Extension quickstart draft
royanger May 8, 2024
c27b3e1
Scaffolded Chrome Extension section with Overview and Add React Route…
royanger May 8, 2024
a22cca2
Added first draft of react router guide
royanger May 8, 2024
e7a9f16
update copy for chrome extension QS
alexisintech May 9, 2024
8c51fdf
Update docs/quickstarts/chrome-extension.mdx
alexisintech May 9, 2024
b914288
Update docs/quickstarts/chrome-extension.mdx
alexisintech May 9, 2024
b2fad09
Update docs/quickstarts/chrome-extension.mdx
alexisintech May 10, 2024
db6027b
Added syncsessionwithtab, deployment pages, added content for all pages
royanger May 17, 2024
83e0483
Updated manifest to new format, minor cleanup of some issues
royanger May 17, 2024
aa02331
Added `permission` to syncSessionWithTab guide
royanger May 17, 2024
59e44e8
Apply suggestions from code review
royanger May 17, 2024
c0ef337
guide updates
alexisintech May 22, 2024
ceb71e8
update react router guide
alexisintech May 22, 2024
943590c
update overview
alexisintech May 22, 2024
8024c9d
Updated copy, added link from overview to deployment
royanger Jun 28, 2024
fd48074
(wip) Adding more details to auth options, more deployment info
royanger Jul 4, 2024
242ce0b
First draft rewrite of the Chrome Extension Quickstart to use Plasmo …
royanger Jul 20, 2024
51398e5
Minor edits
royanger Jul 22, 2024
49c533a
Updated Chrome Extension React Router guide
royanger Jul 24, 2024
17111e0
Updated Chrome Extension react router guide
royanger Jul 24, 2024
b1f74c3
Updated the `syncSessionWithTab` guide
royanger Jul 24, 2024
3588098
Removed unneeded section from Quickstart
royanger Jul 25, 2024
6adff65
Updated the Chrome Extension doc for configuring CRD Id
royanger Jul 26, 2024
6c97c1e
Updated deployment guide, other small updates
royanger Jul 26, 2024
5d652e7
edit deploy guide
alexisintech Aug 1, 2024
6684ccf
Merge branch 'main' into roy/add-chrome-extension-docs
alexisintech Aug 1, 2024
cc14996
format deploy guide
alexisintech Aug 1, 2024
d651d05
format overview
alexisintech Aug 1, 2024
4b63d23
remove unnecessary copy from deployment guide
alexisintech Aug 1, 2024
5c0c349
update and format quickstart
alexisintech Aug 1, 2024
be0ca47
update deployment guide
alexisintech Aug 1, 2024
d971ef7
update deployment guide name in sidenav
alexisintech Aug 1, 2024
a1e05b9
fix formatting for deployment guide
alexisintech Aug 1, 2024
8a6f064
Merge branch 'main' into roy/add-chrome-extension-docs
alexisintech Aug 14, 2024
39af324
Merge branch 'main' into roy/add-chrome-extension-docs
bradlc Sep 4, 2024
2c7379b
General cleanup; apply formatting
bradlc Sep 4, 2024
d8dc758
fix links
bradlc Sep 4, 2024
ba77e0f
Hugging Face OAuth Guide follow-up review (#1505)
alexisintech Sep 4, 2024
590d75e
Add Clerk + InstantDB integration guide (#1512)
stopachka Sep 5, 2024
f17541b
Remove OAuth references from custom SAML connection docs (#1514)
LauraBeatris Sep 5, 2024
f861d5f
Fix typos in astro.mdx (#1518)
lorenzolewis Sep 6, 2024
9fbf02d
Move sections about Account Portal hosted pages to AP overview; refre…
alexisintech Sep 6, 2024
dbd2302
add instructions to sign up on localhost (#1515)
mwickett Sep 6, 2024
4d3071c
Update card logos (#1520)
bradlc Sep 9, 2024
eadfb61
Change "Cypress" to "Playwright" in Playwright docs (#1524)
stilt0n Sep 9, 2024
120dbb5
Property 'biometryType' does not exist on type 'LocalCredentialsRetur…
MathieuNls Sep 9, 2024
cd87cd8
Emphasize importance of `authorizedParties` argument use on the backe…
jescalan Sep 9, 2024
64772df
Update custom-signup-signin-pages.mdx (#1523)
sherlocked6 Sep 9, 2024
c54abe0
[fix] change function declaration to export default (#1525)
victoriaxyz Sep 10, 2024
83ff88f
[fix] change spelling from ap to app (#1526)
victoriaxyz Sep 10, 2024
df1b818
TanStack Start SDK (#1495)
octoper Sep 11, 2024
7b7b529
[fix] Refactor sign up and sign in options doc (#1517)
victoriaxyz Sep 11, 2024
875aa5d
chore: Add ClerkProvider properties (#1510)
LekoArts Sep 12, 2024
f4cde8c
Update Playwright docs (#1527)
victoriaxyz Sep 12, 2024
bbd91fe
[fix] update doc for custom sign-out flow and code examples for next.…
victoriaxyz Sep 12, 2024
5ef1bb9
Remove typo in guides overview (#1534)
gopinav Sep 13, 2024
e776fac
docs(astro): Add `<UserProfile />` custom pages and links section (#1…
wobsoriano Sep 13, 2024
4ec3dec
docs-9205: change appearance prop color from red to purple (#1536)
victoriaxyz Sep 13, 2024
e5a046a
feat: Native Apple sign in (#1294)
gkats Sep 16, 2024
5061b55
Update Reset a user's MFA instructions to use Dashboard over BAPI (#1…
alexisintech Sep 16, 2024
ea5cfcc
docs: fix typo in set-up-preview-environment.mdx (#1539)
yamcodes Sep 16, 2024
386ccb9
Correct broken link (#1541)
skullface Sep 16, 2024
52db88d
(/quickstarts/nextjs) Mention use of Account Portal (#1533)
alexisintech Sep 16, 2024
8ca5900
Update Staging guides: support subdomains over buying separate domain…
alexisintech Sep 16, 2024
2b7d8ae
iOS: Guide - Sign in with Apple (#1397)
mikepitre Sep 16, 2024
10d1eb2
Clarify how to integrate Account Portal into an app (#1542)
alexisintech Sep 17, 2024
f74b3ea
Change appearance prop examples to not use red as primary color & use…
victoriaxyz Sep 17, 2024
923154a
Add `track` prop to dashboard link in Next.js Quickstart (#1547)
bradlc Sep 17, 2024
2c6017c
Add example on defining Clerk keys per tenant from `clerkMiddleware` …
LauraBeatris Sep 17, 2024
7a565b9
(/quickstarts/remix) Remove unnecessary code from examples; add run p…
alexisintech Sep 17, 2024
7850e3e
Update invitations (user and organizations); update custom flow for u…
alexisintech Sep 17, 2024
157cf1a
Update code example for deleting a user (#1548)
alexisintech Sep 18, 2024
dd3e8ab
fix: Step 7 & 8 of Neon integration guide (#1552)
zeguillen Sep 19, 2024
50a41ae
update advanced guides with warnings on when and how to use (#1549)
victoriaxyz Sep 19, 2024
7b89c8f
feat: Improve ClerkProvider docs (#1553)
LekoArts Sep 20, 2024
6d56db7
Add callout about Clerk auto-deleting empty organizations (#1550)
alexisintech Sep 20, 2024
da54b75
Update organization-profile.mdx (#1557)
jasonaw98 Sep 24, 2024
26642f4
Move password hasher info from BAPI docs to Clerk docs (#1551)
alexisintech Sep 24, 2024
721d1cd
add run instructions to quickstarts (#1545)
mwickett Sep 24, 2024
c054bbc
Update method signature in iOS Sign in with Apple guide (#1558)
mikepitre Sep 24, 2024
57d1519
docs: update Spotify social connection guide (#1559)
kduprey Sep 24, 2024
d755146
Add info about how to access SessionWithActivities object (#1543)
alexisintech Sep 26, 2024
b48ecb1
Adding Community SolidJS SDK to docs (#1563)
JacobMGEvans Sep 26, 2024
a388961
docs(astro): Add custom menu items examples for Astro (#1519)
wobsoriano Sep 26, 2024
a48e39c
docs(astro): Update unstyled components custom usage (#1556)
wobsoriano Sep 26, 2024
cce04fb
Update shadcn-ui.mdx (#1561)
NatGlass Sep 26, 2024
ba2c35f
add note about unlimited memberships (#1568)
victoriaxyz Sep 27, 2024
f7ee192
remove return from middleware and fix syntax highlighting (#1566)
victoriaxyz Sep 27, 2024
55ab3d8
Clarifying which string is a placeholder in our file upload examples …
izaaklauer Sep 27, 2024
83afe12
Documenting that `uploaderUserId` is optional when uploading organiza…
izaaklauer Sep 27, 2024
3c34ad2
update fastify doc and quickstart (#1555)
victoriaxyz Sep 27, 2024
3b7982a
Add pages related to Sign-up mode Restricted (#1562)
kostaspt Sep 27, 2024
875c283
Custom flows audit (#1544)
alexisintech Sep 27, 2024
634621e
update variable names (#1567)
victoriaxyz Sep 27, 2024
6709d63
Update sync-data.mdx (#1564)
LoicCol Sep 27, 2024
e56dcd3
Introduce Coinbase Wallet web3 provider and authentication strategy (…
chanioxaris Sep 30, 2024
f69cf41
Add documentation for Playwright helpers (#1529)
anagstef Sep 30, 2024
efcbd36
man -> meddler (#1573)
jescalan Sep 30, 2024
9c6e85e
Add Python to docs (#1565)
alexisintech Sep 30, 2024
9e426c2
Add Clerk Express SDK docs (#1201)
EmmanouelaPothitou Sep 30, 2024
c67ec0f
Express SDK docs followup review (#1579)
alexisintech Sep 30, 2024
2ea53a4
Introduce new Web3 authentication section and Coinbase Wallet page (#…
chanioxaris Oct 1, 2024
6cb0fe0
fix clerkstage.dev link in restrictions.mdx (#1580)
astrotars Oct 1, 2024
39c4cf7
add example sections to /sign-up/sign-up and /sign-in/sign-in (#1572)
alexisintech Oct 1, 2024
3880bee
(/playwright) Fix copy errors (#1581)
alexisintech Oct 1, 2024
2fbcf3c
Add new default role setting docs (#1584)
mzhong9723 Oct 1, 2024
eb07fd7
(/authentication-flows) Fix broken link (#1583)
alexisintech Oct 2, 2024
12bf683
PR-1584 followup review from docs team (#1586)
alexisintech Oct 2, 2024
053c24d
Added Finnish language to the supported languages list. (#1585)
theisoj Oct 2, 2024
f9c2aca
(/basic-rbac) add middleware, reorg and refactor copy (#1560)
victoriaxyz Oct 3, 2024
d9e7766
(/quickstarts/javascript) fix spelling (#1593)
victoriaxyz Oct 3, 2024
d970449
(/localization) Add JS example; update list of supported locales (#1587)
alexisintech Oct 3, 2024
8b868a1
Update 'Delete MFA' > 'Reset MFA' (#1592)
alexisintech Oct 3, 2024
97658b0
update navigation instructions for new sso connections page in clerk …
alexisintech Oct 3, 2024
994066d
docs(express): Start de-emphasizing usage of `getAuth` (#1595)
wobsoriano Oct 3, 2024
996e861
Clarify usage of system permissions on the server-side (#1594)
LauraBeatris Oct 3, 2024
b8ee697
(/deploy-to-vercel) Add section about deploying a Vercel app to produ…
alexisintech Oct 4, 2024
27620b9
(chore) server side --> server-side; client side --> client-side (#1597)
alexisintech Oct 4, 2024
ba6ce6e
Align SSO connection pages with Dashboard terminology (#1596)
alexisintech Oct 4, 2024
3ae5a8e
Update Microsoft OAuth guide; align copy about development vs product…
alexisintech Oct 4, 2024
d6b95df
`.dev` → `.com` (#1605)
skullface Oct 7, 2024
9619163
Update localizations docs (#1604)
NikitaRadzkov Oct 7, 2024
1b6eeaa
update quickstart
royanger Sep 18, 2024
30c6640
Updated quickstart based on SDK changes and to improve experience
royanger Oct 8, 2024
184bee0
Converted syncSessionWithTab to Sync Host, other updates, stub for cr…
royanger Oct 8, 2024
bbdfd62
Added page for createClerkClient
royanger Oct 8, 2024
8d646a8
Updates to the Chrome Extension deployment guide
royanger Oct 8, 2024
43e2a8e
Minor typo and grammar fix
royanger Oct 10, 2024
8f832b9
Swap from PLASMO_PUBLIC_CLERK_SYNC_HOST to PLASMOST_PUBLIC_SYNC_HOST …
royanger Oct 10, 2024
4ad9621
Moved __unstable_createClerkClient to createClerkClient
royanger Oct 10, 2024
8cbf1dd
added clarifying comment
royanger Oct 10, 2024
1e8580b
Merge branch 'main' into roy/add-chrome-extension-docs
alexisintech Oct 11, 2024
ff92b58
Docs review
alexisintech Oct 17, 2024
ad02c0e
Merge branch 'main' into roy/add-chrome-extension-docs
alexisintech Oct 17, 2024
cca64a3
Update docs/deployments/deploy-chrome-extension.mdx
royanger Oct 21, 2024
da4d634
Update docs/quickstarts/chrome-extension.mdx
royanger Oct 21, 2024
4a7832b
Update docs/references/chrome-extension/configure-consistent-crx-id.mdx
royanger Oct 21, 2024
dba549a
Update docs/references/chrome-extension/add-react-router.mdx
royanger Oct 21, 2024
f271e01
Apply suggestions from code review
royanger Oct 21, 2024
7cdb2cf
Update link in sync-host.mdx
royanger Oct 22, 2024
abad693
Update link in sync-host.mdx
royanger Oct 22, 2024
6fc9ec8
Update docs/references/chrome-extension/configure-consistent-crx-id.mdx
royanger Oct 23, 2024
76205d3
Apply suggestions from code review
royanger Oct 23, 2024
b089102
apply suggestions from code review
alexisintech Oct 23, 2024
9a399f7
Update docs/references/chrome-extension/create-clerk-client.mdx
alexisintech Oct 24, 2024
1481f89
Update docs/references/chrome-extension/create-clerk-client.mdx
alexisintech Oct 24, 2024
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
4 changes: 3 additions & 1 deletion docs/components/clerk-provider.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -102,14 +102,16 @@ The `<ClerkProvider>` component must be added to your React entrypoint.
| `signInForceRedirectUrl?` | `string` | If provided, this URL will always be redirected to after the user signs in. It's recommended to use [the environment variable](/docs/deployments/clerk-environment-variables#sign-in-and-sign-up-redirects) instead. |
| `signUpForceRedirectUrl?` | `string` | If provided, this URL will always be redirected to after the user signs up. It's recommended to use [the environment variable](/docs/deployments/clerk-environment-variables#sign-in-and-sign-up-redirects) instead. |
| `signInFallbackRedirectUrl?` | `string` | The fallback URL to redirect to after the user signs in, if there's no `redirect_url` in the path already. Defaults to `/`. It's recommended to use [the environment variable](/docs/deployments/clerk-environment-variables#sign-in-and-sign-up-redirects) instead. |
| `signUpFallbackRedirectUrl?` | `string` | The fallback URL to redirect to after the user signs up, if there's no `redirect_url` in the path already. Defaults to `/`. It's recommended to use [the environment variable](/docs/deployments/clerk-environment-variables#sign-in-and-sign-up-redirects) instead. |
| `signUpFallbackRedirectUrl?` | `string` | The fallback URL to redirect to after the user signs up, if there's no `redirect_url` in the path already. Defaults to `/`. It's recommended to use [the environment variable](/docs/deployments/clerk-environment-variables#sign-in-and-sign-up-redirects) instead. |

| `isSatellite?` | `boolean \| ((url: URL) => boolean)` | This option defines that the application is a satellite application. |

| `domain?` | `string \| ((url: URL) => boolean)` | This option sets the domain of the satellite application. If your application is a satellite application, this option is required. |
| `signInUrl` | `string` | This URL will be used for any redirects that might happen and needs to point to your primary application. This option is optional for production instances and required for development instances. It's recommended to use [the environment variable](/docs/deployments/clerk-environment-variables#sign-in-and-sign-up-redirects) instead. |

| `telemetry?` | `false \| { disabled?: boolean; debug?: boolean } \| undefined` | Controls whether or not Clerk will collect [telemetry data](/docs/telemetry). |

| `syncSessionWithTab` | `boolean` | **Chrome Extension only** This enables syncing the authenication state from the web application to the Chrome Extension. See [`syncSessionWithTab`](/docs/references/chrome-extension/syncsessionwithtab-configuration) |
royanger marked this conversation as resolved.
Show resolved Hide resolved

[components-ref]: /docs/components/overview
[ap-ref]: /docs/account-portal/overview
31 changes: 31 additions & 0 deletions docs/deployments/deploy-chrome-extension.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: Deploy a Chrome Extension
description: Learning how to deploay a Chrome Extension with Clerk
royanger marked this conversation as resolved.
Show resolved Hide resolved
---

# Deploay a Chrome Extension
royanger marked this conversation as resolved.
Show resolved Hide resolved


## Add prorduction domain to `host_permissions`
royanger marked this conversation as resolved.
Show resolved Hide resolved
royanger marked this conversation as resolved.
Show resolved Hide resolved

// update the manifest.json with the production domain instead of `http://localhost` in `host_permissions`

## Create a Production instance

// whether there is a web app or not, a domain will be required
// follow /docs/deployments/overview#create-your-production-instance

## Add domain or domains to `allowed_origins`

// use production secret key, and add each domain to `host_permissions` array

```bash
curl -X PATCH https://api.clerk.com/v1/instance \
-H "Authorization: Bearer <SECRET KEY>" \
-H "Content-type: application/json" \
-d '{"allowed_origins": ["chrome-extension://<CHROME EXTENSION KEY>"]}'
```

## Submit extension for review

// update keys, create new zip of `dist/` folder and submit for review in Chrome Developer Dashboard
Loading