Skip to content

Commit 9f10ef8

Browse files
committed
chore(installtion): clean up
1 parent 5d54e75 commit 9f10ef8

File tree

7 files changed

+74
-292
lines changed

7 files changed

+74
-292
lines changed

content/self-hosting/installation/cloudron.mdx

Lines changed: 16 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -14,83 +14,32 @@ Before proceeding, ensure:
1414
* You’ve signed into the Cloudron App Store.
1515
* You’re comfortable using the command line and basic Cloudron CLI commands.
1616

17-
If Cloudron is not yet installed, follow their [official installation guide](https://docs.cloudron.io/installation/) first.
17+
## Deploying NocoDB on Cloudron
1818

19-
## Step 1: Install the Cloudron CLI
19+
1. Log into your Cloudron admin panel.
2020

21-
The Cloudron CLI allows you to interact with your instance from your local machine.
21+
2. Open the **App Store** from the main dashboard.
2222

23-
```bash
24-
# Run this on your local computer (not the server)
25-
npm install -g cloudron
26-
```
23+
![Cloudron App Store](/img/v2/installations/cloudron-app-store.png)
2724

28-
More info: [Cloudron CLI Docs](https://docs.cloudron.io/custom-apps/cli/)
25+
3. In the search bar, type **NocoDB**.
2926

30-
## Step 2: Log in to Your Cloudron Instance
27+
![Cloudron Search NocoDB](/img/v2/installations/cloudron-search-nocodb.png)
3128

32-
```bash
33-
cloudron login my.yourdomain.com
34-
```
29+
4. Select the **NocoDB** app and click **Install**.
3530

36-
Replace `my.yourdomain.com` with your actual Cloudron domain.
31+
![Cloudron Install](/img/v2/installations/cloudron-install.png)
3732

38-
## Step 3: Clone the NocoDB App Template
33+
5. Configure the app’s domain, access settings, and environment variables as needed.
3934

40-
Clone the Cloudron-specific deployment setup for NocoDB:
35+
![Cloudron Configure](/img/v2/installations/cloudron-configure.png)
4136

42-
```bash
43-
git clone https://github.com/nocodb/cloudron-app-template.git
44-
cd cloudron-app-template
45-
```
37+
6. After installation, go to the **My Apps** section and launch your new NocoDB instance.
4638

47-
This repo includes the necessary manifest and Docker configuration tailored for Cloudron.
39+
![Cloudron My Apps](/img/v2/installations/cloudron-my-apps.png)
4840

49-
## Step 4: Deploy NocoDB
41+
## Things to Keep in Mind
5042

51-
Use the CLI to install NocoDB:
52-
53-
```bash
54-
cloudron install --image nocodb/cloudron:latest -l nocodb.yourdomain.com
55-
```
56-
57-
Once deployed, NocoDB will be accessible at `https://nocodb.yourdomain.com`.
58-
59-
📌 You can browse available images here:
60-
[https://hub.docker.com/r/nocodb/cloudron](https://hub.docker.com/r/nocodb/cloudron)
61-
62-
If you encounter a `402: Missing token` error, ensure that your Cloudron server is fully registered and logged into the App Store via the web UI.
63-
64-
## Updating to a New Version
65-
66-
1. Determine your app’s ID:
67-
68-
```bash
69-
cloudron list
70-
```
71-
72-
2. Pull the latest app definition:
73-
74-
```bash
75-
git pull origin main
76-
```
77-
78-
3. Upgrade your app:
79-
80-
```bash
81-
cloudron update --app your-app-id --image nocodb/cloudron:latest
82-
```
83-
84-
Always make sure to reference the latest available NocoDB Cloudron image from [Docker Hub](https://hub.docker.com/r/nocodb/cloudron).
85-
86-
## Custom Domains and Aliases
87-
88-
To serve NocoDB on a different domain:
89-
90-
1. Go to the **Cloudron Dashboard**.
91-
2. Open your NocoDB app settings.
92-
3. Click **Location → Add alias**.
93-
4. Enter your preferred domain or subdomain (must match the domain configured in NocoDB if used internally).
94-
5. Cloudron will automatically provision an SSL certificate.
95-
96-
Wildcard domains are supported but may need additional configuration for SSL to function correctly.
43+
* **System Requirements**: Make sure your Cloudron server has enough resources (at least 1 vCPU and 1 GB RAM for testing, 2 GB+ recommended for production).
44+
* **Backups**: Take advantage of Cloudron’s built-in backup options to safeguard your NocoDB data.
45+
* **Maintenance**: Regularly update both NocoDB and Cloudron to stay current with security patches and new features.

content/self-hosting/installation/heroku.mdx

Lines changed: 0 additions & 150 deletions
This file was deleted.

content/self-hosting/installation/k8s.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ tags: ['kubernets', 'k8s']
44
keywords: ['Kubernets']
55
---
66

7+
This guide provides a starting point for deploying NocoDB using Kubernetes.
8+
79
## Prerequisites
810

911
- k8s cluster

content/self-hosting/installation/meta.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@
1717
"gcp-cloud-run",
1818
"railway",
1919
"cloudron",
20-
"heroku",
2120

2221
"nginx",
2322
"apache",
Lines changed: 9 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,14 @@
11
---
22
title: 'Other Installation Methods'
3-
description: 'Installing NocoDB on other platforms'
43
tags: ['Open Source']
5-
keywords : ['NocoDB installation', 'NocoDB Digital Ocean installation', 'NocoDB prerequisites']
4+
keywords : ['NocoDB installation' ]
65
---
76

8-
This guide covers installation methods for NocoDB on various platforms including Cloudron, CapRover, Railway, FreeBSD/FreeNAS/TrueNAS Jail, and SealOs.
7+
This guide covers installation methods for NocoDB on various platforms including, CapRover, FreeBSD/FreeNAS/TrueNAS Jail, and SealOs.
98

10-
### Cloudron
9+
## CapRover
1110

12-
Cloudron provides an easy way to install and manage NocoDB.
13-
14-
#### Installation Steps
15-
16-
1. Log in to your Cloudron dashboard.
17-
2. Navigate to the App Store.
18-
19-
![Cloudron App Store](/img/v2/installations/cloudron-app-store.png)
20-
3. Search for NocoDB
21-
22-
![Cloudron Search NocoDB](/img/v2/installations/cloudron-search-nocodb.png)
23-
4. Click on the NocoDB app, then click "Install".
24-
25-
![Cloudron Install](/img/v2/installations/cloudron-install.png)
26-
5. Configure NocoDB settings as needed.
27-
28-
![Cloudron Configure](/img/v2/installations/cloudron-configure.png)
29-
5. Once installed, go to "My Apps" and launch NocoDB.
30-
31-
![Cloudron My Apps](/img/v2/installations/cloudron-my-apps.png)
32-
33-
#### Important Notes
34-
- Ensure your Cloudron server meets the minimum requirements for running NocoDB.
35-
- Configure backups for your NocoDB instance through Cloudron's backup system.
36-
- Keep your Cloudron and NocoDB app up to date for the latest features and security patches.
37-
38-
### CapRover
39-
40-
#### Deployment Steps
11+
### Deployment Steps
4112

4213
1. Log in to your CapRover dashboard.
4314
2. Go to "Apps" and click on "One-Click Apps/Databases".
@@ -52,45 +23,26 @@ Cloudron provides an easy way to install and manage NocoDB.
5223
![CapRover Deploy](/img/v2/installations/caprover-deploy.png)
5324
6. Once deployed, you can access NocoDB from the provided URL.
5425

55-
#### Important Notes
26+
### Important Notes
5627
- Ensure your CapRover server has sufficient resources to run NocoDB.
5728
- Configure persistent storage for your NocoDB data.
5829
- Set up SSL for secure access to your NocoDB instance.
5930
- Regularly update your CapRover server and NocoDB app for the latest features and security patches.
6031

61-
### Railway
62-
63-
#### Deployment Steps
64-
65-
1. Go to Railway Templates.
66-
2. Search for "NocoDB" in the templates list.
67-
68-
![Railway Templates](/img/v2/installations/railway-templates.png)
69-
3. Click on the NocoDB template, then click "Deploy".
70-
4. Configure your NocoDB settings as needed.
7132

72-
![Railway Configure](/img/v2/installations/railway-configure.png)
73-
5. Railway will automatically deploy your NocoDB instance.
74-
75-
#### Important Notes
76-
- Make sure to configure environment variables for database connections if needed.
77-
- Set up persistent storage for your NocoDB data.
78-
- Regularly update your NocoDB instance for the latest features and security patches.
79-
80-
### FreeBSD/FreeNAS/TrueNAS Jail Installation
33+
## FreeBSD/FreeNAS/TrueNAS Jail Installation
8134

8235
For detailed instructions on installing NocoDB on FreeBSD, FreeNAS, or TrueNAS Jail, please refer to the [guide](https://gist.github.com/Zamana/e9281d736f9e9ce5882c6f4b140a590e) provided by [C. R. Zamana.](https://github.com/Zamana)
8336

8437

85-
### Sealos
38+
## Sealos
8639

8740
[![Deploy on Sealos](/img/v2/installations/sealos.svg)](https://cloud.sealos.io/?openapp=system-template%3FtemplateName%3Dnocodb)
8841

89-
### Elestio
42+
## Elestio
9043

9144
[![Deploy on Elestio](/img/v2/installations/deploy-to-elestio-btn.png)](https://elest.io/open-source/nocodb)
9245

93-
### RepoCloud
46+
## RepoCloud
9447

9548
[![Deploy on RepoCloud](/img/v2/installations/repo-cloud.png)](https://repocloud.io/details/?app_id=100)
96-

content/self-hosting/installation/railway.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,11 @@ To run NocoDB reliably:
3636
* Upgrade to the **Hobby plan** or higher.
3737
* Plans with at least **1 GB RAM** are recommended for stable performance.
3838

39+
## Important Notes
40+
- Make sure to configure environment variables for database connections if needed.
41+
- Set up persistent storage or S3 for your NocoDB data.
42+
- Regularly update your NocoDB instance for the latest features and security patches.
43+
3944
## You're Live 🎉
4045

4146
That’s it! NocoDB should now be running on Railway. You can begin creating APIs from your database, importing spreadsheets, or managing data collaboratively.

0 commit comments

Comments
 (0)