Skip to content

Rallly is an open-source scheduling and collaboration tool designed to make organizing events and meetings easier.

✨ Configure email auth by environment variables (#1916)

Emelia Smithf23f5f69aa54
diff --git a/apps/docs/self-hosting/configuration.mdx b/apps/docs/self-hosting/configuration.mdx
index 9d01651cb..67e19d31f 100644
--- a/apps/docs/self-hosting/configuration.mdx
+++ b/apps/docs/self-hosting/configuration.mdx
@@ -65,6 +65,18 @@ description: Using environment variable to configure a self-hosted instance of R
## Auth
+<ParamField path="EMAIL_LOGIN_ENABLED" default="true">
+ Set to "false" to disable email-based login (magic link authentication).
+ When disabled, users can only authenticate via configured OAuth providers
+ (Google, Microsoft, OIDC) and user registration is automatically disabled.
+</ParamField>
+
+<ParamField path="REGISTRATION_ENABLED" default="true">
+ Set to "false" to disable user registration globally. This environment variable
+ takes precedence over the database setting configured via the admin UI.
+ Registration requires email login to be enabled.
+</ParamField>
+
<ParamField path="ALLOWED_EMAILS">
Comma separated list of email addresses that are allowed to register and
login. Wildcard characters are supported. Example: Setting it to
diff --git a/apps/web/public/locales/en/app.json b/apps/web/public/locales/en/app.json
index 544fa9af1..d08bddd03 100644
--- a/apps/web/public/locales/en/app.json
+++ b/apps/web/public/locales/en/app.json
@@ -11,6 +11,7 @@
"changeNameInfo": "This will not affect any votes you have already made.",
"comments": "Comments",
"continue": "Continue",
+ "configuredByEnvironmentVariable": "This setting has been configured by environment variable.",
"copied": "Copied",
"createdBy": "by <b>{name}</b>",
"delete": "Delete",
@@ -37,6 +38,7 @@
"location": "Location",
"locationPlaceholder": "Joe's Coffee Shop",
"login": "Login",
+ "loginNotConfigured": "Login is currently not configured.",
"logout": "Logout",
"manage": "Manage",
"mixedOptionsDescription": "You can't have both time and date options in the same poll. Which would you like to keep?",
diff --git a/apps/web/src/app/[locale]/(auth)/login/page.tsx b/apps/web/src/app/[locale]/(auth)/login/page.tsx
index d04f98946..9ac740cb4 100644
--- a/apps/web/src/app/[locale]/(auth)/login/page.tsx
+++ b/apps/web/src/app/[locale]/(auth)/login/page.tsx
@@ -4,8 +4,9 @@ import { Trans } from "react-i18next/TransWithoutContext";
import { GoogleProvider } from "@/auth/providers/google";
import { MicrosoftProvider } from "@/auth/providers/microsoft";
import { OIDCProvider } from "@/auth/providers/oidc";
-import { getInstanceSettings } from "@/features/instance-settings/queries";
import { getTranslation } from "@/i18n/server";
+import { isFeatureEnabled } from "@/lib/feature-flags/server";
+import { getRegistrationEnabled } from "@/utils/get-registration-enabled";
import {
AuthPageContainer,
AuthPageContent,
@@ -22,13 +23,13 @@ import { OrDivider } from "./components/or-divider";
import { SSOProvider } from "./components/sso-provider";
async function loadData() {
- const [instanceSettings, { t }] = await Promise.all([
- getInstanceSettings(),
+ const [isRegistrationEnabled, { t }] = await Promise.all([
+ getRegistrationEnabled(),
getTranslation(),
]);
return {
- instanceSettings,
+ isRegistrationEnabled,
t,
};
}
@@ -40,7 +41,8 @@ export default async function LoginPage(props: {
}) {
const searchParams = await props.searchParams;
- const { instanceSettings, t } = await loadData();
+ const { isRegistrationEnabled, t } = await loadData();
+ const isEmailLoginEnabled = isFeatureEnabled("emailLogin");
const oidcProvider = OIDCProvider();
const socialProviders = [GoogleProvider(), MicrosoftProvider()].filter(
Boolean,
@@ -56,17 +58,26 @@ export default async function LoginPage(props: {
<Trans t={t} ns="app" i18nKey="loginTitle" defaults="Welcome" />
</AuthPageTitle>
<AuthPageDescription>
- <Trans
- t={t}
- ns="app"
- i18nKey="loginDescription"
- defaults="Login to your account to continue"
- />
+ {!isEmailLoginEnabled && !hasAlternateLoginMethods ? (
+ <Trans
+ t={t}
+ ns="app"
+ i18nKey="loginNotConfigured"
+ defaults="Login is currently not configured."
+ />
+ ) : (
+ <Trans
+ t={t}
+ ns="app"
+ i18nKey="loginDescription"
+ defaults="Login to your account to continue"
+ />
+ )}
</AuthPageDescription>
</AuthPageHeader>
<AuthPageContent>
- <LoginWithEmailForm />
- {hasAlternateLoginMethods ? <OrDivider /> : null}
+ {isEmailLoginEnabled && <LoginWithEmailForm />}
+ {isEmailLoginEnabled && hasAlternateLoginMethods ? <OrDivider /> : null}
{oidcProvider ? (
<LoginWithOIDC
name={oidcProvider.name}
@@ -89,7 +100,7 @@ export default async function LoginPage(props: {
) : null}
</AuthPageContent>
<AuthErrors />
- {!instanceSettings?.disableUserRegistration ? (
+ {isRegistrationEnabled ? (
<AuthPageExternal>
<Trans
t={t}
diff --git a/apps/web/src/app/[locale]/(auth)/register/page.tsx b/apps/web/src/app/[locale]/(auth)/register/page.tsx
index 4ab07b29b..f01db4c92 100644
--- a/apps/web/src/app/[locale]/(auth)/register/page.tsx
+++ b/apps/web/src/app/[locale]/(auth)/register/page.tsx
@@ -1,9 +1,8 @@
import type { Metadata } from "next";
import { notFound } from "next/navigation";
import { Trans } from "react-i18next/TransWithoutContext";
-
-import { getInstanceSettings } from "@/features/instance-settings/queries";
import { getTranslation } from "@/i18n/server";
+import { getRegistrationEnabled } from "@/utils/get-registration-enabled";
import {
AuthPageContainer,
AuthPageContent,
@@ -20,9 +19,9 @@ export default async function Register(props: {
}) {
const params = await props.params;
const { t } = await getTranslation(params.locale);
- const instanceSettings = await getInstanceSettings();
+ const isRegistrationEnabled = await getRegistrationEnabled();
- if (instanceSettings?.disableUserRegistration) {
+ if (!isRegistrationEnabled) {
return notFound();
}
diff --git a/apps/web/src/app/[locale]/(optional-space)/new/page.tsx b/apps/web/src/app/[locale]/(optional-space)/new/page.tsx
index 043b198d8..d3614530a 100644
--- a/apps/web/src/app/[locale]/(optional-space)/new/page.tsx
+++ b/apps/web/src/app/[locale]/(optional-space)/new/page.tsx
@@ -6,15 +6,15 @@ import { PollPageIcon } from "@/app/components/page-icons";
import { CreatePoll } from "@/components/create-poll";
import { Trans } from "@/components/trans";
import { UserDropdown } from "@/components/user-dropdown";
-import { getInstanceSettings } from "@/features/instance-settings/queries";
import { getTranslation } from "@/i18n/server";
import { getLoggedIn } from "@/next-auth";
+import { getRegistrationEnabled } from "@/utils/get-registration-enabled";
import { BackButton } from "./back-button";
export default async function Page() {
- const [isLoggedIn, instanceSettings] = await Promise.all([
+ const [isLoggedIn, isRegistrationEnabled] = await Promise.all([
getLoggedIn(),
- getInstanceSettings(),
+ getRegistrationEnabled(),
]);
return (
@@ -46,7 +46,7 @@ export default async function Page() {
<Trans i18nKey="login" defaults="Login" />
</Link>
</Button>
- {instanceSettings?.disableUserRegistration ? null : (
+ {isRegistrationEnabled ? (
<Button variant="primary" asChild>
<Link
href={`/register?redirectTo=${encodeURIComponent("/new")}`}
@@ -54,7 +54,7 @@ export default async function Page() {
<Trans i18nKey="signUp" defaults="Sign up" />
</Link>
</Button>
- )}
+ ) : null}
</div>
)}
</div>
diff --git a/apps/web/src/app/[locale]/control-panel/settings/instance-settings-form.tsx b/apps/web/src/app/[locale]/control-panel/settings/instance-settings-form.tsx
index 8f4d169aa..049e12fad 100644
--- a/apps/web/src/app/[locale]/control-panel/settings/instance-settings-form.tsx
+++ b/apps/web/src/app/[locale]/control-panel/settings/instance-settings-form.tsx
@@ -6,6 +6,7 @@ import {
ActionBarGroup,
ActionBarTitle,
} from "@rallly/ui/action-bar";
+import { Alert, AlertDescription } from "@rallly/ui/alert";
import { Button } from "@rallly/ui/button";
import {
Form,
@@ -17,6 +18,7 @@ import {
} from "@rallly/ui/form";
import { toast } from "@rallly/ui/sonner";
import { Switch } from "@rallly/ui/switch";
+import { ContainerIcon } from "lucide-react";
import { useForm } from "react-hook-form";
import {
SettingsGroup,
@@ -29,6 +31,7 @@ import { Trans } from "@/components/trans";
import type { InstanceSettings } from "@/features/instance-settings/schema";
import { instanceSettingsSchema } from "@/features/instance-settings/schema";
import { useTranslation } from "@/i18n/client";
+import { useFeatureFlag } from "@/lib/feature-flags/client";
import { useSafeAction } from "@/lib/safe-action/client";
import { updateInstanceSettingsAction } from "./actions";
@@ -37,8 +40,14 @@ export function InstanceSettingsForm({
}: {
defaultValue: InstanceSettings;
}) {
+ const isRegistrationEnabled = useFeatureFlag("registration");
+
const form = useForm<InstanceSettings>({
- defaultValues: defaultValue,
+ defaultValues: {
+ ...defaultValue,
+ disableUserRegistration:
+ !isRegistrationEnabled || Boolean(defaultValue.disableUserRegistration),
+ },
resolver: zodResolver(instanceSettingsSchema),
});
@@ -96,6 +105,7 @@ export function InstanceSettingsForm({
<Switch
onCheckedChange={field.onChange}
checked={field.value}
+ disabled={!isRegistrationEnabled}
/>
</FormControl>
<FormLabel>
@@ -114,6 +124,19 @@ export function InstanceSettingsForm({
</FormItem>
)}
/>
+ {!isRegistrationEnabled && (
+ <Alert variant="note" className="mt-4">
+ <ContainerIcon />
+ <AlertDescription>
+ <p>
+ <Trans
+ i18nKey="configuredByEnvironmentVariable"
+ defaults="This setting has been configured by environment variable."
+ />
+ </p>
+ </AlertDescription>
+ </Alert>
+ )}
</SettingsGroupContent>
</SettingsGroup>
<ActionBar open={form.formState.isDirty}>
diff --git a/apps/web/src/auth/providers/email.ts b/apps/web/src/auth/providers/email.ts
index a5df9e392..444a6dbdb 100644
--- a/apps/web/src/auth/providers/email.ts
+++ b/apps/web/src/auth/providers/email.ts
@@ -5,38 +5,44 @@ import NodemailerProvider from "next-auth/providers/nodemailer";
import { getEmailClient } from "@/utils/emails";
-export const EmailProvider = NodemailerProvider({
- server: "none", // This value is required even though we don't need it
- from: process.env.NOREPLY_EMAIL,
- id: "email",
- maxAge: 15 * 60,
- generateVerificationToken() {
- return generateOtp();
- },
- async sendVerificationRequest({ identifier: email, token, url }) {
- const user = await prisma.user.findUnique({
- where: {
- email,
- },
- select: {
- name: true,
- locale: true,
- },
- });
+export const EmailProvider = () => {
+ if (process.env.EMAIL_LOGIN_ENABLED === "false") {
+ return null;
+ }
- if (user) {
- await getEmailClient(user.locale ?? undefined).sendTemplate(
- "LoginEmail",
- {
- to: email,
- props: {
- magicLink: absoluteUrl("/auth/login", {
- magicLink: url,
- }),
- code: token,
- },
+ return NodemailerProvider({
+ server: "none", // This value is required even though we don't need it
+ from: process.env.NOREPLY_EMAIL,
+ id: "email",
+ maxAge: 15 * 60,
+ generateVerificationToken() {
+ return generateOtp();
+ },
+ async sendVerificationRequest({ identifier: email, token, url }) {
+ const user = await prisma.user.findUnique({
+ where: {
+ email,
+ },
+ select: {
+ name: true,
+ locale: true,
},
- );
- }
- },
-});
+ });
+
+ if (user) {
+ await getEmailClient(user.locale ?? undefined).sendTemplate(
+ "LoginEmail",
+ {
+ to: email,
+ props: {
+ magicLink: absoluteUrl("/auth/login", {
+ magicLink: url,
+ }),
+ code: token,
+ },
+ },
+ );
+ }
+ },
+ });
+};
diff --git a/apps/web/src/env.ts b/apps/web/src/env.ts
index 19694608e..862bd536d 100644
--- a/apps/web/src/env.ts
+++ b/apps/web/src/env.ts
@@ -50,6 +50,8 @@ export const env = createEnv({
* Example: "[email protected], *@example.com, *@*.example.com"
*/
ALLOWED_EMAILS: z.string().optional(),
+ EMAIL_LOGIN_ENABLED: z.enum(["true", "false"]).default("true"),
+ REGISTRATION_ENABLED: z.enum(["true", "false"]).default("true"),
/**
* Email addresses for support and no-reply emails.
*/
@@ -116,6 +118,8 @@ export const env = createEnv({
SMTP_SECURE: process.env.SMTP_SECURE,
SMTP_PORT: process.env.SMTP_PORT,
ALLOWED_EMAILS: process.env.ALLOWED_EMAILS,
+ EMAIL_LOGIN_ENABLED: process.env.EMAIL_LOGIN_ENABLED,
+ REGISTRATION_ENABLED: process.env.REGISTRATION_ENABLED,
AWS_ACCESS_KEY_ID: process.env.AWS_ACCESS_KEY_ID,
AWS_SECRET_ACCESS_KEY: process.env.AWS_SECRET_ACCESS_KEY,
AWS_REGION: process.env.AWS_REGION,
diff --git a/apps/web/src/lib/feature-flags/config.ts b/apps/web/src/lib/feature-flags/config.ts
index f040eb017..54b5cdc73 100644
--- a/apps/web/src/lib/feature-flags/config.ts
+++ b/apps/web/src/lib/feature-flags/config.ts
@@ -1,10 +1,17 @@
+import "server-only";
+import { env } from "@/env";
import { isBillingEnabled } from "@/features/billing/constants";
import { isFeedbackEnabled } from "@/features/feedback/constants";
import type { FeatureFlagConfig } from "@/lib/feature-flags/types";
import { isStorageEnabled } from "@/lib/storage";
+const isEmailLoginEnabled = env.EMAIL_LOGIN_ENABLED === "true";
+const isRegistrationEnabled = env.REGISTRATION_ENABLED === "true";
+
export const featureFlagConfig: FeatureFlagConfig = {
storage: isStorageEnabled,
billing: isBillingEnabled,
feedback: isFeedbackEnabled,
+ emailLogin: isEmailLoginEnabled,
+ registration: isEmailLoginEnabled && isRegistrationEnabled,
};
diff --git a/apps/web/src/lib/feature-flags/types.ts b/apps/web/src/lib/feature-flags/types.ts
index f4fbfeeec..6d266e569 100644
--- a/apps/web/src/lib/feature-flags/types.ts
+++ b/apps/web/src/lib/feature-flags/types.ts
@@ -2,6 +2,8 @@ export interface FeatureFlagConfig {
storage: boolean;
billing: boolean;
feedback: boolean;
+ emailLogin: boolean;
+ registration: boolean;
}
export type Feature = keyof FeatureFlagConfig;
diff --git a/apps/web/src/next-auth.ts b/apps/web/src/next-auth.ts
index 699a0928d..b8ae7c0b8 100644
--- a/apps/web/src/next-auth.ts
+++ b/apps/web/src/next-auth.ts
@@ -32,11 +32,13 @@ const {
}),
providers: [
RegistrationTokenProvider,
- EmailProvider,
GuestProvider,
- ...([GoogleProvider(), OIDCProvider(), MicrosoftProvider()].filter(
- Boolean,
- ) as Provider[]),
+ ...([
+ EmailProvider(),
+ GoogleProvider(),
+ OIDCProvider(),
+ MicrosoftProvider(),
+ ].filter(Boolean) as Provider[]),
],
pages: {
signIn: "/login",
diff --git a/apps/web/src/trpc/routers/auth.ts b/apps/web/src/trpc/routers/auth.ts
index 6084c5fbf..ea25ae494 100644
--- a/apps/web/src/trpc/routers/auth.ts
+++ b/apps/web/src/trpc/routers/auth.ts
@@ -7,11 +7,13 @@ import { z } from "zod";
import { isEmailBlocked } from "@/auth/helpers/is-email-blocked";
import { mergeGuestsIntoUser } from "@/auth/helpers/merge-user";
import { isTemporaryEmail } from "@/auth/helpers/temp-email-domains";
-import { getInstanceSettings } from "@/features/instance-settings/queries";
+
import { trackSpaceCreated } from "@/features/space/analytics";
import { createSpace } from "@/features/space/mutations";
+
import { createUser } from "@/features/user/mutations";
import { getEmailClient } from "@/utils/emails";
+import { getRegistrationEnabled } from "@/utils/get-registration-enabled";
import { isValidName } from "@/utils/is-valid-name";
import { createToken, decryptToken } from "@/utils/session";
import { createRateLimitMiddleware, publicProcedure, router } from "../trpc";
@@ -55,8 +57,8 @@ export const auth = router({
| "temporaryEmailNotAllowed";
}
> => {
- const instanceSettings = await getInstanceSettings();
- if (instanceSettings.disableUserRegistration) {
+ const isRegistrationEnabled = await getRegistrationEnabled();
+ if (!isRegistrationEnabled) {
throw new TRPCError({
code: "BAD_REQUEST",
message: "User registration is disabled",
diff --git a/apps/web/src/utils/get-registration-enabled.ts b/apps/web/src/utils/get-registration-enabled.ts
new file mode 100644
index 000000000..7898229e1
--- /dev/null
+++ b/apps/web/src/utils/get-registration-enabled.ts
@@ -0,0 +1,13 @@
+import "server-only";
+
+import { getInstanceSettings } from "@/features/instance-settings/queries";
+import { isFeatureEnabled } from "@/lib/feature-flags/server";
+
+export async function getRegistrationEnabled() {
+ if (!isFeatureEnabled("registration")) {
+ return false;
+ }
+ const instanceSettings = await getInstanceSettings();
+
+ return !instanceSettings.disableUserRegistration;
+}