Restricting Sign-up

Control the users who can sign up on your appsmith instance.

This document describes ways to restrict users from signing up on your self-hosted Appsmith instance. This configuration is done using environment variables in your installation folder. If you've setup Appsmith use the install.sh script, these environment variables can be set in the docker.env file located in your installation directory.

Disable Sign-up

The environment variable APPSMITH_SIGNUP_DISABLED should be set to true to disable signing up of new users. When set, the following facts hold:

  1. New, uninvited users cannot signup using the signup form or the OAuth buttons. Both modes of signing up are

    disallowed.

  2. New, invited users can still signup using either the form or the OAuth buttons.

This environment variable's value does not affect the login behavior of existing users.

Email domains white-list

The environment variable APPSMITH_SIGNUP_ALLOWED_DOMAINS can be used to restrict signups to emails belonging to only a specific set of domains. This field takes a comma-separated set of values.

Setting APPSMITH_SIGNUP_ALLOWED_DOMAINS=appsmith.com will allow [email protected] to sign up, but not [email protected].

Setting APPSMITH_SIGNUP_ALLOWED_DOMAINS=appsmith.com,gmail.com will allow both [email protected] and [email protected] to sign up, but not [email protected].

When this environment variable is set to one or more domains, the following facts hold:

  1. New, uninvited users cannot signup using the signup form or the OAuth buttons unless the email they use has a

    domain that's present in this environment variable.

  2. New, but invited users can still signup using the signup form or the OAuth buttons, even if their email **does

    not** have a domain in the environment variable.

This environment variable's value does not affect the login behavior of existing users

Accounts created via form signup are not validated via an email

Administrator emails

The environment variable APPSMITH_ADMIN_EMAILS can be set to a comma-separated list of email addresses, that will always be allowed to sign up, irrespective of the above two environment variables.

For example:

These two email addresses will be able to sign up on the Appsmith instance irrespective of the APPSMITH_SIGNUP_ALLOWED_DOMAINSandAPPSMITH_SIGNUP_DISABLED configurations