Skip to content

Commit ca18bb6

Browse files
committed
chore(installtion): clean up
1 parent 821cbe0 commit ca18bb6

File tree

1 file changed

+64
-32
lines changed

1 file changed

+64
-32
lines changed

content/self-hosting/installation/upstall.mdx

Lines changed: 64 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -5,51 +5,83 @@ tags: ['Open Source']
55
keywords : ['NocoDB installation', 'NocoDB one command installation', 'NocoDB prerequisites']
66
---
77

8-
Upstall is the easiest way to install NocoDB with SSL — all within just 2 minutes!
8+
Upstall is the easiest way to install NocoDB with SSL in under 2 minutes.
99

1010
```bash
1111
curl --proto '=https' --tlsv1.2 -sSf -L 'https://raw.githubusercontent.com/nocodb/nocodb/refs/heads/develop/docker-compose/1_Auto_Upstall/noco.sh' | bash -s
1212
```
1313

14-
## Notes on Upstall
15-
Upstall is a single command that provides:
14+
This script automatically installs:
1615

1716
- 📦 Docker
18-
- 🇳 NocoDB,
19-
- 🐘 PostgreSQL,
20-
-Valkey(Redis),
21-
- 🗄 Minio,
22-
- 🌐 nginx gateway.
23-
- 🔒 automated SSL certs and auto renew
17+
* 🚀 NocoDB
18+
* 🐘 PostgreSQL
19+
* ⚡ Redis
20+
* 🗄 Minio (S3-compatible)
21+
* 🌐 nginx (reverse proxy)
22+
* 🔒 SSL certificates (auto-renewed)
2423

25-
## Installation Video
26-
<center>
27-
<iframe width="560" height="315" src="https://www.youtube.com/embed/AkOWLk7e_hk?si=5A1BMLlQHBtj_pHH" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowFullScreen ></iframe>
28-
</center>
24+
You can then visit your server at:
2925

30-
## Quick installation guide
26+
* `https://your-domain.com` (preferred)
27+
* or `http://your-domain.com` if SSL setup is incomplete
3128

32-
This is quick walkthrough of how to install NocoDB using auto-upstall script.
29+
> **Note**: Make sure your domain’s DNS points to the server where you are running Upstall.
3330
34-
- **Step 1** : 🔐 SSH into your server (Linux-based system - Ubuntu, Debian, CentOS etc.)
35-
- **Step 2** : 🚀 Update your DNS records to point your domain to your server
36-
- **Step 3** : 🚀 Run the below command :
37-
```bash
38-
curl --proto '=https' --tlsv1.2 -sSf -L 'https://raw.githubusercontent.com/nocodb/nocodb/refs/heads/develop/docker-compose/1_Auto_Upstall/noco.sh' | bash -s
39-
```
40-
- **Step 4** : 🌐 Open your browser and go to URL
41-
- For 🌍 HTTP: `http://<your-domain-or-ip>`
42-
- For 🔒 HTTPS: `https://<your-domain-or-ip>`
43-
- **Step 5** : 🐦 Don't keep the command a secret. Tweet how easy it is. This step is a must!
4431

45-
<br/>
32+
## Prerequisites
33+
34+
* A Linux server (Ubuntu, Debian, CentOS, etc.)
35+
* A domain pointing to your server
36+
* Port 80 and 443 open
37+
38+
## Video Walkthrough
39+
40+
Want to see it in action? Watch this 2-minute video guide:
41+
42+
<iframe width="560" height="315" src="https://www.youtube.com/embed/AkOWLk7e_hk?si=5A1BMLlQHBtj_pHH" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
43+
44+
## Step-by-Step Installation
45+
46+
1. **Update DNS settings**
47+
Point your domain (e.g. `nocodb.yourdomain.com`) to your server's public IP.
48+
4649

47-
## Installation management menu
50+
2. **SSH into your server**
4851

49-
- Start NocoDB
50-
- Stop NocoDB
51-
- View logs
52-
- Restart NocoDB
53-
- Upgrade NocoDB
52+
```bash
53+
ssh user@your-server-ip
54+
```
55+
56+
3. **Run the Upstall install script**
57+
58+
```bash
59+
curl --proto '=https' --tlsv1.2 -sSf -L 'https://raw.githubusercontent.com/nocodb/nocodb/refs/heads/develop/docker-compose/1_Auto_Upstall/noco.sh' | bash -s
60+
```
61+
62+
4. **Access NocoDB**
63+
Open your browser at `http://your-domain.com`.
64+
65+
> if your NocoDB instance is not immediately accessible wait few minutes for DNS propagation
66+
67+
## Service Management Menu
68+
69+
After installation, a menu is provided to manage your NocoDB instance:
70+
71+
* Start NocoDB
72+
* Stop NocoDB
73+
* View logs
74+
* Restart NocoDB
75+
* Monitor NocoDB
76+
* Update NocoDB
77+
* Delete NocoDB
5478

5579
<img src="/img/v2/engineering/service-mgmt-menu.png" alt="Service Management Menu" width="600"/>
80+
81+
> Backups are not automated. Make sure to manually back up your PostgreSQL or file data if needed.
82+
83+
## Troubleshooting
84+
85+
* **Ports not accessible?** Check firewall settings and make sure port 80 and 443 are open.
86+
* **SSL not working?** Double-check DNS and ensure the domain resolves correctly.
87+
* **Re-run script?** It's idempotent and safe to re-run if needed.

0 commit comments

Comments
 (0)