Skip to content

Commit c68151e

Browse files
adnanqaopsgitbook-bot
authored andcommitted
GITBOOK-190: Workspace Mode Configurations
1 parent 0008fa0 commit c68151e

24 files changed

+185
-11
lines changed
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading

docs/SUMMARY.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,9 @@
2121

2222
## 🏨 Workspaces & Teamwork
2323

24-
* [Workspaces](workspaces-and-teamwork/workspaces.md)
24+
* [Workspaces](workspaces-and-teamwork/workspaces/README.md)
25+
* [SAAS Mode](workspaces-and-teamwork/workspaces/saas-mode.md)
26+
* [Enterprise Mode](workspaces-and-teamwork/workspaces/enterprise-mode.md)
2527
* [Members and Groups](workspaces-and-teamwork/members-and-groups.md)
2628
* [Permissions for Resources](workspaces-and-teamwork/permissions-for-resources.md)
2729
* [OAuth](workspaces-and-teamwork/oauth/README.md)

docs/workspaces-and-teamwork/workspaces.md renamed to docs/workspaces-and-teamwork/workspaces/README.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ Lowcoder supports Workspaces. These are isolated rooms to organize:
44

55
* User-Groups
66
* Users
7-
* [Data Sources](../connect-your-data/data-source-basics/)
8-
* [Predefined Data Queries](query-library.md)
9-
* [Apps](../build-applications/create-a-new-app/) & App Folders
10-
* [Themes](../build-applications/themes-and-styling/)
7+
* [Data Sources](../../connect-your-data/data-source-basics/)
8+
* [Predefined Data Queries](../query-library.md)
9+
* [Apps](../../build-applications/create-a-new-app/) & App Folders
10+
* [Themes](../../build-applications/themes-and-styling/)
1111
* Global includes (Javascript / CSS)
1212

1313
{% hint style="info" %}
@@ -31,31 +31,31 @@ This can be helpful if you have your own Identity / OAuth Provider listed and wa
3131

3232
The Workspace is a tool to use for organizing groups or user access to Apps. It is also used to apply a theme to a set of Apps.
3333

34-
<figure><img src="../.gitbook/assets/Admin Workspaces.png" alt=""><figcaption><p>A list of Workspaces</p></figcaption></figure>
34+
<figure><img src="../../.gitbook/assets/Admin Workspaces.png" alt=""><figcaption><p>A list of Workspaces</p></figcaption></figure>
3535

3636
In the public Lowcoder Cloud, the amount of Workspaces is limited to 10.
3737

3838
In the upper right corner, at the profile, you can find the possibility to switch between your Workspaces.
3939

40-
<figure><img src="../.gitbook/assets/Admin Switch Workspace.png" alt="" width="563"><figcaption><p>Switch between Workspaces</p></figcaption></figure>
40+
<figure><img src="../../.gitbook/assets/Admin Switch Workspace.png" alt="" width="563"><figcaption><p>Switch between Workspaces</p></figcaption></figure>
4141

4242
### Apps & App Folders
4343

4444
[In Lowcoder, you can create Apps. Each App represents what you can create on a single Screen. Often, a complete application consists of multiple Apps. You can then organize these relationships in App Folders or separate them by Workspaces.](#user-content-fn-1)[^1]
4545

46-
<figure><img src="../.gitbook/assets/Admin Folders for Apps.png" alt=""><figcaption><p>Organize Apps into Folders to create order and show relationships</p></figcaption></figure>
46+
<figure><img src="../../.gitbook/assets/Admin Folders for Apps.png" alt=""><figcaption><p>Organize Apps into Folders to create order and show relationships</p></figcaption></figure>
4747

4848
### Themes
4949

50-
You can create multiple [Themes](../build-applications/themes-and-styling/) for your apps and select a style theme for each app individually. However, each Workspace has its own collection of Themes.
50+
You can create multiple [Themes](../../build-applications/themes-and-styling/) for your apps and select a style theme for each app individually. However, each Workspace has its own collection of Themes.
5151

52-
<figure><img src="../.gitbook/assets/Admin Themes.png" alt=""><figcaption><p>Themes helps to style Applications individually</p></figcaption></figure>
52+
<figure><img src="../../.gitbook/assets/Admin Themes.png" alt=""><figcaption><p>Themes helps to style Applications individually</p></figcaption></figure>
5353

5454
### Global Includes
5555

5656
It is possible to include global CSS styles to fine-tune the visuals of Apps. Also, it may be necessary to include a Javascript script, which is executed for all Apps of a Workspace. With the help of global includes, you can achieve Workspace.
5757

58-
<figure><img src="../.gitbook/assets/Admin Global Includes.png" alt=""><figcaption></figcaption></figure>
58+
<figure><img src="../../.gitbook/assets/Admin Global Includes.png" alt=""><figcaption></figcaption></figure>
5959

6060
### Demo
6161

@@ -80,5 +80,9 @@ On self-hosted installations, you can set up thresholds for workspaces with the
8080
* **LOWCODER\_MAX\_DEVELOPERS**
8181
* **Description**: Sets the default maximum number of Users with Developer-Role that can be registered in the Workspace.
8282
* **Default Value**: 100
83+
* **LOWCODER\_WORKSPACE\_MODE**
84+
* **Description:** Sets the Lowcoder Workspace Mode. Currently, there are two modes :&#x20;
85+
* ENTERPRISE mode
86+
* SAAS mode
8387

8488
[^1]:
Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Enterprise Mode
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 )&#x20;
4+
5+
### Setting Up Enterprise mode :&#x20;
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+
![](<../../.gitbook/assets/frame_generic_light (3) (1).png>)
9+
2. Set LOWCODER\_WORKSPACE\_MODE to "ENTERPRISE" in docker-compose-multi.yml file. \
10+
![](<../../.gitbook/assets/frame_generic_light (3).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 :&#x20;
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;\
15+
\
16+
![](<../../.gitbook/assets/frame_generic_light (1) (2).png>)\
17+
LOWCODER\_EMAIL\_SIGNUP\_ENABLED = false;\
18+
\
19+
![](<../../.gitbook/assets/frame_generic_light (2) (1).png>)
20+
2. **LOWCODER\_CREATE\_WORKSPACE\_ON\_SIGNUP :** \
21+
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.\
22+
![](<../../.gitbook/assets/frame_generic_light (11) (2).png>)
23+
24+
### Scenarios :&#x20;
25+
26+
1. LOWCODER\_WORKSPACE\_MODE = ENTERPRISE
27+
2. LOWCODER\_EMAIL\_SIGNUP\_ENABLED = true
28+
29+
| Scenario | Subscenario | Expected Result |
30+
| ------------------------------------ | ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
31+
| Can Workspace Admin login Normally | | |
32+
| | If They are Admin of Single Workspace | Should be able to Login |
33+
| | If They are Admin of multiple Workspaces | Not Applicable as ENTERPRISE mode allows only ONE Workspace |
34+
| | If they are Admin on Workspace A, but Member on Workspace B | Not Applicable as ENTERPRISE mode allows only ONE Workspace |
35+
| Can Workspace Members login Normally | | |
36+
| | If they are Member at a single Workspace | Should be able to Login |
37+
| | If they are Member at multiple Workspaces | Not Applicable as ENTERPRISE mode allows only ONE Workspace |
38+
| | If they are Member at Workspace A, but Admin on Workspace B | Not Applicable as ENTERPRISE mode allows only ONE Workspace |
39+
| New User Sign up | | |
40+
| | Can New User sign up as an Admin | Not Applicable as in ENTERPRISE mode, new User can only sign up as a member of default Workspace |
41+
| | Can New User sign up as a Member | Any User should be able to sign up as a Member of default Workspace |
42+
| | Can Super Admin make a Member the Admin of Default Workspace | Super Admin should be able to update the Role of Member to Admin |
43+
| | Can Admin create a New Workspace | Admin should NOT be able to create a New Workspace |
44+
| | Can Super Admin create a New Workspace | Super Admin should NOT be able to create a New Workspace |
45+
| | Can Super Admin or Admin update the Role of a Member to Developer | Super Admin or Admin should be able to update the Role of a Member to Developer |
46+
| | Can Developer create a New Workspace | Developer should NOT be able to create a New Workspace |
47+
48+
| Scenario | LOWCODER\_EMAIL\_SIGNUP\_ENABLED | LOWCODER\_CREATE\_WORKSPACE\_ON\_SIGNUP | Disable Email Auth |
49+
| -------------------------- | --------------------------------- | --------------------------------------- | -------------------- |
50+
| Can Admin Login | True | NA | Enabled |
51+
| .... | True | NA | Disabled |
52+
| .... | False | NA | Enabled |
53+
| Can Admin Login | False | NA | Disabled |
54+
| Can Member Sign Up / Login | True | NA | Enabled |
55+
| .... | True | NA | Disabled |
56+
| .... | False | NA | Enabled |
57+
| Can Member Sign Up / Login | False | NA | Disabled |
58+
59+
60+
61+
**Scenario #1 : Admin -> When LOWCODER\_EMAIL\_SIGNUP\_ENABLED = True or False** \
62+
Any User can't sign up as Admin in ENTERPRISE Mode, regardless of any settings for Env Variables. Admin can only Login.
63+
64+
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+
![](<../../.gitbook/assets/frame_generic_light (16).png>)
67+
68+
**View on /admin/login :** \
69+
![](<../../.gitbook/assets/frame_generic_light (14).png>)
70+
71+
**Scenario #2 : Member -> When LOWCODER\_EMAIL\_SIGNUP\_ENABLED = True**\
72+
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+
74+
**Scenario #3 : Member -> When LOWCODER\_EMAIL\_SIGNUP\_ENABLED = False**\
75+
With this configuration, only existing Members would be able to Login to Lowcoder. No new Member can Sign up.
76+
77+
**Note :** Workspace Mode Env variable can also have the value "SINGLEWORKSPACE" instead of "ENTERPRISE" .\
78+
![](<../../.gitbook/assets/frame_generic_light (13).png>)

0 commit comments

Comments
 (0)