Skip to content

Commit 621df08

Browse files
neon-balconygitbook-bot
authored andcommitted
GitBook: [#53] add docs: 'Members and groups', 'Permissions for resources'
1 parent d1d0d46 commit 621df08

23 files changed

+139
-26
lines changed
67.4 KB
Loading

docs/.gitbook/assets/add-members.png

60.3 KB
Loading

docs/.gitbook/assets/create-group.png

68.7 KB
Loading
2.34 KB
Loading
2.1 KB
Loading
105 KB
Loading

docs/.gitbook/assets/image (3).png

-8.12 KB
Loading

docs/.gitbook/assets/image.png

-46.8 KB
Loading
47.1 KB
Loading
46 KB
Loading

docs/.gitbook/assets/roles-1.png

55 KB
Loading

docs/.gitbook/assets/roles-2.png

70.3 KB
Loading
270 KB
Loading
35.2 KB
Loading

docs/SUMMARY.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,8 @@
2020
* [App editor](build-apps/app-editor.md)
2121
* [Event handlers](build-apps/event-handlers.md)
2222
* [Version and release management](build-apps/version-and-release-management.md)
23+
24+
## Workspace management
25+
26+
* [Members and groups](workspace-management/members-and-groups.md)
27+
* [Permissions for resources](workspace-management/permissions-for-resources.md)

docs/build-apps/event-handlers.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Different components have different events. For example, **Button** components o
2626

2727
Running a query can result in success or failure, so queries have two events: **Success** or **Failure**. You can add event handlers to queries in Query editor.
2828

29-
<figure><img src="../.gitbook/assets/image.png" alt=""><figcaption></figcaption></figure>
29+
<figure><img src="../.gitbook/assets/image (3).png" alt=""><figcaption></figcaption></figure>
3030

3131
## Actions
3232

@@ -52,7 +52,7 @@ To control a component, select a component in the **Component** dropdown list an
5252

5353
### Set temporary state
5454

55-
Store data in a [temporary state](broken-reference).&#x20;
55+
Store data in a temporary state.&#x20;
5656

5757
### Go to app
5858

docs/data-sources/data-source-basics.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ Follow the steps below:
2727

2828
You can also connect to a new data source when creating or editing queries in query library or query editor.
2929

30-
<figure><img src="../.gitbook/assets/image (37).png" alt=""><figcaption><p>query editor</p></figcaption></figure>
30+
<figure><img src="../.gitbook/assets/image (37).png" alt=""><figcaption><p>Query editor</p></figcaption></figure>
3131

32-
<figure><img src="../.gitbook/assets/image (16).png" alt=""><figcaption><p>query library</p></figcaption></figure>
32+
<figure><img src="../.gitbook/assets/image (16).png" alt=""><figcaption><p>Query library</p></figcaption></figure>
3333

3434
## Permissions
3535

docs/queries/query-basics.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Queries support you to read data from or write data to your data sources. You ca
44

55
## Connect to a data source
66

7-
You can connect to a data source that was already in your data source library or create a new one. For detailed information, see [Data source basics](../data-sources/data-source-basics.md).
7+
You can connect to a data source that was already in your data source library or create a new one. For detailed information, see [data-source-basics.md](../data-sources/data-source-basics.md "mention").
88

99
<figure><img src="../.gitbook/assets/image (31).png" alt=""><figcaption></figcaption></figure>
1010

@@ -48,15 +48,12 @@ When Openblocks detects your query statement switches from reading to writing da
4848

4949
## Notification tab and Advanced tab
5050

51-
In notification and advanced tabs, you can configure settings regarding notifications, timeout, periodic run, and more. Settings in **Notification** tab and **Advanced** vary based on trigger mode of your query.\
51+
In notification and advanced tabs, you can configure settings regarding notifications, timeout, periodic run, and more. Settings in **Notification** tab and **Advanced** vary based on trigger mode of your query.
5252

53-
54-
| **Tab** | **Settings** | **Inputs change or on page load** | **Manual invoked** |
55-
| ---------------- | ------------------------------------------- | --------------------------------- | ------------------ |
56-
| **Notification** | Display a Success message after running | 🚫 ||
57-
| | Display a Failure message after running |||
58-
| **Advanced** | Display a confirmation modal before running | <p>🚫<br></p> ||
59-
| | Set timeout for query running |||
60-
| | Perform query periodically || 🚫 |
61-
62-
\
53+
| Tab | Settings | Inputs change or on page load | Manually invoked |
54+
| ---------------- | ------------------------------------------- | :---------------------------: | :--------------: |
55+
| **Notification** | Display a Success message after running | 🚫 ||
56+
| | Display a Failure message after running |||
57+
| **Advanced** | Display a confirmation modal before running | <p>🚫<br></p> ||
58+
| | Set timeout for query running |||
59+
| | Perform query periodically || 🚫 |

docs/security.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Yes, it is very safe for the following reasons:
1515
* All sensitive credentials, such as database passwords, are encrypted with [AES-256 encryption](https://en.wikipedia.org/wiki/Advanced\_Encryption\_Standard).
1616
* All sensitive credentials will never be sent to the browser from the server. They are only used in server side and are never exposed to the browser, the browser will display "Encrypted on the server side" as a placeholder.
1717

18-
<figure><img src=".gitbook/assets/image (3).png" alt=""><figcaption></figcaption></figure>
18+
<figure><img src=".gitbook/assets/image (3) (1).png" alt=""><figcaption></figcaption></figure>
1919

2020
## Other security measures within Openblocks
2121

docs/self-hosting/README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,19 @@ cd openblocks
2828
{% tab title="Docker-Compose (Recommend)" %}
2929
Follow the steps below:
3030

31-
1. Download the configuration file by clicking [docker-compose.yml](https://cdn-files.openblocks.dev/docker-compose.yml) or running the curl command: `curl https://cdn-files.openblocks.dev/docker-compose.yml -o $PWD/docker-compose.yml`
32-
2. Start the Docker container by running this command: `docker-compose up -d` ;\
33-
The docker image, about 400 MB, is downloaded during the initial start-up.
31+
1. Download the configuration file by clicking [docker-compose.yml](https://cdn-files.openblocks.dev/docker-compose.yml) or running the curl command: `curl https://cdn-files.openblocks.dev/docker-compose.yml -o $PWD/docker-compose.yml`\
32+
33+
2. Start the Docker container by running this command: `docker-compose up -d`\
34+
``\
35+
``The docker image, about 400 MB, is downloaded during the initial start-up.
3436

3537
<figure><img src="../.gitbook/assets/download-ce.png" alt=""><figcaption></figcaption></figure>
3638

37-
After downloading, it usually takes less than 30 seconds to start the service.
38-
3. Check the logs by running this command: `docker logs -f openblocks` ;\
39-
When you see `frontend`, `backend`, `redis`, and `mongo` `entered the RUNNING state`, the Openblocks service has officially started:\
39+
After downloading, it usually takes less than 30 seconds to start the service.\
40+
41+
3. Check the logs by running this command: `docker logs -f openblocks`\
42+
``\
43+
``When you see `frontend`, `backend`, `redis`, and `mongo` `entered the RUNNING state`, the Openblocks service has officially started:\
4044

4145

4246
<figure><img src="../.gitbook/assets/check-logs-ce.png" alt=""><figcaption></figcaption></figure>

docs/self-hosting/access-local-database-or-api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@ Assume that a Postgres service is ready on your local host with port `5432`. Con
2626
{% hint style="warning" %}
2727
On some OS (such as Ubuntu), port access might be blocked by the firewall. To solve that, configure in the following steps:
2828

29-
1. Stop the firewall from blocking access from <mark style="background-color:yellow;">**`docker0`**</mark> by typing in the terminal:\ <mark style="background-color:blue;"></mark><mark style="background-color:yellow;">**`iptables -A INPUT -p tcp -i docker0 --dport YOUR_DB_PORT -j ACCEPT`**</mark>\
30-
`Note: In this case`Here we use Postgres port <mark style="background-color:yellow;">**`5432`**</mark> for <mark style="background-color:yellow;">**`YOUR_DB_PORT`**</mark>, and you should replace it with your own.
29+
1. Stop the firewall from blocking access from <mark style="background-color:yellow;">`docker0`</mark> by typing in the terminal:\ <mark style="background-color:blue;"></mark><mark style="background-color:yellow;">`iptables -A INPUT -p tcp -i docker0 --dport YOUR_DB_PORT -j ACCEPT`</mark>\
30+
`Note: In this case`Here we use Postgres port <mark style="background-color:yellow;">`5432`</mark> for <mark style="background-color:yellow;">`YOUR_DB_PORT`</mark>, and you should replace it with your own.
3131
2. Save the firewall configuration by typing in the terminal:\
32-
<mark style="background-color:yellow;">**`iptables-save > /etc/iptables.up.rules`**</mark>
32+
<mark style="background-color:yellow;">`iptables-save > /etc/iptables.up.rules`</mark>
3333
{% endhint %}
3434
{% endtab %}
3535

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Members and groups
2+
3+
In Openblocks, you can organize the members of your workspace using different groups, and assign roles to groups to manage [permissions for resources](permissions-for-resources.md). You can find members and groups settings on the **Workspace settings** page by clicking the avatar in the top right corner.\
4+
<img src="../.gitbook/assets/workspace-settings.png" alt="" data-size="original">
5+
6+
## Manage workspace members
7+
8+
### Invite new members
9+
10+
In the **Members** tab, click **Invite members** to invite new members to the workspace through the invitation link.
11+
12+
<figure><img src="../.gitbook/assets/invite-members-1.png" alt=""><figcaption></figcaption></figure>
13+
14+
You can also find the short cut to <img src="../.gitbook/assets/icon-members-2.png" alt="" data-size="line"> **Invite members** on the bottom left on Openblocks homepage.
15+
16+
<figure><img src="../.gitbook/assets/invite-members-2.png" alt=""><figcaption></figcaption></figure>
17+
18+
{% hint style="info" %}
19+
Permission to invite new members is restricted to workspace **admins** and **developers group**.
20+
{% endhint %}
21+
22+
### Workspace roles and permissions
23+
24+
Set an **Admin** or **Member** role for each workspace member. Role permissions are listed in the table below.
25+
26+
| Role | Workspace and group level permissions |
27+
| ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
28+
| Admin | <p>Workspace</p><ul><li>Modify workspace information (name, logo, etc.)</li><li>Delete workspace</li><li>Manage workspace members and set their roles</li><li>View workspace members</li></ul><p>Groups</p><ul><li>Create groups</li><li>Delete groups</li><li>Manage group members and set their roles</li></ul> |
29+
| Member | None |
30+
31+
Note that the workspace creator is automatically granted with admin permissions. For more information about permissions of apps, modules, and data sources, see [permissions-for-resources.md](permissions-for-resources.md "mention").
32+
33+
## Manage groups
34+
35+
Group-based management helps to organize members from different functional departments in your workspace. You can create groups in **Members** tab.
36+
37+
### Developers group
38+
39+
Openblocks creates a **Developers** group by default and it cannot be deleted, and workspace admins can add members into it. The members of it can create new apps, modules and data sources. Workspace admins can add members to the developers group.
40+
41+
<figure><img src="../.gitbook/assets/Developers-Group.png" alt=""><figcaption></figcaption></figure>
42+
43+
### Create groups and add members
44+
45+
In the **Members** tab of **Workspace settings** interface, workspace admins can click **Create group +** to add a new group. The group creator naturally works as a group admin.
46+
47+
<figure><img src="../.gitbook/assets/create-group.png" alt=""><figcaption></figcaption></figure>
48+
49+
Group admins can add members into groups:
50+
51+
<figure><img src="../.gitbook/assets/add-members.png" alt=""><figcaption></figcaption></figure>
52+
53+
### Group roles and permissions
54+
55+
Set an **Admin** or **Member** role for each group member. The permissions are listed in the table below.
56+
57+
| Role | Permissions |
58+
| ------ | ------------------------------------------------------------------------------------------------------------------------------------- |
59+
| Admin | <ul><li>Change group name</li><li>Delete groups</li><li>Manage group members and set their roles</li><li>View group members</li></ul> |
60+
| Member | View group members |
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
description: >-
3+
Manage permissions for apps, modules, queries, data sources and folders in
4+
your workspace.
5+
---
6+
7+
# Permissions for resources
8+
9+
Openblocks implements [Role-based Access Control](https://en.wikipedia.org/wiki/Role-based\_access\_control) (RBAC) by assigning a set of permissions to different roles. These permissions determine the actions users can take on resources, including apps, modules, queries, data sources and folders.&#x20;
10+
11+
Only workspace admins and members of Developers group are allowed to create resources. For workspace admins, they are in fact the owner of all resources.
12+
13+
## Apps and modules
14+
15+
### Share and set roles
16+
17+
App owners can add members to app and assign different roles to them. In a web app or module editor, click **Share** at the top right, then click **Add members**.
18+
19+
<figure><img src="../.gitbook/assets/share-add-members.png" alt=""><figcaption></figcaption></figure>
20+
21+
Choose members and groups in the list and set roles for them.
22+
23+
![](../.gitbook/assets/roles-1.png)![](../.gitbook/assets/roles-2.png)
24+
25+
The available roles and their corresponding permissions are listed in the table below.
26+
27+
| Role | Permissions |
28+
| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------- |
29+
| <ul><li>Viewer</li></ul> | <ul><li>View the app, or use the module</li></ul> |
30+
| <ul><li>Editor</li></ul> | <ul><li>View the app, or use the module</li><li>Rename</li><li>Edit</li><li>Release</li><li>Export</li></ul> |
31+
| <ul><li>Owner</li></ul> | <ul><li>All permissions of <strong></strong> Editor</li><li>Delete the app or module</li><li>Set roles for members</li></ul> |
32+
33+
### Make app public
34+
35+
If you want to make an app public and accessible to all users (including anonymous users), you can toggle the **Make the app public** switch in **Share** settings.
36+
37+
![](../.gitbook/assets/image.png)
38+
39+
## Data sources
40+
41+
In Openblocks, members with permissions to use, edit and delete data sources **** are listed as follows:
42+
43+
* **Edit** or **Delete**
44+
* Data source creators and workspace admins.
45+
* **Use**
46+
* Workspace admins and developers.
47+
* Members with permissions to edit an app are automatically granted access to use data sources already used in the app.

0 commit comments

Comments
 (0)