Skip to content

armgit / papra

Public Imported from GitHub
0

The minimalistic document archiving platform.

feat(auth): add Google as an SSO provider (#85)

Corentin THOMASSETcd5b609427ce
diff --git a/apps/papra-client/src/modules/auth/auth.constants.ts b/apps/papra-client/src/modules/auth/auth.constants.ts
index b4fd5fba..ad214de9 100644
--- a/apps/papra-client/src/modules/auth/auth.constants.ts
+++ b/apps/papra-client/src/modules/auth/auth.constants.ts
@@ -1,4 +1,9 @@
export const ssoProviders = [
+ {
+ key: 'google',
+ name: 'Google',
+ icon: 'i-tabler-brand-google-filled',
+ },
{
key: 'github',
name: 'GitHub',
diff --git a/apps/papra-client/src/modules/auth/auth.types.ts b/apps/papra-client/src/modules/auth/auth.types.ts
index 9015545e..0d6e6c82 100644
--- a/apps/papra-client/src/modules/auth/auth.types.ts
+++ b/apps/papra-client/src/modules/auth/auth.types.ts
@@ -1,2 +1,3 @@
-// "github" | "apple" | "discord" | "facebook" | "microsoft" | "google" | "spotify" | "twitch" | "twitter" | "dropbox" | "linkedin" | "gitlab" | "reddit"
-export type SsoProviderKey = 'github';
+import type { ssoProviders } from './auth.constants';
+
+export type SsoProviderKey = (typeof ssoProviders)[number]['key'];
diff --git a/apps/papra-client/src/modules/auth/pages/login.page.tsx b/apps/papra-client/src/modules/auth/pages/login.page.tsx
index c9c0fd06..794b3e03 100644
--- a/apps/papra-client/src/modules/auth/pages/login.page.tsx
+++ b/apps/papra-client/src/modules/auth/pages/login.page.tsx
@@ -127,11 +127,13 @@ export const LoginPage: Component = () => {
<Separator class="my-4" />
- <For each={getEnabledSsoProviderConfigs({ config })}>
- {provider => (
- <SsoProviderButton name={provider.name} icon={provider.icon} onClick={() => loginWithProvider(provider)} label={`Login with ${provider.name}`} />
- )}
- </For>
+ <div class="flex flex-col gap-2">
+ <For each={getEnabledSsoProviderConfigs({ config })}>
+ {provider => (
+ <SsoProviderButton name={provider.name} icon={provider.icon} onClick={() => loginWithProvider(provider)} label={`Login with ${provider.name}`} />
+ )}
+ </For>
+ </div>
<p class="text-muted-foreground mt-4">
Don't have an account?
diff --git a/apps/papra-client/src/modules/auth/pages/register.page.tsx b/apps/papra-client/src/modules/auth/pages/register.page.tsx
index 39f23a01..b261b5d1 100644
--- a/apps/papra-client/src/modules/auth/pages/register.page.tsx
+++ b/apps/papra-client/src/modules/auth/pages/register.page.tsx
@@ -155,11 +155,13 @@ export const RegisterPage: Component = () => {
<Separator class="my-4" />
- <For each={ssoProviders}>
- {provider => (
- <SsoProviderButton name={provider.name} icon={provider.icon} onClick={() => loginWithProvider(provider)} label={`Register with ${provider.name}`} />
- )}
- </For>
+ <div class="flex flex-col gap-2">
+ <For each={ssoProviders}>
+ {provider => (
+ <SsoProviderButton name={provider.name} icon={provider.icon} onClick={() => loginWithProvider(provider)} label={`Register with ${provider.name}`} />
+ )}
+ </For>
+ </div>
<p class="text-muted-foreground mt-4">
Already have an account?
diff --git a/apps/papra-client/src/modules/config/config.ts b/apps/papra-client/src/modules/config/config.ts
index 0e2baa3e..43059253 100644
--- a/apps/papra-client/src/modules/config/config.ts
+++ b/apps/papra-client/src/modules/config/config.ts
@@ -10,7 +10,10 @@ export const buildTimeConfig = {
isEmailVerificationRequired: import.meta.env.VITE_AUTH_IS_EMAIL_VERIFICATION_REQUIRED !== 'false',
providers: {
github: {
- isEnabled: import.meta.env.VITE_AUTH_PROVIDERS_GITHUB_IS_ENABLED !== 'false',
+ isEnabled: import.meta.env.VITE_AUTH_PROVIDERS_GITHUB_IS_ENABLED === 'true',
+ },
+ google: {
+ isEnabled: import.meta.env.VITE_AUTH_PROVIDERS_GOOGLE_IS_ENABLED === 'true',
},
},
},
diff --git a/apps/papra-client/uno.config.ts b/apps/papra-client/uno.config.ts
index b914d957..22f26f66 100644
--- a/apps/papra-client/uno.config.ts
+++ b/apps/papra-client/uno.config.ts
@@ -1,3 +1,4 @@
+import { ssoProviders } from '@/modules/auth/auth.constants';
import { iconByFileType } from '@/modules/documents/document.models';
import { uniq, values } from 'lodash-es';
import {
@@ -113,5 +114,6 @@ export default defineConfig({
},
safelist: [
...uniq(values(iconByFileType)),
+ ...(ssoProviders.map(p => p.icon)),
],
});
diff --git a/apps/papra-server/src/modules/app/auth/auth.config.ts b/apps/papra-server/src/modules/app/auth/auth.config.ts
index 3f094306..14b2535c 100644
--- a/apps/papra-server/src/modules/app/auth/auth.config.ts
+++ b/apps/papra-server/src/modules/app/auth/auth.config.ts
@@ -51,7 +51,7 @@ export const authConfig = {
.toLowerCase()
.transform(x => x === 'true')
.pipe(z.boolean()),
- default: 'true',
+ default: 'false',
env: 'AUTH_PROVIDERS_GITHUB_IS_ENABLED',
},
clientId: {
@@ -67,5 +67,31 @@ export const authConfig = {
env: 'AUTH_PROVIDERS_GITHUB_CLIENT_SECRET',
},
},
+ google: {
+ isEnabled: {
+ doc: 'Whether Google OAuth is enabled',
+ schema: z
+ .string()
+ .trim()
+ .toLowerCase()
+ .transform(x => x === 'true')
+ .pipe(z.boolean()),
+ default: 'false',
+ env: 'AUTH_PROVIDERS_GOOGLE_IS_ENABLED',
+ },
+ clientId: {
+ doc: 'The client id for Google OAuth',
+ schema: z.string(),
+ default: 'set-me',
+ env: 'AUTH_PROVIDERS_GOOGLE_CLIENT_ID',
+ },
+ clientSecret: {
+ doc: 'The client secret for Google OAuth',
+ schema: z.string(),
+ default: 'set-me',
+ env: 'AUTH_PROVIDERS_GOOGLE_CLIENT_SECRET',
+ },
+ },
+
},
} as const satisfies ConfigDefinition;
diff --git a/apps/papra-server/src/modules/app/auth/auth.services.ts b/apps/papra-server/src/modules/app/auth/auth.services.ts
index 3171c47f..5ba24746 100644
--- a/apps/papra-server/src/modules/app/auth/auth.services.ts
+++ b/apps/papra-server/src/modules/app/auth/auth.services.ts
@@ -82,6 +82,11 @@ export function getAuth({ db, config }: { db: Database; config: Config }) {
clientId: config.auth.providers.github.clientId,
clientSecret: config.auth.providers.github.clientSecret,
},
+ google: {
+ enabled: config.auth.providers.google.isEnabled,
+ clientId: config.auth.providers.google.clientId,
+ clientSecret: config.auth.providers.google.clientSecret,
+ },
},
user: {
changeEmail: { enabled: false },