docs: add social login images and update documentation (#7314)

Co-authored-by: Víctor Fernández Poyatos <victor@prowler.com>
This commit is contained in:
Pablo Lara
2025-03-19 12:31:37 +01:00
committed by Pepe Fagoaga
parent e757bde7ca
commit 747d62393e
5 changed files with 84 additions and 19 deletions
Binary file not shown.

After

Width:  |  Height:  |  Size: 234 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 235 KiB

@@ -0,0 +1,52 @@
# Social Login Configuration
The **Prowler App** supports social login using Google and GitHub OAuth providers. This document guides you through configuring the required environment variables to enable social authentication.
<img src="../img/social-login/social_login_buttons.png" alt="Social login buttons" width="700" />
## Configuring Social Login Credentials
To enable social login with Google and GitHub, you must define the following environment variables:
### Google OAuth Configuration
Set the following environment variables for Google OAuth:
```env
SOCIAL_GOOGLE_OAUTH_CLIENT_ID=""
SOCIAL_GOOGLE_OAUTH_CLIENT_SECRET=""
```
### GitHub OAuth Configuration
Set the following environment variables for GitHub OAuth:
```env
SOCIAL_GITHUB_OAUTH_CLIENT_ID=""
SOCIAL_GITHUB_OAUTH_CLIENT_SECRET=""
```
### Important Notes
- If either `SOCIAL_GOOGLE_OAUTH_CLIENT_ID` or `SOCIAL_GOOGLE_OAUTH_CLIENT_SECRET` is empty or not defined, the Google login button will be disabled.
- If either `SOCIAL_GITHUB_OAUTH_CLIENT_ID` or `SOCIAL_GITHUB_OAUTH_CLIENT_SECRET` is empty or not defined, the GitHub login button will be disabled.
<img src="../img/social-login/social_login_buttons_disabled.png" alt="Social login buttons disabled" width="700" />
## Obtaining OAuth Credentials
To obtain `CLIENT_ID` and `CLIENT_SECRET` for each provider, follow their official documentation:
- **Google OAuth**: [Google OAuth Credentials Setup](https://developers.google.com/identity/protocols/oauth2)
- **GitHub OAuth**: [GitHub OAuth App Setup](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app)
### Steps Overview
For both providers, the process generally involves:
1. Registering your application in the provider's developer portal.
2. Defining the authorized redirect URL (`SOCIAL_<PROVIDER>_OAUTH_CALLBACK_URL`).
3. Copying the generated `CLIENT_ID` and `CLIENT_SECRET` into the corresponding environment variables.
Once completed, ensure your environment variables are correctly loaded in your Prowler deployment to activate social login.
+12
View File
@@ -9,11 +9,23 @@ You can also access to the auto-generated **Prowler API** documentation at [http
If you are a [Prowler Cloud](https://cloud.prowler.com/sign-in) user you can see API docs at [https://api.prowler.com/api/v1/docs](https://api.prowler.com/api/v1/docs)
## **Step 1: Sign Up**
### **Sign up with Email**
To get started, sign up using your email and password:
<img src="../../img/sign-up-button.png" alt="Sign Up Button" width="320"/>
<img src="../../img/sign-up.png" alt="Sign Up" width="285"/>
### **Sign up with Social Login**
If Social Login is enabled, you can sign up using your preferred provider (e.g., Google, GitHub).
???+ note "How Social Login Works"
- If your email is already registered, you will be logged in, and your social account will be linked.
- If your email is not registered, a new account will be created using your social account email.
???+ note "Enable Social Login"
See [how to configure Social Login for Prowler](prowler-app-social-login.md) to enable this feature in your own deployments.
---
## **Step 2: Log In**