Skip to content

Commit 9e2d0ed

Browse files
Openblocks-docsgitbook-bot
Openblocks-docs
authored andcommitted
GitBook: [lowcoder-org#95] add docs: "AWS AMI"
1 parent b297d14 commit 9e2d0ed

16 files changed

+93
-11
lines changed

docs/.gitbook/assets/aws-ami-1.png

173 KB
Loading

docs/.gitbook/assets/aws-ami-10.png

67.3 KB
Loading

docs/.gitbook/assets/aws-ami-11.png

633 KB
Loading

docs/.gitbook/assets/aws-ami-2.png

217 KB
Loading

docs/.gitbook/assets/aws-ami-3.png

419 KB
Loading

docs/.gitbook/assets/aws-ami-4.png

346 KB
Loading

docs/.gitbook/assets/aws-ami-5.png

340 KB
Loading

docs/.gitbook/assets/aws-ami-6.png

78.4 KB
Loading

docs/.gitbook/assets/aws-ami-7.png

432 KB
Loading

docs/.gitbook/assets/aws-ami-8.png

1.68 MB
Loading

docs/.gitbook/assets/aws-ami-9.png

140 KB
Loading

docs/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
* [Self-hosting](self-hosting/README.md)
55
* [Access local database or API](self-hosting/access-local-database-or-api.md)
66
* [DigitalOcean](self-hosting/digitalocean.md)
7+
* [AWS AMI](self-hosting/aws-ami.md)
78
* [Security](security.md)
89

910
## Data sources

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

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,8 @@ You can also connect to a new data source when creating or editing queries in qu
3333

3434
## Permissions
3535

36-
In Openblocks, members with permissions to create, edit, delete and use data sources **** are listed as follows:
36+
Only workspace admins and developers can view the **Data Sources** page and create new data sources.
3737

38-
* **Create:** workspace admins and developers
39-
* **Edit** or **Delete:** workspace admins and data source creators
40-
* **Use**: workspace admins and developers
38+
For each data source, workspace admins and the creator can change its **Access Control**. Go to Openblocks homepage > **Data Sources**, and click `···` > **Access Control**.
4139

42-
In particular, members with permissions to edit an app are automatically granted access to use existing data sources in the app.
40+
For more information on permissions for data sources, see [Data sources](../workspace-management/permissions-for-resources.md#data-sources).

docs/self-hosting/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ description: Host Openblocks on your own device using Docker or Docker-Compose.
1010
* [Docker-Compose](https://docs.docker.com/compose/install/) (version 1.29.2 or above)
1111

1212
{% hint style="info" %}
13-
System minimum requirements: 2-core CPU and 4 GB RAM.
13+
Recommended system spec: 1-core CPU and 2 GB RAM.
1414

1515
Windows users are recommended to use PowerShell for running commands below.
1616
{% endhint %}

docs/self-hosting/aws-ami.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# AWS AMI
2+
3+
Openblocks provides an Amazon Machine Image (AMI) for your self-hosting on [Amazon Web Services (AWS)](https://aws.amazon.com/).
4+
5+
## Deploy
6+
7+
1. Sign in to [Amazon Web Services (AWS)](https://aws.amazon.com/) or [Create and activate an AWS account](https://aws.amazon.com/premiumsupport/knowledge-center/create-and-activate-aws-account/?nc1=h\_ls) first.
8+
2. Follow the steps in [Create a key pair using Amazon EC2](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-key-pairs.html#having-ec2-create-your-key-pair) to generate an SSH key pair.
9+
10+
<figure><img src="../.gitbook/assets/aws-ami-1.png" alt=""><figcaption></figcaption></figure>
11+
3. Follow the steps in [Create a security group](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/working-with-security-groups.html#creating-security-group) to create a new AWS security group. While creating, add an inbound rule that sets port **3000** to be accessible from **anywhere**, as shown below.
12+
13+
<figure><img src="../.gitbook/assets/aws-ami-2.png" alt=""><figcaption></figcaption></figure>
14+
4. Click **Images** -> **AMI Catalog** on the left sidebar. Type in **Openblocks** to search in **AWS Marketplace AMIs**. **Select** the Openblocks image from results, then click the **Launch Instance with AMI** button to proceed.
15+
16+
<figure><img src="../.gitbook/assets/aws-ami-3.png" alt=""><figcaption></figcaption></figure>
17+
5. Configure the following settings:
18+
19+
1. Choose your desired **Instance type**. We'd recommend a system spec with 1 core CPU and 2 GB RAM or the above.
20+
2. Select the **key pair** created in step 2.
21+
3. **Enable** auto-assigning public IP.
22+
4. Select the **security group** created in step 3.
23+
24+
<figure><img src="../.gitbook/assets/aws-ami-4.png" alt=""><figcaption></figcaption></figure>
25+
6. You can check the settings again and click the **Lauch instance** button to proceed.
26+
27+
<figure><img src="../.gitbook/assets/aws-ami-5.png" alt=""><figcaption></figcaption></figure>
28+
29+
It usually takes a few minutes to start the instance.
30+
31+
<figure><img src="../.gitbook/assets/aws-ami-6.png" alt=""><figcaption></figcaption></figure>
32+
33+
After deployment, you can view the instance details on the **Instances** page and get the **public IPv4 address**.
34+
35+
<figure><img src="../.gitbook/assets/aws-ami-7.png" alt=""><figcaption></figcaption></figure>
36+
37+
Your new Openblocks instance should be available at **http://public\_ipv4\_address:3000**.&#x20;
38+
39+
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.
40+
41+
<figure><img src="../.gitbook/assets/aws-ami-8.png" alt=""><figcaption></figcaption></figure>
42+
43+
## Connect to instance
44+
45+
You can connect to your instance to update the image or customize deployment configurations.
46+
47+
&#x20;Click **Connect** on the **Instances** page. AWS provides four connection options.
48+
49+
<figure><img src="../.gitbook/assets/aws-ami-9.png" alt=""><figcaption></figcaption></figure>
50+
51+
<figure><img src="../.gitbook/assets/aws-ami-10.png" alt=""><figcaption></figcaption></figure>
52+
53+
{% hint style="info" %}
54+
For detailed information, see [Connect to your Linux instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AccessingInstances.html).
55+
{% endhint %}
56+
57+
For example, you can connect to your instance using an SSH client. Locate your private key file and get your public IPv4 DNS. Then run the following command:
58+
59+
```bash
60+
ssh -i "your_private_key.pem" ubuntu@your_public_IPv4_DNS
61+
```
62+
63+
<figure><img src="../.gitbook/assets/aws-ami-11.png" alt=""><figcaption></figcaption></figure>
64+
65+
### Update
66+
67+
For information about how to update the Openblocks image to the latest version, see [Update](./#update).
68+
69+
### Customize deployment configurations
70+
71+
| Location | Usage |
72+
| ------------------------------------------------------------ | --------------------------------------------------- |
73+
| <p><code>~/openblocks/docker-compose.yml</code><br></p> | Setting up Docker ports, volumes, environments etc. |
74+
| `~/openblocks/stacks/configuration/application-selfhost.yml` | Setting up Openblocks server configurations |
75+
76+
For information about how to customize deployment configurations, see [Customize deployment configurations](./#customize-deployment-configurations).

docs/self-hosting/digitalocean.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,11 @@ You can deploy Openblocks on DigitalOcean using our [Openblocks docker image](ht
1414
4. The Openblocks image should already be listed as shown below, so you don't need to choose here.
1515

1616
<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.
17+
5. Choose a plan and size for your Droplet, which determines its RAM, disk space, and vCPUs as well as its price. We'd recommend a system spec with **1 core CPU and 2 GB RAM** or the above.
1818

1919
<figure><img src="../.gitbook/assets/DigitalOcean-4.png" alt=""><figcaption></figcaption></figure>
20+
21+
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.
2022
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.
2123

2224
<figure><img src="../.gitbook/assets/DigitalOcean-5.png" alt=""><figcaption></figcaption></figure>
@@ -32,8 +34,6 @@ You can deploy Openblocks on DigitalOcean using our [Openblocks docker image](ht
3234
For more help, see [Droplets | DigitalOcean Documentation](https://docs.digitalocean.com/products/droplets/).
3335
{% endhint %}
3436

35-
## Sign up
36-
3737
After deployment, your new Openblocks instance should be available at **http://your\_droplet\_public\_ipv4:3000**.
3838

3939
<figure><img src="../.gitbook/assets/DigitalOcean-8.png" alt=""><figcaption></figcaption></figure>
@@ -44,16 +44,23 @@ In the welcome page, Click **Sign up** to get started. Openblocks will automatic
4444

4545
## Droplet Web Console
4646

47+
You can use Droplet Web Console to connect to your instance to update the image or customize deployment configurations.&#x20;
48+
4749
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.
4850

4951
<figure><img src="../.gitbook/assets/DigitalOcean-10.png" alt=""><figcaption></figcaption></figure>
5052

5153
<figure><img src="../.gitbook/assets/DigitalOcean-11.png" alt=""><figcaption></figcaption></figure>
5254

53-
## Update
55+
### Update
5456

5557
For information about how to update the Openblocks image to the latest version, see [Update](./#update).
5658

57-
## Customize deployment configurations
59+
### Customize deployment configurations
60+
61+
| Location | Usage |
62+
| ------------------------------------------------------------ | --------------------------------------------------- |
63+
| <p><code>~/openblocks/docker-compose.yml</code><br></p> | Setting up Docker ports, volumes, environments etc. |
64+
| `~/openblocks/stacks/configuration/application-selfhost.yml` | Setting up Openblocks server configurations |
5865

5966
For information about how to customize deployment configurations, see [Customize deployment configurations](./#customize-deployment-configurations).

0 commit comments

Comments
 (0)