Ryan/documenso
1
0
Fork 1
mirror of https://github.com/documenso/documenso.git synced 2025-11-10 12:32:34 +10:00
Code Issues Packages Projects Releases Wiki Activity

chore: Update .env.example commenting (#1257)

Browse Source 
Adds documentation on how to setup Google for OAuth when self hosting Documenso.
This commit is contained in:
Jacob Flaherty
2024-08-07 16:58:27 -07:00
committed by GitHub
parent 909c38f47e
commit f74265850b
3 changed files with 34 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.env.example
View File

@ -10,6 +10,8 @@ NEXT_PRIVATE_ENCRYPTION_KEY="CAFEBABE"
NEXT_PRIVATE_ENCRYPTION_SECONDARY_KEY="DEADBEEF" NEXT_PRIVATE_ENCRYPTION_SECONDARY_KEY="DEADBEEF"
# [[AUTH OPTIONAL]] # [[AUTH OPTIONAL]]
# Find documentation on setting up Google OAuth here:
# https://docs.documenso.com/developers/self-hosting/setting-up-oauth-providers#google-oauth-gmail
NEXT_PRIVATE_GOOGLE_CLIENT_ID="" NEXT_PRIVATE_GOOGLE_CLIENT_ID=""
NEXT_PRIVATE_GOOGLE_CLIENT_SECRET="" NEXT_PRIVATE_GOOGLE_CLIENT_SECRET=""

3
apps/documentation/pages/developers/self-hosting/_meta.json
View File

@ -1,5 +1,6 @@
{ {
"index": "Getting Started", "index": "Getting Started",
"signing-certificate": "Signing Certificate", "signing-certificate": "Signing Certificate",
"how-to": "How To" "how-to": "How To",
"setting-up-oauth-providers": "Setting up OAuth Providers"
} }

29
apps/documentation/pages/developers/self-hosting/setting-up-oauth-providers.mdx Normal file
View File

@ -0,0 +1,29 @@
---
title: Setting up OAuth Providers
description: Learn how to set up OAuth providers for your own instance of Documenso.
---
## Google OAuth (Gmail)
To use Google OAuth, you will need to create a Google Cloud Platform project and enable the Google Identity and Access Management (IAM) API. You will also need to create a new OAuth client ID and download the client secret.
### Create and configure a new OAuth client ID
1. Go to the [Google Cloud Platform Console](https://console.cloud.google.com/)
2. From the projects list, select a project or create a new one
3. If the APIs & services page isn't already open, open the console left side menu and select APIs & services
4. On the left, click Credentials
5. Click New Credentials, then select OAuth client ID
6. When prompted to select an application type, select Web application
7. Enter a name for your client ID, and click Create
8. Click the download button to download the client secret
9. Set the authorized javascript origins to `https://<documenso-domain>`
10. Set the authorized redirect URIs to `https://<documenso-domain>/api/auth/callback/google`
11. In the Documenso environment variables, set the following:
```
NEXT_PRIVATE_GOOGLE_CLIENT_ID=<your-client-id>
NEXT_PRIVATE_GOOGLE_CLIENT_SECRET=<your-client-secret>
```
Finally verify the signing in with Google works by signing in with your Google account and checking the email address in your profile.