|
1 | 1 | # Enterprise Mode |
2 | 2 |
|
3 | | -In Enterprise Mode, there is only One Workspace that gets created automatically and Users can only join in that Workspace as a Member/Admin, but can't create their own Workspaces. With some other settings, Super Admin can control the behavior of Users on Enterprise mode . ( will explain it )  |
4 | | - |
5 | | -### Setting Up Enterprise mode :  |
6 | | - |
7 | | -1. In Local Setup, we have a Root Admin User, that we can configure in docker-compose-multi.yml file. This user will be created by default and it will Super Admin of the default Workspace.\ |
8 | | -  (1).png>) |
9 | | -2. Set LOWCODER\_WORKSPACE\_MODE to "ENTERPRISE" in docker-compose-multi.yml file. \ |
10 | | - .png>) |
11 | | -3. In the above screenshot, you can see three configuration variables regarding Email and Workspace creation on Sign up. Let's go through these one by one :  |
12 | | - 1. **LOWCODER\_EMAIL\_SIGNUP\_ENABLED :** \ |
13 | | - This variable is the configuration for showing "Sign Up" button on Lowcoder. When it is set to "TRUE", "Sign Up" button will show up and new User can sign up in ENTERPRISE mode. But, as this is ENTERPRISE mode, so new User will only become the Member of default Workspace. \ |
14 | | - LOWCODER\_EMAIL\_SIGNUP\_ENABLED = true;\ |
| 3 | +In Enterprise Mode, there is only One Workspace that gets created automatically and Users can only join in that Workspace as a Member/Admin, but can't create their own Workspaces. With some other settings, Super Admin can control the behavior of Users on Enterprise mode.  |
| 4 | + |
| 5 | +### Setting Up Enterprise mode |
| 6 | + |
| 7 | +1. In Local Setup, we have a Root Admin User, that we can configure in docker-compose-multi.yml file. This user will be created by default and it will Super Admin of the default Workspace.\ |
| 8 | + |
| 9 | + |
| 10 | + <figure><img src="../../.gitbook/assets/frame_generic_light (3) (1).png" alt=""><figcaption></figcaption></figure> |
| 11 | +2. Set LOWCODER\_WORKSPACE\_MODE to "ENTERPRISE" in docker-compose-multi.yml file. \ |
| 12 | + |
| 13 | + |
| 14 | + <figure><img src="../../.gitbook/assets/frame_generic_light (3).png" alt=""><figcaption></figcaption></figure> |
| 15 | +3. In the above screenshot, you can see three configuration variables regarding Email and Workspace creation on Sign up. Let's go through these one by one.  |
| 16 | + 1. **LOWCODER\_EMAIL\_SIGNUP\_ENABLED**\ |
| 17 | + \ |
| 18 | + This variable is the configuration for showing "Sign Up" button on Lowcoder. When it is set to "true", "Sign Up" button will show up and new User can sign up in ENTERPRISE mode. But, as this is ENTERPRISE mode, the new User will only become a Member of the default Workspace. \ |
| 19 | + \ |
| 20 | + LOWCODER\_EMAIL\_SIGNUP\_ENABLED = **true**\ |
15 | 21 | \ |
16 | 22 |  (2).png>)\ |
17 | | - LOWCODER\_EMAIL\_SIGNUP\_ENABLED = false;\ |
18 | 23 | \ |
19 | | -  (1).png>) |
20 | | - 2. **LOWCODER\_CREATE\_WORKSPACE\_ON\_SIGNUP :** \ |
| 24 | + LOWCODER\_EMAIL\_SIGNUP\_ENABLED = **false**\ |
| 25 | + \ |
| 26 | +  (1).png>)\ |
| 27 | + |
| 28 | + 2. **LOWCODER\_CREATE\_WORKSPACE\_ON\_SIGNUP**\ |
| 29 | + \ |
21 | 30 | This variable is the configuration for creating a Workspace when new User signs up, but as there is only One Workspace that gets created by default in ENTERPRISE mode, so this variable value doesn't matter in ENTERPRISE mode. Setting it to TRUE or FALSE won't create a new Workspace on Sign Up.\ |
| 31 | + \ |
22 | 32 |  (2).png>) |
23 | 33 |
|
24 | | -### Scenarios :  |
| 34 | +### Scenarios |
25 | 35 |
|
26 | 36 | 1. LOWCODER\_WORKSPACE\_MODE = ENTERPRISE |
27 | 37 | 2. LOWCODER\_EMAIL\_SIGNUP\_ENABLED = true |
@@ -56,23 +66,33 @@ In Enterprise Mode, there is only One Workspace that gets created automatically |
56 | 66 | | .... | False | NA | Enabled | |
57 | 67 | | Can Member Sign Up / Login | False | NA | Disabled | |
58 | 68 |
|
59 | | - |
| 69 | +### Administrative Access |
60 | 70 |
|
61 | 71 | **Scenario #1 : Admin -> When LOWCODER\_EMAIL\_SIGNUP\_ENABLED = True or False** \ |
62 | 72 | Any User can't sign up as Admin in ENTERPRISE Mode, regardless of any settings for Env Variables. Admin can only Login. |
63 | 73 |
|
64 | 74 | Here, if Admin disables the "Email Auth" ( means that Members can't Sign up/Login using Standard Email field ), Lowcoder allows Admin to still be able to login using /admin/auth/login. But, for other Users, Email field won't be available at /user/auth/login. They would only be able to see other Auth Providers options set by Admin.\ |
65 | | -**View on /user/auth/login :** \ |
66 | | -.png>) |
| 75 | +\ |
| 76 | +**View on /user/auth/login**\ |
| 77 | +\ |
| 78 | + |
67 | 79 |
|
68 | | -**View on /admin/login :** \ |
69 | | -.png>) |
| 80 | +<figure><img src="../../.gitbook/assets/frame_generic_light (16).png" alt=""><figcaption></figcaption></figure> |
| 81 | + |
| 82 | +**View on /admin/login**\ |
| 83 | +\ |
| 84 | + |
| 85 | + |
| 86 | +<figure><img src="../../.gitbook/assets/frame_generic_light (14).png" alt=""><figcaption></figcaption></figure> |
70 | 87 |
|
71 | 88 | **Scenario #2 : Member -> When LOWCODER\_EMAIL\_SIGNUP\_ENABLED = True**\ |
72 | 89 | This means that New User can sign up as Member. When Email Auth is Disabled, then User can only Sign up/Login using other Auth Providers. |
73 | 90 |
|
74 | 91 | **Scenario #3 : Member -> When LOWCODER\_EMAIL\_SIGNUP\_ENABLED = False**\ |
75 | 92 | With this configuration, only existing Members would be able to Login to Lowcoder. No new Member can Sign up. |
76 | 93 |
|
77 | | -**Note :** Workspace Mode Env variable can also have the value "SINGLEWORKSPACE" instead of "ENTERPRISE" .\ |
78 | | -.png>) |
| 94 | +{% hint style="info" %} |
| 95 | +Workspace Mode Env variable can also have the value "SINGLEWORKSPACE" instead of "ENTERPRISE" . |
| 96 | +{% endhint %} |
| 97 | + |
| 98 | +<figure><img src="../../.gitbook/assets/frame_generic_light (13).png" alt=""><figcaption></figcaption></figure> |
0 commit comments