@samebase/identity-broker 0.9.1 → 0.9.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +6 -0
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -5,6 +5,8 @@ connections once, such as GitHub, Google and email codes, and signs users in to
5
5
  broker keeps no user accounts and no sessions: every sign-in goes upstream again, and each app
6
6
  creates its own user from the `id_token` it receives.
7
7
 
8
+ ![Google and GitHub refuse preview deployments because each has a new URL. Identity Broker sits in front of them, so each provider sees one client and one URL, and every app and preview registers its exact URL at deploy.](https://raw.githubusercontent.com/samebase/samebase/main/packages/identity-broker/docs/how-it-works.gif)
9
+
8
10
  Why: every new app otherwise needs its own OAuth app registrations and its own email sender, and a
9
11
  preview deployment with a fresh callback URL cannot have them at all. With the broker, an app
10
12
  registers each deployment as a client at deploy time and never touches GitHub or Google.
@@ -26,6 +28,10 @@ registers each deployment as a client at deploy time and never touches GitHub or
26
28
 
27
29
  ## Mount it
28
30
 
31
+ ```sh
32
+ npm install @samebase/identity-broker
33
+ ```
34
+
29
35
  ```ts
30
36
  // convex/convex.config.ts
31
37
  import { defineApp } from "convex/server";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@samebase/identity-broker",
3
- "version": "0.9.1",
3
+ "version": "0.9.2",
4
4
  "description": "An OpenID Provider for Convex that holds a team's upstream sign-in connections once and keeps no user accounts.",
5
5
  "license": "Apache-2.0",
6
6
  "repository": {