The minimalistic document archiving platform.
import type { ConfigDefinition } from 'figue';
import * as v from 'valibot';
import { booleanishSchema, urlSchema } from '../../config/config.schemas';
import { domainListSchema } from './auth.config.schemas';
import { DEFAULT_AUTH_SECRET } from './auth.constants';
const customOAuthProviderSchema = v.object({
providerId: v.string(),
providerName: v.string(),
providerIconUrl: v.optional(urlSchema),
clientId: v.string(),
clientSecret: v.string(),
scopes: v.optional(v.array(v.string())),
redirectURI: v.optional(v.string()),
tokenUrl: v.optional(v.string()),
userInfoUrl: v.optional(v.string()),
responseType: v.optional(v.string()),
prompt: v.optional(v.picklist(['select_account', 'consent', 'login', 'none'])),
pkce: v.optional(v.boolean()),
accessType: v.optional(v.string()),
discoveryUrl: v.optional(v.string()),
type: v.optional(v.picklist(['oauth2', 'oidc'])),
authorizationUrl: v.optional(v.string()),
});
export const authConfig = {
secret: {
doc: 'The secret for the auth, it should be at least 32 characters long, you can generate a secure one using `openssl rand -hex 48`',
schema: v.pipe(
v.string(
'Please provide an auth secret using the AUTH_SECRET environment variable, you can use `openssl rand -hex 48` to generate a secure one',
),
v.minLength(32),
),
default: DEFAULT_AUTH_SECRET,
env: 'AUTH_SECRET',
},
isRegistrationEnabled: {
doc: 'Whether registration is enabled',
schema: booleanishSchema,
default: true,
env: 'AUTH_IS_REGISTRATION_ENABLED',
},
isPasswordResetEnabled: {
doc: 'Whether password reset is enabled',
schema: booleanishSchema,
default: true,
env: 'AUTH_IS_PASSWORD_RESET_ENABLED',
},
isEmailVerificationRequired: {
doc: 'Whether email verification is required',
schema: booleanishSchema,
default: false,
env: 'AUTH_IS_EMAIL_VERIFICATION_REQUIRED',
},
showLegalLinksOnAuthPage: {
doc: 'Whether to show Papra legal links on the auth pages (terms of service, privacy policy), useless for self-hosted instances',
schema: booleanishSchema,
default: false,
env: 'AUTH_SHOW_LEGAL_LINKS',
},
firstUserAsAdmin: {
doc: 'Automatically assign the admin role to the first user who registers. This is useful for initial setup of self-hosted instances where you need an admin account to manage the platform.',
schema: booleanishSchema,
default: true,
env: 'AUTH_FIRST_USER_AS_ADMIN',
},
ipAddressHeaders: {
doc: `The header, or comma separated list of headers, to use to get the real IP address of the user, use for rate limiting. Make sur to use a non-spoofable header, one set by your proxy.
- If behind a standard proxy, you might want to set this to "x-forwarded-for".
- If behind Cloudflare, you might want to set this to "cf-connecting-ip".`,
schema: v.union([
v.pipe(
v.string(),
v.transform((value) => value.split(',').map((v) => v.trim())),
),
v.array(v.string()),
]),
default: ['x-forwarded-for'],
env: 'AUTH_IP_ADDRESS_HEADERS',
},
allowedEmailDomains: {
doc: 'A comma separated list of email domains allowed for registration (e.g. "foo.com,bar.com"). When empty, no allowlist restriction is applied. Domains are matched exactly and case-insensitively. Forbidden domains take precedence over this list.',
schema: domainListSchema,
default: [],
env: 'AUTH_ALLOWED_EMAIL_DOMAINS',
},
forbiddenEmailDomains: {
doc: 'A comma separated list of email domains that are forbidden for registration (e.g. "foo.com,bar.com"), if set, it will override the default forbidden domains.',
schema: domainListSchema,
default: ['papra.app', 'papra.email', 'owlrelay.email', 'callback.email', 'clb.email'],
env: 'AUTH_FORBIDDEN_EMAIL_DOMAINS',
},
providers: {
email: {
isEnabled: {
doc: 'Whether email/password authentication is enabled',
schema: booleanishSchema,
default: true,
env: 'AUTH_PROVIDERS_EMAIL_IS_ENABLED',
},
},
github: {
isEnabled: {
doc: 'Whether Github OAuth is enabled',
schema: booleanishSchema,
default: false,
env: 'AUTH_PROVIDERS_GITHUB_IS_ENABLED',
},
clientId: {
doc: 'The client id for Github OAuth',
schema: v.string(),
default: 'set-me',
env: 'AUTH_PROVIDERS_GITHUB_CLIENT_ID',
},
clientSecret: {
doc: 'The client secret for Github OAuth',
schema: v.string(),
default: 'set-me',
env: 'AUTH_PROVIDERS_GITHUB_CLIENT_SECRET',
},
},
google: {
isEnabled: {
doc: 'Whether Google OAuth is enabled',
schema: booleanishSchema,
default: false,
env: 'AUTH_PROVIDERS_GOOGLE_IS_ENABLED',
},
clientId: {
doc: 'The client id for Google OAuth',
schema: v.string(),
default: 'set-me',
env: 'AUTH_PROVIDERS_GOOGLE_CLIENT_ID',
},
clientSecret: {
doc: 'The client secret for Google OAuth',
schema: v.string(),
default: 'set-me',
env: 'AUTH_PROVIDERS_GOOGLE_CLIENT_SECRET',
},
},
customs: {
doc: 'The list of custom OAuth providers, as a JSON string, see https://www.better-auth.com/docs/plugins/generic-oauth#configuration for more details',
schema: v.union([
v.pipe(v.string(), v.parseJson(), v.array(customOAuthProviderSchema)),
v.array(customOAuthProviderSchema),
]),
default: [],
env: 'AUTH_PROVIDERS_CUSTOMS',
},
},
} as const satisfies ConfigDefinition;