feat: Add configurable default email for initial admin user

src/lib/__snapshots__/create-config.test.ts.snap

@@ -22,6 +22,7 @@ exports[`should create default config 1`] = `
     "initialAdminUser": {
       "password": "unleash4all",
       "username": "admin",
+      "email": "[email protected]",
     },
     "type": "open-source",
   },

src/lib/create-config.ts

@@ -267,6 +267,7 @@ const defaultAuthentication: IAuthOption = {
     initialAdminUser: {
         username: process.env.UNLEASH_DEFAULT_ADMIN_USERNAME ?? 'admin',
         password: process.env.UNLEASH_DEFAULT_ADMIN_PASSWORD ?? 'unleash4all',
+        email: process.env.UNLEASH_DEFAULT_ADMIN_EMAIL ?? '[email protected]',
     },
     initApiTokens: [],
 };

src/lib/services/user-service.test.ts

@@ -145,6 +145,7 @@ test('Should create default user - with provided username and password', async (
         initialAdminUser: {
             username: 'admin',
             password: 'unleash4all!',
+            email: '[email protected]',
         },
     });
 
@@ -190,6 +191,7 @@ test('Should not create default user - with `createAdminUser` === false', async
         initialAdminUser: {
             username: 'admin',
             password: 'unleash4all!',
+            email: '[email protected]',
         },
     });
 

src/lib/services/user-service.ts

@@ -136,28 +136,32 @@ class UserService {
     ): Promise<void> {
         let username: string;
         let password: string;
+        let email: string;
 
         if (
             initialAdminUserConfig.createAdminUser !== false &&
             initialAdminUserConfig.initialAdminUser
         ) {
             username = initialAdminUserConfig.initialAdminUser.username;
             password = initialAdminUserConfig.initialAdminUser.password;
+            email = initialAdminUserConfig.initialAdminUser.email;
         } else {
             username = 'admin';
             password = 'unleash4all';
+            email = '[email protected]';
         }
 
         const userCount = await this.store.count();
 
-        if (userCount === 0 && username && password) {
+        if (userCount === 0 && username && password && email) {
             // create default admin user
             try {
                 this.logger.info(
-                    `Creating default user '${username}' with password '${password}'`,
+                    `Creating default user '${username}', password '${password}', and email '${email}'`,
                 );
                 const user = await this.store.insert({
                     username,
+                    email,
                 });
                 const passwordHash = await bcrypt.hash(password, saltRounds);
                 await this.store.setPasswordHash(user.id, passwordHash);

src/lib/types/option.ts

@@ -69,6 +69,7 @@ export interface IAuthOption {
     initialAdminUser?: {
         username: string;
         password: string;
+        email: string;
     };
     initApiTokens: ILegacyApiTokenCreate[];
 }

src/test/e2e/services/user-service.e2e.test.ts

@@ -95,6 +95,7 @@ test('should create initial admin user', async () => {
         initialAdminUser: {
             username: 'admin',
             password: 'unleash4all',
+            email: '[email protected]',
         },
     });
     await expect(async () =>
@@ -116,6 +117,7 @@ test('should not init default user if we already have users', async () => {
         initialAdminUser: {
             username: 'admin',
             password: 'unleash4all',
+            email: '[email protected]',
         },
     });
     const users = await userService.getAll();

website/docs/using-unleash/deploy/configuring-unleash.md

@@ -66,7 +66,7 @@ unleash.start(unleashOptions);
     - `demo` - Only requires an email to sign in (was default in v3)
     - `none` - _Deprecated_ Turn off authentication completely. If no API token is provided towards /`api/client` or `/api/frontend` you will receive configuration for the "default" environment. We generally recommend you use the `demo` type for simple, insecure usage of Unleash. This auth type has many known limitations, particularly related to personalized capabilities such as favorites and [notifications](../../reference/notifications.md). 
   - `customAuthHandler`: function `(app: any, config: IUnleashConfig): void` — custom express middleware handling authentication. Used when type is set to `custom`. Can not be set via environment variables.
-  - `initialAdminUser`: `{ username: string, password: string} | null` — whether to create an admin user with default password - Defaults to using `admin` and `unleash4all` as the username and password. Can not be overridden by setting the `UNLEASH_DEFAULT_ADMIN_USERNAME` and `UNLEASH_DEFAULT_ADMIN_PASSWORD` environment variables.
+  - `initialAdminUser`: `{ username: string, password: string, email: string} | null` — whether to create an admin user with default password - Defaults to using `admin` and `unleash4all` as the username and password, and `[email protected]` as the email. Can not be overridden by setting the `UNLEASH_DEFAULT_ADMIN_USERNAME`, `UNLEASH_DEFAULT_ADMIN_PASSWORD` and `UNLEASH_DEFAULT_ADMIN_EMAIL` environment variables.
     - `initApiTokens` / `INIT_ADMIN_API_TOKENS`, `INIT_CLIENT_API_TOKENS`, and `INIT_FRONTEND_API_TOKENS`: `ApiTokens[]` — Array of API tokens to create on startup. The tokens will only be created if the database doesn't already contain any API tokens. Example:
 
     ```ts

website/docs/using-unleash/deploy/getting-started.md

@@ -31,10 +31,11 @@ To run multiple replicas of Unleash simply point all instances to the same datab
 - username: `admin`
 - password: `unleash4all`
 
-If you'd like the default admin user to be created with a different username and password, you may define the following environment variables when running Unleash:
+If you'd like the default admin user to be created with a different username, password and email, you may define the following environment variables when running Unleash:
 
 - `UNLEASH_DEFAULT_ADMIN_USERNAME`
 - `UNLEASH_DEFAULT_ADMIN_PASSWORD`
+- `UNLEASH_DEFAULT_ADMIN_EMAIL`
 
 The way of defining these variables may vary depending on how you run Unleash.