Skip to content

Commit 4c9cd59

Browse files
FalkWolskygitbook-bot
FalkWolsky
authored and
gitbook-bot
committed
GITBOOK-208: No subject
1 parent 0e45566 commit 4c9cd59

File tree

4 files changed

+70
-60
lines changed

4 files changed

+70
-60
lines changed

‎docs/SUMMARY.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@
2222
## 🏨 Workspaces & Teamwork
2323

2424
* [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)
25+
* [Multi-Workspace Mode](workspaces-and-teamwork/workspaces/multi-workspace-mode.md)
26+
* [Single Workspace Mode](workspaces-and-teamwork/workspaces/single-workspace-mode.md)
2727
* [Members and Groups](workspaces-and-teamwork/members-and-groups.md)
2828
* [Permissions for Resources](workspaces-and-teamwork/permissions-for-resources.md)
2929
* [OAuth](workspaces-and-teamwork/oauth/README.md)

‎docs/workspaces-and-teamwork/workspaces/README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,15 @@ Lowcoder supports Workspaces. These are isolated rooms to organize:
1010
* [Themes](../../build-applications/themes-and-styling/)
1111
* Global includes (Javascript / CSS)
1212

13+
**You can use Workspaces when you want to have an isolation of Lowcoder for Teams, Divisions, or Tenants of a single Lowcoder Instance.**
14+
15+
Lowcoder offers the configuration of the Workspaces Behaviour. Two modes are supported:
16+
17+
* Single Workspace Mode (_ENTERPRISE Mode_)
18+
* Multi Workspace Mode (_SAAS Mode_)
19+
1320
{% hint style="info" %}
14-
To activate this function, please add the [ENV Variable](https://github.com/lowcoder-org/lowcoder/tree/main/deploy/docker#configuration): **COMMON\_WORKSPACE\_MODE**=SAAS
21+
To activate a multi-workspace configuration, please add the [ENV Variable](https://github.com/lowcoder-org/lowcoder/tree/main/deploy/docker#configuration): **LOWCODER\_WORKSPACE\_MODE**=SAAS
1522
{% endhint %}
1623

1724
{% hint style="info" %}

‎docs/workspaces-and-teamwork/workspaces/saas-mode.md renamed to ‎docs/workspaces-and-teamwork/workspaces/multi-workspace-mode.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,27 @@
1-
# SAAS Mode
1+
# Multi-Workspace Mode
22

33

44

5-
In SAAS Mode, User can create multiple Workspaces. With some other settings, Admin can control the behavior of Users on SAAS mode.
5+
In Multi-Workspace Mode, User can create multiple Workspaces. With some other settings, Admin can control the behavior of Users on Multi-Workspace mode.
66

7-
### Setting Up SAAS mode
7+
### Setting Up Multi-Workspace mode
88

9-
1. Set LOWCODER\_WORKSPACE\_MODE to "SAAS" in docker-compose-multi.yml file.\
9+
1. Set LOWCODER\_WORKSPACE\_MODE to "SAAS" in docker-compose-multi.yml file.
1010

11+
{% hint style="info" %}
12+
Workspace Mode Env variable can also have the value "MULTIWORKSPACE" instead of "SAAS" 
13+
{% endhint %}
1114

12-
<figure><img src="../../.gitbook/assets/frame_generic_light (4).png" alt=""><figcaption></figcaption></figure>
15+
<figure><img src="../../.gitbook/assets/frame_generic_light (4).png" alt=""><figcaption></figcaption></figure>
1316

14-
You can see in the following screenshot that in "SAAS" mode, each User can create multiple Workspaces.\
17+
You can see in the following screenshot that in "Multi-Workspace" mode, each User can create multiple Workspaces.
1518

19+
<figure><img src="../../.gitbook/assets/frame_generic_light (5).png" alt=""><figcaption></figcaption></figure>
1620

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.
21+
1. In the above screenshot, you can see three configuration variables regarding Email and Workspace creation on Sign up.
1922
1. **LOWCODER\_EMAIL\_SIGNUP\_ENABLED**\
2023
\
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 : \
24+
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 Multi-Workspace mode. A new Workspace will be created for this User, and he/she will be the Admin of this Workspace : \
2225
\
2326
LOWCODE\_EMAIL\_SIGNUP\_ENABLED = **true**\
2427

@@ -123,9 +126,5 @@ Here, if Admin disables the "Email Auth" ( means that Members can't Sign up/Logi
123126
\
124127
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.&#x20;
125128

126-
{% hint style="info" %}
127-
Workspace Mode Env variable can also have the value "MULTIWORKSPACE" instead of "SAAS"&#x20;
128-
{% endhint %}
129-
130129
<figure><img src="../../.gitbook/assets/frame_generic_light (12).png" alt=""><figcaption></figcaption></figure>
131130

‎docs/workspaces-and-teamwork/workspaces/enterprise-mode.md renamed to ‎docs/workspaces-and-teamwork/workspaces/single-workspace-mode.md

Lines changed: 48 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Enterprise Mode
1+
# Single Workspace Mode
22

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.&#x20;
3+
In Single Workspace 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 Single Workspace mode.&#x20;
44

5-
### Setting Up Enterprise mode
5+
### Setting Up Single Workspace mode
66

77
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.\
88

@@ -12,48 +12,56 @@ In Enterprise Mode, there is only One Workspace that gets created automatically
1212

1313

1414
<figure><img src="../../.gitbook/assets/frame_generic_light (3) (1).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.&#x20;
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**\
21-
\
22-
![](<../../.gitbook/assets/frame_generic_light (1) (2).png>)\
23-
\
24-
LOWCODER\_EMAIL\_SIGNUP\_ENABLED = **false**\
25-
\
26-
![](<../../.gitbook/assets/frame_generic_light (2) (1).png>)\
27-
28-
2. **LOWCODER\_CREATE\_WORKSPACE\_ON\_SIGNUP**\
29-
\
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-
\
32-
![](<../../.gitbook/assets/frame_generic_light (11) (2).png>)
15+
16+
{% hint style="info" %}
17+
Workspace Mode Env variable can also have the value "SINGLEWORKSPACE" instead of "ENTERPRISE" .
18+
{% endhint %}
19+
20+
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:
21+
22+
23+
24+
1. **LOWCODER\_EMAIL\_SIGNUP\_ENABLED**\
25+
\
26+
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 Single Workspace mode. But, as this is Single Workspace mode, the new User will only become a Member of the default Workspace. \
27+
\
28+
LOWCODER\_EMAIL\_SIGNUP\_ENABLED = **true**\
29+
\
30+
![](<../../.gitbook/assets/frame_generic_light (1) (2).png>)\
31+
\
32+
LOWCODER\_EMAIL\_SIGNUP\_ENABLED = **false**\
33+
\
34+
![](<../../.gitbook/assets/frame_generic_light (2) (1).png>)\
35+
36+
2. **LOWCODER\_CREATE\_WORKSPACE\_ON\_SIGNUP**\
37+
\
38+
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 Single Workspace mode, so this variable value doesn't matter in Single Workspace mode. Setting it to TRUE or FALSE won't create a new Workspace on Sign Up.\
39+
\
40+
![](<../../.gitbook/assets/frame_generic_light (11) (2).png>)
3341

3442
### Scenarios
3543

3644
1. LOWCODER\_WORKSPACE\_MODE = ENTERPRISE
3745
2. LOWCODER\_EMAIL\_SIGNUP\_ENABLED = true
3846

39-
| Scenario | Subscenario | Expected Result |
40-
| ------------------------------------ | ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
41-
| Can Workspace Admin login Normally | | |
42-
| | If They are Admin of Single Workspace | Should be able to Login |
43-
| | If They are Admin of multiple Workspaces | Not Applicable as ENTERPRISE mode allows only ONE Workspace |
44-
| | If they are Admin on Workspace A, but Member on Workspace B | Not Applicable as ENTERPRISE mode allows only ONE Workspace |
45-
| Can Workspace Members login Normally | | |
46-
| | If they are Member at a single Workspace | Should be able to Login |
47-
| | If they are Member at multiple Workspaces | Not Applicable as ENTERPRISE mode allows only ONE Workspace |
48-
| | If they are Member at Workspace A, but Admin on Workspace B | Not Applicable as ENTERPRISE mode allows only ONE Workspace |
49-
| New User Sign up | | |
50-
| | 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 |
51-
| | Can New User sign up as a Member | Any User should be able to sign up as a Member of default Workspace |
52-
| | Can Super Admin make a Member the Admin of Default Workspace | Super Admin should be able to update the Role of Member to Admin |
53-
| | Can Admin create a New Workspace | Admin should NOT be able to create a New Workspace |
54-
| | Can Super Admin create a New Workspace | Super Admin should NOT be able to create a New Workspace |
55-
| | 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 |
56-
| | Can Developer create a New Workspace | Developer should NOT be able to create a New Workspace |
47+
| Scenario | Subscenario | Expected Result |
48+
| ------------------------------------ | ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
49+
| Can Workspace Admin login Normally | | |
50+
| | If They are Admin of Single Workspace | Should be able to Login |
51+
| | If They are Admin of multiple Workspaces | Not Applicable as Single Workspace mode allows only ONE Workspace |
52+
| | If they are Admin on Workspace A, but Member on Workspace B | Not Applicable as Single Workspace mode allows only ONE Workspace |
53+
| Can Workspace Members login Normally | | |
54+
| | If they are Member at a single Workspace | Should be able to Login |
55+
| | If they are Member at multiple Workspaces | Not Applicable as Single Workspace mode allows only ONE Workspace |
56+
| | If they are Member at Workspace A, but Admin on Workspace B | Not Applicable as Single Workspace mode allows only ONE Workspace |
57+
| New User Sign up | | |
58+
| | Can New User sign up as an Admin | Not Applicable as in Single Workspace mode, new User can only sign up as a member of default Workspace |
59+
| | Can New User sign up as a Member | Any User should be able to sign up as a Member of default Workspace |
60+
| | Can Super Admin make a Member the Admin of Default Workspace | Super Admin should be able to update the Role of Member to Admin |
61+
| | Can Admin create a New Workspace | Admin should NOT be able to create a New Workspace |
62+
| | Can Super Admin create a New Workspace | Super Admin should NOT be able to create a New Workspace |
63+
| | 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 |
64+
| | Can Developer create a New Workspace | Developer should NOT be able to create a New Workspace |
5765

5866
| Scenario | LOWCODER\_EMAIL\_SIGNUP\_ENABLED | LOWCODER\_CREATE\_WORKSPACE\_ON\_SIGNUP | Disable Email Auth |
5967
| -------------------------- | --------------------------------- | --------------------------------------- | -------------------- |
@@ -69,7 +77,7 @@ In Enterprise Mode, there is only One Workspace that gets created automatically
6977
### Administrative Access
7078

7179
**Scenario #1 : Admin -> When LOWCODER\_EMAIL\_SIGNUP\_ENABLED = True or False** \
72-
Any User can't sign up as Admin in ENTERPRISE Mode, regardless of any settings for Env Variables. Admin can only Login.
80+
Any User can't sign up as Admin in Single Workspace Mode, regardless of any settings for Env Variables. Admin can only Login.
7381

7482
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.\
7583
\
@@ -91,8 +99,4 @@ This means that New User can sign up as Member. When Email Auth is Disabled, th
9199
**Scenario #3 : Member -> When LOWCODER\_EMAIL\_SIGNUP\_ENABLED = False**\
92100
With this configuration, only existing Members would be able to Login to Lowcoder. No new Member can Sign up.
93101

94-
{% hint style="info" %}
95-
Workspace Mode Env variable can also have the value "SINGLEWORKSPACE" instead of "ENTERPRISE" .
96-
{% endhint %}
97-
98102
<figure><img src="../../.gitbook/assets/frame_generic_light (13).png" alt=""><figcaption></figcaption></figure>

0 commit comments

Comments
 (0)