You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/install.mdx
+9-7
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,9 @@ sidebar_position: 1
4
4
5
5
# Installation
6
6
7
-
There are two ways to consume the package: [premium](https://universal-sign-in.com) and free.
7
+
There are two ways to consume the package: [paid](https://universal-sign-in.com) and free.
8
+
9
+
Why paid? According to the [State of React Native Survey](https://results.2024.stateofreactnative.com/en-US/opinions/#opinions_pain_points_multiple), unmaintained packages are **the #1 pain point** of the React Native ecosystem. Your purchase enables the module reliability, and contributions to upstream SDKs such as [1](https://github.com/openid/AppAuth-iOS/pull/788), [2](https://github.com/google/GoogleSignIn-iOS/pull/402), [3](https://github.com/googlesamples/google-services/issues/426).
8
10
9
11
[//]: #'🌟'
10
12
@@ -19,7 +21,7 @@ There are two ways to consume the package: [premium](https://universal-sign-in.c
19
21
- iOS & macOS: Powered by the [Google Sign-In SDK](https://developers.google.com/identity/sign-in/ios/start)
20
22
21
23
-**Licensed:** see [pricing](https://universal-sign-in.com/#pricing) and [license](https://universal-sign-in.com/license).
22
-
-**Trusted**: A total of over 160k npm package downloads.
24
+
-**Trusted**: A total of over 170k npm package downloads.
23
25
-**Faster Sign-Ups**: Reduce sign-up and sign-in times on Android by up to 50%, according to [Google](https://developer.android.com/identity/sign-in/legacy-gsi-migration#authentication).
24
26
-**See the UI**: [screenshots](screenshots) of the features.
25
27
@@ -29,23 +31,23 @@ There are two ways to consume the package: [premium](https://universal-sign-in.c
📱 **An example app** - to showcase all Universal sign in features
33
-
34
-
_Your purchase enables improvements in the module and upstream SDKs (such as [1](https://github.com/openid/AppAuth-iOS/pull/788), [2](https://github.com/google/GoogleSignIn-iOS/pull/402), [3](https://github.com/googlesamples/google-services/issues/426))._
34
+
📱 **An example app** - to showcase all features on native and web
35
35
36
36
### Public version (free)
37
37
38
38
Available on the public npm registry under MIT license, this version:
39
39
40
-
- Uses the functional, but deprecated [legacy Android Google Sign-In](https://web.archive.org/web/20240308064911/https://developers.google.com/identity/sign-in/android/start-integrating) which will be removed from the Google Play Services Auth SDK (`com.google.android.gms:play-services-auth`) later in 2025. The free version will continue to use a version where the deprecated SDK is present.
40
+
- Uses the functional, but deprecated [legacy Android Google Sign-In](https://web.archive.org/web/20240308064911/https://developers.google.com/identity/sign-in/android/start-integrating) which will be removed from the Google Play Services Auth SDK (`com.google.android.gms:play-services-auth`) later in 2025. The free package will continue to use a version where the deprecated SDK is present.
41
41
- Has platform support limited to Android and iOS.
42
42
- Contains none of the extra features listed above.
43
43
44
44
> If you want to migrate from the public version to the Universal version, follow the [migration guide](migrating#migrating-from-original-to-universal-sign-in).
45
45
46
46
## Obtaining Universal Sign In {#obtaining-access}
47
47
48
-
Universal sign in requires [purchasing a license](https://universal-sign-in.com/#pricing), after which you will be able to configure your (or your colleagues') access to the private npm package and to the private repo with the sources and examples. Alternatively, as an Expo customer, obtain access through this [form](https://forms.gle/tpP7TfUGW1CwgaEZ8).
48
+
Universal sign in requires [purchasing a license](https://universal-sign-in.com/#pricing), after which you will be able to configure your (or your colleagues') access to the private npm package and to the private repo with the sources and examples.
49
+
50
+
> Are you an EAS customer? You may be able to access the premium version for free, [learn more](https://forms.gle/tpP7TfUGW1CwgaEZ8).
49
51
50
52
[//]: #'Note that this version is distributed under a [custom license](license).'
Copy file name to clipboardexpand all lines: docs/setting-up/get-config-file.mdx
+33-22
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,6 @@
1
1
---
2
2
sidebar_position: 15
3
+
sidebar_label: Configuration
3
4
---
4
5
5
6
# Obtaining configuration information
@@ -29,35 +30,43 @@ import Tabs from '@theme/Tabs';
29
30
importTabItemfrom'@theme/TabItem';
30
31
31
32
<Tabs>
32
-
<TabItemvalue="eas"label="When using Expo EAS">
33
-
If you use [Expo EAS](https://expo.dev/eas), run `eas credentials` to obtain the Keystore information, which includes the SHA-1 fingerprint. See [EAS credentials docs](https://docs.expo.dev/app-signing/managed-credentials/#inspecting-credentials-configuration) to learn more.
1. From your project root, `cd android && ./gradlew signingReport`.
37
-
2. Scroll to the top of output, see the fingerprints. Debug fingerprint is used for debug apk,
38
-
release fingerprint is used for release APK.
39
-
</TabItem>
40
-
41
33
<TabItemvalue="playStore"label="When releasing via Google Play Store">
42
-
Check if "Google Play App Signing" is enabled for your app [in the console](https://play.google.com/console/u/0/).
34
+
Check if "Google Play App Signing" is enabled for your app [in the console](https://play.google.com/console/).
43
35
If it is enabled, you need to take the following steps:
44
36
45
-
1. In Google Play Console, navigate to: \<Your App\> -> Release section (in the left sidebar) -> Setup -> App Signing.
46
-
2. Under the "App signing key certificate" _and also_ "Upload key certificate", take note of `SHA-1 certificate fingerprint`. That's a total of two or more fingerprints (Play Store sometimes has more than one "App signing key certificate"!).
37
+
1. In Google Play Console, navigate to: \<Your App\> -> Release section (in the left sidebar) -> Setup -> App Signing.
38
+
2. Under the "App signing key certificate" _and also_ "Upload key certificate", take note of `SHA-1 certificate fingerprint`. That's a total of two or more fingerprints (Play Store sometimes has more than one "App signing key certificate"!).
47
39
48
40
</TabItem>
41
+
42
+
<TabItemvalue="eas"label="When using Expo EAS">
43
+
If you use [Expo EAS](https://expo.dev/eas), run `eas credentials` to obtain
44
+
the Keystore information, which includes the SHA-1 fingerprint. See [EAS
1. From your project root, `cd android && ./gradlew signingReport`.
52
+
2. Scroll to the top of output, see the fingerprints. Debug fingerprint is used for debug apk,
53
+
release fingerprint is used for release APK.
54
+
</TabItem>
49
55
</Tabs>
50
56
57
+
<br />
58
+
<br />
59
+
51
60
### Step 2: Add SHA-1 hashes to Firebase or Google Cloud Console {#step-2}
52
61
53
62
Using _all_ of the SHA-1 fingerprints obtained in the previous step, follow the instructions below.
54
63
55
64
<TabsqueryString="firebase-or-not">
56
65
<TabItemvalue="firebase"label="When using Firebase">
57
-
1. Sign in to Firebase and open your project.
66
+
1. Sign in to [Firebase Console](https://console.firebase.google.com/) and open your project.
58
67
2. Ensure that in the "Authentication" menu, "Google" is enabled as "Sign-in method".
59
-
3. Click the Settings icon and select Project settings.
60
-
4.In the "Your apps" card, select the app you need to add SHA-1 to.
68
+
3. Click the settings icon and go to "Project settings".
69
+
4.Scroll down to "Your apps" section, and select the app.
61
70
5. Click "Add fingerprint".
62
71
6. Check that "Package name" is correct.
63
72
7. Download the `google-services.json` file.
@@ -67,8 +76,9 @@ Using _all_ of the SHA-1 fingerprints obtained in the previous step, follow the
67
76
</TabItem>
68
77
69
78
<TabItemvalue="cloud-console"label="When not using Firebase">
70
-
Follow the "Create authorization credentials" instructions
71
-
[here](https://developers.google.com/identity/protocols/oauth2/native-app#android) to create an "OAuth client ID" of type Android for each of the SHA-1 fingerprints you obtained - see the screenshot below.
79
+
Create an OAuth Client ID of type Android in [Google Cloud Console](https://console.cloud.google.com/apis/credentials?project=_) for each of the SHA-1 fingerprints you obtained - see the screenshot below.
80
+
81
+
Alternatively, use <ahref="https://console.developers.google.com/henhouse/?pb=%5B%22hh-0%22%2Cnull%2Cnull%2Cnull%2C%22https%3A%2F%2Fdevelopers.google.com%22%2Cnull%2Cnull%2Cnull%2C%22Configure%20a%20project%20for%20Google%20Sign-In%22%2C1%2Cnull%2Cnull%2C0%2C1%2Cnull%2Cnull%2Cnull%2Cnull%2C0%2Cnull%2Cnull%2C0%2Cnull%2Cnull%2Cnull%2Cnull%2Cnull%2Cnull%2C0%2Cnull%2Cnull%2Cnull%2C0%5D"target="_blank">this wizard</a>.
72
82
73
83
You will _NOT_ need the created IDs later - the only goal here is for them to be created in the Google Cloud Console.
74
84
@@ -88,18 +98,19 @@ Read below on how to set up Google Sign In for your iOS app.
88
98
<TabItemvalue="firebase"label="When using Firebase">
89
99
90
100
1. Sign in to [Firebase Console](https://console.firebase.google.com/) and open your project.
91
-
2. Click the settings icon and go to "Project settings".
92
-
3. Scroll down to "Your apps" section, and select the app.
93
-
4. Check that "Bundle ID" is correct.
94
-
5. Download the `GoogleService-Info.plist` file.
101
+
2. Ensure that in the "Authentication" menu, "Google" is enabled as "Sign-in method".
102
+
3. Click the settings icon and go to "Project settings".
103
+
4. Scroll down to "Your apps" section, and select the app.
104
+
5. Check that "Bundle ID" is correct.
105
+
6. Download the `GoogleService-Info.plist` file.
95
106
96
107
</TabItem>
97
108
98
109
<TabItemvalue="cloud-console"label="When not using Firebase">
99
110
100
111
Remember that _all_ created client IDs can be found in the [Google Cloud Console](https://console.cloud.google.com/apis/credentials?project=_).
101
112
102
-
Obtain the "iOS OAuth Client ID" _and_ "iOS URL scheme" (also known as `reversed client id`): Create or use an existing OAuth Client ID of type iOS in [Google Cloud Console](https://console.cloud.google.com/apis/credentials?project=_). Alternatively, use <ahref="https://console.developers.google.com/henhouse/?pb=%5B%22hh-0%22%2Cnull%2Cnull%2Cnull%2C%22https%3A%2F%2Fdevelopers.google.com%22%2Cnull%2Cnull%2Cnull%2C%22Configure%20a%20project%20for%20Google%20Sign-In%22%2C1%2Cnull%2Cnull%2C0%2C1%2Cnull%2Cnull%2Cnull%2Cnull%2C0%2Cnull%2Cnull%2C0%2Cnull%2Cnull%2Cnull%2Cnull%2Cnull%2Cnull%2C0%2Cnull%2Cnull%2Cnull%2C0%5D"target="_blank">this wizard</a>.
113
+
Obtain the "iOS OAuth Client ID" _and_ "iOS URL scheme" (also known as `reversed client id`): Create an OAuth Client ID of type iOS in [Google Cloud Console](https://console.cloud.google.com/apis/credentials?project=_). Alternatively, use <ahref="https://console.developers.google.com/henhouse/?pb=%5B%22hh-0%22%2Cnull%2Cnull%2Cnull%2C%22https%3A%2F%2Fdevelopers.google.com%22%2Cnull%2Cnull%2Cnull%2C%22Configure%20a%20project%20for%20Google%20Sign-In%22%2C1%2Cnull%2Cnull%2C0%2C1%2Cnull%2Cnull%2Cnull%2Cnull%2C0%2Cnull%2Cnull%2C0%2Cnull%2Cnull%2Cnull%2Cnull%2Cnull%2Cnull%2C0%2Cnull%2Cnull%2Cnull%2C0%5D"target="_blank">this wizard</a>.
103
114
104
115
You will need the iOS Client ID and iOS URL scheme later.
0 commit comments