|
1 | 1 | # SAAS Mode
|
2 | 2 |
|
3 |
| -In SAAS Mode, User can create multiple Workspaces. With some other settings, Admin can control the behavior of Users on SAAS mode . |
4 |
| - |
5 |
| -### Setting Up SAAS mode :  |
6 |
| - |
7 |
| -1. Set LOWCODER\_WORKSPACE\_MODE to "SAAS" in docker-compose-multi.yml file. \ |
8 |
| - .png>)\ |
9 |
| - You can see in the following screenshot that in "SAAS" mode, each User can create multiple Workspaces : \ |
10 |
| - .png>) |
11 |
| -2. 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 SAAS mode. A new Workspace will be created for this User, and he/she will be the Admin of this Workspace : \ |
14 |
| - \ |
15 |
| - LOWCODE\_EMAIL\_SIGNUP\_ENABLED = true;\ |
16 |
| -  (1).png>)\ |
17 |
| - LOWCODE\_EMAIL\_SIGNUP\_ENABLED = false;\ |
18 |
| - .png>) |
19 |
| - 2. **LOWCODER\_CREATE\_WORKSPACE\_ON\_SIGNUP :** \ |
20 |
| - This variable is the configuration for creating a Workspace when new User signs up.\ |
21 |
| - \ |
22 |
| - LOWCODER\_CREATE\_WORKSPACE\_ON\_SIGNUP = true;\ |
23 |
| - .png>)\ |
24 |
| - LOWCODER\_CREATE\_WORKSPACE\_ON\_SIGNUP = false;\ |
25 |
| -  (1).png>) |
26 |
| - |
27 |
| -### Scenarios :  |
| 3 | + |
| 4 | + |
| 5 | +In SAAS Mode, User can create multiple Workspaces. With some other settings, Admin can control the behavior of Users on SAAS mode. |
| 6 | + |
| 7 | +### Setting Up SAAS mode |
| 8 | + |
| 9 | +1. Set LOWCODER\_WORKSPACE\_MODE to "SAAS" in docker-compose-multi.yml file.\ |
| 10 | + |
| 11 | + |
| 12 | + <figure><img src="../../.gitbook/assets/frame_generic_light (4).png" alt=""><figcaption></figcaption></figure> |
| 13 | + |
| 14 | + You can see in the following screenshot that in "SAAS" mode, each User can create multiple Workspaces.\ |
| 15 | + |
| 16 | + |
| 17 | + <figure><img src="../../.gitbook/assets/frame_generic_light (5).png" alt=""><figcaption></figcaption></figure> |
| 18 | +2. In the above screenshot, you can see three configuration variables regarding Email and Workspace creation on Sign up. |
| 19 | + 1. **LOWCODER\_EMAIL\_SIGNUP\_ENABLED**\ |
| 20 | + \ |
| 21 | + 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 SAAS mode. A new Workspace will be created for this User, and he/she will be the Admin of this Workspace : \ |
| 22 | + \ |
| 23 | + LOWCODE\_EMAIL\_SIGNUP\_ENABLED = **true**\ |
| 24 | + |
| 25 | + |
| 26 | + <figure><img src="../../.gitbook/assets/frame_generic_light (1) (1).png" alt=""><figcaption></figcaption></figure> |
| 27 | + |
| 28 | + LOWCODE\_EMAIL\_SIGNUP\_ENABLED = **false**\ |
| 29 | + |
| 30 | + |
| 31 | + <figure><img src="../../.gitbook/assets/frame_generic_light (2).png" alt=""><figcaption></figcaption></figure> |
| 32 | + 2. **LOWCODER\_CREATE\_WORKSPACE\_ON\_SIGNUP**\ |
| 33 | + \ |
| 34 | + This variable is the configuration for creating a Workspace when new User signs up.\ |
| 35 | + \ |
| 36 | + LOWCODER\_CREATE\_WORKSPACE\_ON\_SIGNUP = **true**\ |
| 37 | + |
| 38 | + |
| 39 | + <figure><img src="../../.gitbook/assets/frame_generic_light (6).png" alt=""><figcaption></figcaption></figure> |
| 40 | + |
| 41 | + LOWCODER\_CREATE\_WORKSPACE\_ON\_SIGNUP = **false**\ |
| 42 | + |
| 43 | + |
| 44 | + <figure><img src="../../.gitbook/assets/frame_generic_light (11) (1).png" alt=""><figcaption></figcaption></figure> |
| 45 | + |
| 46 | +### Scenarios |
28 | 47 |
|
29 | 48 | 1. LOWCODER\_WORKSPACE\_MODE = SAAS
|
30 | 49 | 2. LOWCODER\_EMAIL\_SIGNUP\_ENABLED = true
|
@@ -60,31 +79,53 @@ In SAAS Mode, User can create multiple Workspaces. With some other settings, Adm
|
60 | 79 | | Can Admin/Member Sign up / Login | False | False | Enabled |
|
61 | 80 | | Can Admin/Member Sign up / Login | False | False | Disabled |
|
62 | 81 |
|
63 |
| -Let's explain the above scenarios with different settings of the Environment Variables. Let's understand these Env Variables, first : \ |
| 82 | +Let's explain the above scenarios with different settings of the Environment Variables.\ |
| 83 | +\ |
| 84 | +**LOWCODER\_EMAIL\_SIGNUP\_ENABLED** |
| 85 | + |
| 86 | +This Env variable controls the Sign up feature whether New Users can Sign Pp or not. If set to False, Sign up button is not shown up and if a new User tries to enter an email and go forward, User is not shown the Sign up page. |
| 87 | + |
64 | 88 | \
|
65 |
| -1\. **LOWCODER\_EMAIL\_SIGNUP\_ENABLED :** This Env variable controls the Sign up feature whether New Users can sign up or not. If set to False, Sign up button is not shown up and if a new User tries to enter an email and go forward, User is not shown the Sign up page. \ |
66 | 89 | .png>)
|
67 | 90 |
|
68 |
| -2. **LOWCODER\_CREATE\_WORKSPACE\_ON\_SIGNUP :** This Env variable controls the creation of a Workspace when a new User signs up. If set to False, a new User will get added to the Default Workspace. |
69 |
| -3.  **Disable Email Auth :** This feature controls the Sign up/Login using standard Email field. When set to False, Email field won't show up on Sign Up and Login pages, and User won't be able to Sign up or Login using Email field. \ |
70 |
| - \ |
71 |
| - .png>)\ |
72 |
| - \ |
73 |
| - .png>)\ |
74 |
| - **Scenario # 1 : When LOWCODER\_EMAIL\_SIGNUP\_ENABLED = False** |
75 |
| - |
76 |
| - This means that New User can't Sign up on a Workspace. So, LOWCODER\_CREATE\_WORKSPACE\_ON\_SIGNUP Env variable won't matter. Now, if Email Auth is "disabled", then User can only sign in using other Auth Providers, but still New User should NOT be able to Sign up.\ |
77 |
| - \ |
78 |
| - 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.\ |
79 |
| - \ |
80 |
| - **View on /user/auth/login :** \ |
81 |
| - .png>) |
82 |
| - |
83 |
| - **View on /admin/login :** \ |
84 |
| - .png>)\ |
85 |
| - \ |
86 |
| - **Scenario # 1 : When LOWCODER\_EMAIL\_SIGNUP\_ENABLED = True**\ |
87 |
| - This means that New User can't Sign up on a Workspace. If LOWCODER\_CREATE\_WORKSPACE\_ON\_SIGNUP is set to "True", then for every new Sign Up, a New Workspace will be created for the User.  |
88 |
| - |
89 |
| -**Note :** Workspace Mode Env variable can also have the value "MULTIWORKSPACE" instead of "SAAS" . \ |
90 |
| -.png>) |
| 91 | +**LOWCODER\_CREATE\_WORKSPACE\_ON\_SIGNUP** |
| 92 | + |
| 93 | +This Env variable controls the creation of a Workspace when a new User signs up. If set to False, a new User will get added to the Default Workspace. |
| 94 | + |
| 95 | +**Disable Email Auth** |
| 96 | + |
| 97 | +<figure><img src="../../.gitbook/assets/frame_generic_light (10).png" alt=""><figcaption></figcaption></figure> |
| 98 | + |
| 99 | +This feature controls the Sign up/Login using standard Email field. When set to disabled, Email field won't show up on Sign Up and Login pages, and User won't be able to Sign up or Login using Email field. \ |
| 100 | +\ |
| 101 | +\ |
| 102 | +**Scenario: When LOWCODER\_EMAIL\_SIGNUP\_ENABLED = False** |
| 103 | + |
| 104 | +<figure><img src="../../.gitbook/assets/frame_generic_light (8).png" alt="" width="375"><figcaption></figcaption></figure> |
| 105 | + |
| 106 | +This means that New User can't Sign up on a Workspace. So, LOWCODER\_CREATE\_WORKSPACE\_ON\_SIGNUP Env variable won't matter.  |
| 107 | + |
| 108 | +Now, if Email Auth is "disabled", then User can only sign in using other Auth Providers, but still New User should NOT be able to Sign up. |
| 109 | + |
| 110 | +### Administrative Access |
| 111 | + |
| 112 | +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.\ |
| 113 | +\ |
| 114 | +**View on /user/auth/login** |
| 115 | + |
| 116 | +<figure><img src="../../.gitbook/assets/frame_generic_light (16).png" alt=""><figcaption></figcaption></figure> |
| 117 | + |
| 118 | +**View on /admin/login** |
| 119 | + |
| 120 | +<figure><img src="../../.gitbook/assets/frame_generic_light (14).png" alt=""><figcaption></figcaption></figure> |
| 121 | + |
| 122 | +**Scenario: When LOWCODER\_EMAIL\_SIGNUP\_ENABLED = True**\ |
| 123 | +\ |
| 124 | +If LOWCODER\_CREATE\_WORKSPACE\_ON\_SIGNUP is set to "True", then for every new Sign Up, a New Workspace will be created for the User.  |
| 125 | + |
| 126 | +{% hint style="info" %} |
| 127 | +Workspace Mode Env variable can also have the value "MULTIWORKSPACE" instead of "SAAS"  |
| 128 | +{% endhint %} |
| 129 | + |
| 130 | +<figure><img src="../../.gitbook/assets/frame_generic_light (12).png" alt=""><figcaption></figcaption></figure> |
| 131 | + |
0 commit comments