Skip to content

Commit 14700d3

Browse files
committed
fix: address Prajwal's review feedback on tutorial
- Add Overview section at top of tutorial - Add anchor links in Prerequisites to Couchbase Cluster Setup and ToolJet Setup sections - Add Couchbase docs links for loading travel-sample and allowing IPs in Capella - Clarify self-managed Data API endpoint is server hostname/IP, not always localhost - Add ToolJet self-hosted setup docs link - Remove redundant connection details table in Step 2, replace with prose - Remove duplicate Capella/Self-Managed sub-sections inside Step 2 - Move FTS index creation into Prerequisites section with cross-reference in Step 9
1 parent 8df34ae commit 14700d3

1 file changed

Lines changed: 47 additions & 69 deletions

File tree

tutorial/markdown/connectors/tooljet/tooljet-couchbase-airline-dashboard.md

Lines changed: 47 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ sdk_language:
2525
length: 30 Mins
2626
---
2727

28+
## Overview
29+
2830
In this tutorial, you will build an **Airline Dashboard** — a fully functional internal tool that lets you browse, search, create, edit, and delete airline records stored in Couchbase. You'll use ToolJet's visual app builder and connect it to Couchbase using the Couchbase marketplace plugin, covering all 6 supported operations.
2931

3032
By the end, you'll have a deployed web app that your team can use immediately — no backend code, no frontend framework, no deployment pipeline required.
@@ -51,8 +53,8 @@ An Airline Dashboard with:
5153

5254
To follow this tutorial, you will need:
5355

54-
- A **Couchbase cluster** with the `travel-sample` bucket loaded (see setup instructions below)
55-
- A **ToolJet instance** — either [ToolJet Cloud](https://www.tooljet.com) (free tier available) or self-hosted via Docker
56+
- A **Couchbase cluster** with the `travel-sample` bucket loaded (see [Couchbase Cluster Setup](#couchbase-cluster-setup))
57+
- A **ToolJet instance** — either [ToolJet Cloud](https://www.tooljet.com) (free tier available) or self-hosted via Docker (see [ToolJet Setup](#tooljet-setup))
5658

5759
### Couchbase Cluster Setup
5860

@@ -66,13 +68,15 @@ Couchbase Capella is the easiest way to get started. It has a free tier and the
6668
- Go to your cluster → **Settings****Sample Buckets**
6769
- Select `travel-sample` and click **Load Sample Data**
6870
- Wait for the import to complete
71+
- For detailed instructions, see [Load travel-sample bucket in Couchbase Capella](https://docs.couchbase.com/cloud/clusters/data-service/import-data-documents.html#import-sample-data)
6972
3. **Create database credentials**:
7073
- Go to **Cluster Access****Database Access**
7174
- Create a new user with **Read/Write** access to the `travel-sample` bucket
7275
- Note down the **username** and **password**
7376
4. **Allow network access**:
7477
- Go to **Allowed IP Addresses**
7578
- Add the IP address of your ToolJet instance (visit [whatismyip.com](https://whatismyip.com) to find your public IP if self-hosting)
79+
- For detailed instructions, see [Allow IP Address on Capella](https://docs.couchbase.com/cloud/clusters/allow-ip-address.html)
7680
> **Security Note**: Never allow `0.0.0.0/0` (all IPs). Always restrict access to specific IP addresses, even in development.
7781
5. **Find your Data API endpoint**:
7882
- Go to **Connect** tab
@@ -97,18 +101,19 @@ docker run -d --name couchbase-server \
97101
```
98102

99103
2. **Initialize the cluster**:
100-
- Open `http://localhost:8091` in your browser
104+
- Open `http://<your-server-hostname-or-ip>:8091` in your browser (use `localhost` if running Docker on your local machine)
101105
- Follow the setup wizard to create the cluster
102106
- Create an admin user (note the **username** and **password**)
103107

104108
3. **Load the travel-sample bucket**:
105109
- Go to **Settings****Sample Buckets**
106110
- Check `travel-sample` and click **Load Sample Data**
107111

108-
4. **Your Data API endpoint** is:
112+
4. **Your Data API endpoint** is the base URL of the server running Couchbase:
109113
```
110-
http://localhost:8091
114+
http://<your-server-hostname-or-ip>:8091
111115
```
116+
Use `http://localhost:8091` only if Couchbase is running on the same machine as ToolJet. For remote servers, replace with the server's actual hostname or IP address.
112117
> Note: For self-managed clusters, the Data API is available on the same port as the management API. Ensure Data API is enabled in your cluster configuration.
113118
114119
</details>
@@ -133,7 +138,41 @@ docker run -d \
133138
tooljet/tooljet-ce:v3.16.0-LTS
134139
```
135140

136-
Open `http://localhost` and create your admin account.
141+
Open `http://localhost` and create your admin account. For more setup options (Kubernetes, AWS, GCP, Azure), see the [ToolJet self-hosting guide](https://docs.tooljet.com/docs/setup/docker).
142+
143+
</details>
144+
145+
### Create an FTS Index
146+
147+
Step 9 of this tutorial uses Couchbase Full-Text Search. Create the index now so it's ready when you need it.
148+
149+
<details>
150+
<summary><b>Capella Users</b></summary>
151+
152+
1. In the Capella UI, go to your cluster → **Search**
153+
2. Click **Create Index**
154+
3. Configure:
155+
- **Index Name**: `airline-name-index`
156+
- **Bucket**: `travel-sample`
157+
- **Scope**: `inventory`
158+
- Add a **Type Mapping** for the `airline` collection
159+
- Index the `name` field as **text**
160+
4. Click **Create**
161+
162+
</details>
163+
164+
<details>
165+
<summary><b>Self-Managed Users</b></summary>
166+
167+
1. Open the Couchbase Web Console → **Search**
168+
2. Click **Add Index**
169+
3. Configure:
170+
- **Index Name**: `airline-name-index`
171+
- **Bucket**: `travel-sample`
172+
- **Scope**: `inventory`
173+
- Add a **Type Mapping** for the `airline` collection
174+
- Index the `name` field as **text**
175+
4. Click **Create Index**
137176

138177
</details>
139178

@@ -157,36 +196,7 @@ Now connect ToolJet to your Couchbase cluster:
157196
1. Go to **Data Sources** (left sidebar, database icon)
158197
2. Click **+ Add new data source**
159198
3. Search for **"Couchbase"** and select it
160-
4. Fill in the connection details:
161-
162-
| Field | Value |
163-
|-------|-------|
164-
| **Data API Endpoint** | Your Couchbase Data API URL (see prerequisites) |
165-
| **Username** | Your Couchbase database username |
166-
| **Password** | Your Couchbase database password |
167-
168-
<details>
169-
<summary><b>Capella Users</b></summary>
170-
171-
Your Data API endpoint will look like:
172-
```
173-
https://<cluster-id>.data.cloud.couchbase.com
174-
```
175-
Find it in the Capella UI under **Connect****Data API**.
176-
177-
</details>
178-
179-
<details>
180-
<summary><b>Self-Managed Users</b></summary>
181-
182-
Your Data API endpoint will be:
183-
```
184-
http://localhost:8091
185-
```
186-
Or replace `localhost` with your server's IP/hostname.
187-
188-
</details>
189-
199+
4. Enter your **Data API Endpoint**, **Username**, and **Password** from the prerequisites section
190200
5. Click **Test Connection** — you should see a green "Connection successful" message
191201
6. Click **Save**
192202

@@ -370,39 +380,7 @@ Test it: Click "Add Airline", fill in the form, click "Create". The new airline
370380

371381
Now let's add a search bar that uses Couchbase's Full-Text Search to find airlines by name.
372382

373-
### Create an FTS Index (One-Time Setup)
374-
375-
Before you can search, you need to create an FTS index on the airline collection.
376-
377-
<details>
378-
<summary><b>Capella Users</b></summary>
379-
380-
1. In the Capella UI, go to your cluster → **Search**
381-
2. Click **Create Index**
382-
3. Configure:
383-
- **Index Name**: `airline-name-index`
384-
- **Bucket**: `travel-sample`
385-
- **Scope**: `inventory`
386-
- Add a **Type Mapping** for the `airline` collection
387-
- Index the `name` field as **text**
388-
4. Click **Create**
389-
390-
</details>
391-
392-
<details>
393-
<summary><b>Self-Managed Users</b></summary>
394-
395-
1. Open the Couchbase Web Console → **Search**
396-
2. Click **Add Index**
397-
3. Configure:
398-
- **Index Name**: `airline-name-index`
399-
- **Bucket**: `travel-sample`
400-
- **Scope**: `inventory`
401-
- Add a **Type Mapping** for the `airline` collection
402-
- Index the `name` field as **text**
403-
4. Click **Create Index**
404-
405-
</details>
383+
> Before continuing, ensure you have created the `airline-name-index` FTS index as described in the [Prerequisites](#create-an-fts-index) section.
406384
407385
### Add Search to ToolJet
408386

0 commit comments

Comments
 (0)