Skip to content

Commit 68db5ee

Browse files
Openblocks-docsgitbook-bot
Openblocks-docs
authored andcommitted
GitBook: [lowcoder-org#86] add docs: "DigitalOcean"
1 parent 9a7101b commit 68db5ee

26 files changed

+76
-16
lines changed
Loading
167 KB
Loading
62.4 KB
Loading
243 KB
Loading
126 KB
Loading
33.1 KB
Loading
142 KB
Loading
48.8 KB
Loading
83.1 KB
Loading
13.8 KB
Loading
111 KB
Loading
215 KB
Loading
Loading
Loading

‎docs/SUMMARY.md

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
* [Openblocks overview](README.md)
44
* [Self-hosting](self-hosting/README.md)
55
* [Access local database or API](self-hosting/access-local-database-or-api.md)
6+
* [DigitalOcean](self-hosting/digitalocean.md)
67
* [Security](security.md)
78

89
## Data sources

‎docs/build-apps/event-handlers.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
In Openblocks, event handlers are responsible for collecting and processing events from components and queries, and executing subsequent actions. For example, for a **Button** component, you can add an event handler to trigger the **Run query** action **** in response to the button **Click** event.
44

5-
<figure><img src="../.gitbook/assets/image (19).png" alt=""><figcaption></figcaption></figure>
5+
<figure><img src="../.gitbook/assets/image (8) (1).png" alt=""><figcaption></figcaption></figure>
66

77
Set event handlers wisely to provide a reactive and responsive user experience (UX). For example, triggering a **get-all** query after **insert-new-data** query finishes enables table automatically refresh.
88

@@ -32,7 +32,7 @@ Running a query can result in success or failure, so queries have two events: **
3232

3333
There are a number of event handler actions available in Openblocks for handling different scenarios. Set them in the **Action** dropdown list in an event handler.
3434

35-
![](<../.gitbook/assets/image (1) (1).png>)
35+
![](<../.gitbook/assets/image (9) (1).png>)
3636

3737
{% hint style="info" %}
3838
See [advanced](event-handlers.md#advanced) on this page to know advanced settings.
@@ -48,7 +48,7 @@ Trigger the selected query.
4848

4949
To control a component, select a component in the **Component** dropdown list and call one of its methods in the **Method** dropdown list.
5050

51-
![](<../.gitbook/assets/image (17).png>)
51+
![](<../.gitbook/assets/image (29).png>)
5252

5353
### Set temporary state
5454

���docs/build-apps/module.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ When building an app, you want to reuse components and queries across different
44

55
<figure><img src="../.gitbook/assets/module-1.png" alt=""><figcaption><p>Build a <a href="module.md#demo-a-statistics-module">statistics module</a></p></figcaption></figure>
66

7-
<figure><img src="../.gitbook/assets/module-2.png" alt=""><figcaption><p>Reuse this module anywhere</p></figcaption></figure>
7+
<figure><img src="../.gitbook/assets/module-2 (1).png" alt=""><figcaption><p>Reuse this module anywhere</p></figcaption></figure>
88

99
## Module basics
1010

@@ -67,7 +67,7 @@ Module inputs are parameters passed to the module from external apps. The suppor
6767

6868
This section guides you through the steps to build a statistics module and reuse it in an app. &#x20;
6969

70-
<figure><img src="../.gitbook/assets/module-2.png" alt=""><figcaption></figcaption></figure>
70+
<figure><img src="../.gitbook/assets/module-2 (1).png" alt=""><figcaption></figcaption></figure>
7171

7272
1. Create module inputs:
7373

@@ -86,7 +86,7 @@ This section guides you through the steps to build a statistics module and reuse
8686
<figure><img src="../.gitbook/assets/module-17.png" alt=""><figcaption></figcaption></figure>
8787
5. Reuse the module multiple times by passing different input values.&#x20;
8888

89-
<figure><img src="../.gitbook/assets/module-2.png" alt=""><figcaption></figcaption></figure>
89+
<figure><img src="../.gitbook/assets/module-2 (1).png" alt=""><figcaption></figcaption></figure>
9090

9191
#### Input Test
9292

‎docs/build-apps/use-third-party-libraries.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -70,23 +70,23 @@ https://unpkg.com/cowsay@1.5.0/build/cowsay.umd.js
7070

7171
Navigate to the left sidebar, click <img src="../.gitbook/assets/image (1) (2).png" alt="" data-size="line"> > **Other** > **Scripts and style** > **Add a library**. Then paste the **cowsay** link here.
7272

73-
<figure><img src="../.gitbook/assets/Add a library (1).png" alt=""><figcaption></figcaption></figure>
73+
<figure><img src="../.gitbook/assets/Add a library (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
7474

7575
Now you can write code in **JS query** to test its usage with `cowsay.say`:
7676

77-
<figure><img src="../.gitbook/assets/write code in JS query (1).png" alt=""><figcaption></figcaption></figure>
77+
<figure><img src="../.gitbook/assets/write code in JS query (1) (1).png" alt=""><figcaption></figcaption></figure>
7878

7979
or in component **Properties**:
8080

81-
<figure><img src="../.gitbook/assets/or in Properties (1).png" alt=""><figcaption></figcaption></figure>
81+
<figure><img src="../.gitbook/assets/or in Properties (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
8282

8383
And since you have set up cowsay just for **Openblocks's new application 1,** you can not use cowsay in another app.
8484

85-
<figure><img src="../.gitbook/assets/in another app (2).png" alt=""><figcaption></figcaption></figure>
85+
<figure><img src="../.gitbook/assets/in another app (1) (1).png" alt=""><figcaption></figcaption></figure>
8686

8787
### Import on Workspace-level
8888

8989
Navigate to **Workspace settings** > **Advanced** > **JavaScript library** > **Add a library**. Then paste the **cowsay** link here and click **Save**. Now you can use **cowsay** library **** in any app of your workspace.\
90-
![](<../.gitbook/assets/Import on Workspace-level libraries (2).png>)
90+
![](<../.gitbook/assets/Import on Workspace-level libraries (1) (1) (1).png>)
9191

92-
<figure><img src="../.gitbook/assets/Import on Workspace-level libraries-advanced (1) (1).png" alt=""><figcaption></figcaption></figure>
92+
<figure><img src="../.gitbook/assets/Import on Workspace-level libraries-advanced (1).png" alt=""><figcaption></figcaption></figure>

‎docs/data-sources/connect-to-databases/google-sheets.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Navigate back to to [Google Sheets](https://docs.google.com/spreadsheets), and f
3737
1. Open the JSON file of the key.
3838
2. Copy the value of `client_email`, which is an identity used for access management of your sheet.
3939

40-
<figure><img src="../../.gitbook/assets/Google-sheets-key-client-email (1).jpeg" alt=""><figcaption></figcaption></figure>
40+
<figure><img src="../../.gitbook/assets/Google-sheets-key-client-email.jpeg" alt=""><figcaption></figcaption></figure>
4141
3. Click **Share** at the top right and paste the copied `client_email` value to add a member with access.
4242

4343
<figure><img src="../../.gitbook/assets/Google-sheets-share.jpg" alt=""><figcaption></figcaption></figure>

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Follow the steps below:
1515
1. Click **Data Sources** on Openblocks homepage.
1616
2. Click **New data source** on the upper right. This permission is restricted to workspace admins and developers.
1717

18-
<figure><img src="../.gitbook/assets/image (12) (1).png" alt=""><figcaption></figcaption></figure>
18+
<figure><img src="../.gitbook/assets/image (31) (1).png" alt=""><figcaption></figcaption></figure>
1919
3. Select the database or API type you need to connect.&#x20;
2020

2121
<figure><img src="../.gitbook/assets/data source basics-2.png" alt=""><figcaption></figcaption></figure>

‎docs/queries/query-basics.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Queries support you to read data from or write data to your data sources. You ca
66

77
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

9-
<figure><img src="../.gitbook/assets/image (31) (1).png" alt=""><figcaption></figcaption></figure>
9+
<figure><img src="../.gitbook/assets/image (12) (1).png" alt=""><figcaption></figcaption></figure>
1010

1111
## Create a query
1212

‎docs/self-hosting/digitalocean.md

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# DigitalOcean
2+
3+
You can deploy Openblocks on DigitalOcean using our [Openblocks docker image](https://marketplace.digitalocean.com/apps/openblocks) from the DigitalOcean Marketplace. Based on the pre-built image, you can create a DigitalOcean droplet as your cloud-based infrastructure and set up an Openblocks instance in seconds. [Create a DigitalOcean account](https://cloud.digitalocean.com/registrations/new) or [Log in](https://cloud.digitalocean.com/login) to get started.
4+
5+
## Deploy
6+
7+
1. Search **Openblocks** in DigitalOcean Marketplace or visit [Openblocks page](https://marketplace.digitalocean.com/apps/openblocks) directly.
8+
2. Click **Create Openblocks Droplet** to enter the configuring page.
9+
10+
<figure><img src="../.gitbook/assets/DigitalOcean-1.png" alt=""><figcaption></figcaption></figure>
11+
3. Choose the region and datacenter. The closest one to you and your users is recommended.
12+
13+
<figure><img src="../.gitbook/assets/DigitalOcean-2.png" alt=""><figcaption></figcaption></figure>
14+
4. The Openblocks image should already be listed as shown below, so you don't need to choose here.
15+
16+
<figure><img src="../.gitbook/assets/DigitalOcean-3.png" alt=""><figcaption></figcaption></figure>
17+
5. Choose a plan and size for your Droplet, which determines its RAM, disk space, and vCPUs as well as its price. Note that the **Basic** shared CPU with **Regular with SSD (1 GB CPU / 25GB SSD Disk / 1000GB transfer)** CPU option is more than capable of hosting an Openblocks instance.
18+
19+
<figure><img src="../.gitbook/assets/DigitalOcean-4.png" alt=""><figcaption></figcaption></figure>
20+
6. Choose an [SSH key](https://docs.digitalocean.com/products/droplets/how-to/add-ssh-keys/) if you've added one, or create a root password for the Droplet.
21+
22+
<figure><img src="../.gitbook/assets/DigitalOcean-5.png" alt=""><figcaption></figcaption></figure>
23+
7. Set the droplet name, add tags, and click **Create Droplet** to finish the deployment.
24+
25+
<figure><img src="../.gitbook/assets/DigitalOcean-6.png" alt=""><figcaption></figcaption></figure>
26+
27+
It usually takes around a minute to start the droplet.
28+
29+
<figure><img src="../.gitbook/assets/DigitalOcean-7.png" alt=""><figcaption></figcaption></figure>
30+
31+
{% hint style="info" %}
32+
For more help, see [Droplets | DigitalOcean Documentation](https://docs.digitalocean.com/products/droplets/).
33+
{% endhint %}
34+
35+
## Sign up
36+
37+
After deployment, your new Openblocks instance should be available at **http://your\_droplet\_public\_ipv4:3000**.
38+
39+
<figure><img src="../.gitbook/assets/DigitalOcean-8.png" alt=""><figcaption></figcaption></figure>
40+
41+
In the welcome page, Click **Sign up** to get started. Openblocks will automatically create a workspace for you. Then you can start building your apps and invite members to your workspace.
42+
43+
<figure><img src="../.gitbook/assets/DigitalOcean-9.png" alt=""><figcaption></figcaption></figure>
44+
45+
## Droplet Web Console
46+
47+
Find the deployed droplet in your [DigitalOcean projects](https://cloud.digitalocean.com/) and redirect to its details page. Click **Console** on the right to enter the Droplet Web Console.
48+
49+
<figure><img src="../.gitbook/assets/DigitalOcean-10.png" alt=""><figcaption></figcaption></figure>
50+
51+
<figure><img src="../.gitbook/assets/DigitalOcean-11.png" alt=""><figcaption></figcaption></figure>
52+
53+
## Update
54+
55+
For information about how to update the Openblocks image to the latest version, see [Update](./#update).
56+
57+
## Customize deployment configurations
58+
59+
For information about how to customize deployment configurations, see [Customize deployment configurations](./#customize-deployment-configurations).

‎docs/workspace-management/members-and-groups.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Group-based management helps to organize members from different functional depar
3737

3838
### Developers group
3939

40-
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+
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 resources including apps, modules, navigations, folders, and data sources, and can manage query library. Workspace admins can add members to the developers group.
4141

4242
<figure><img src="../.gitbook/assets/members4.png" alt=""><figcaption></figcaption></figure>
4343

0 commit comments

Comments
 (0)