Skip to content

Commit a02fb90

Browse files
sinanmohdsinanmohd
committed
chore(self-hosting): clean up
1 parent b889261 commit a02fb90

24 files changed

+181
-403
lines changed

‎content/self-hosting/installation/apache.mdx‎ renamed to ‎content/self-hosting/apache.mdx‎

File renamed without changes.

‎content/self-hosting/installation/aws-ecs.mdx‎ renamed to ‎content/self-hosting/aws-ecs.mdx‎

File renamed without changes.

‎content/self-hosting/installation/cloudron.mdx‎ renamed to ‎content/self-hosting/cloudron.mdx‎

File renamed without changes.

‎content/self-hosting/environment-variables.mdx‎ renamed to ‎content/self-hosting/configuring-nocodb.mdx‎

Lines changed: 50 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
2-
title: 'Environment variables'
3-
description: 'Environment Variables for NocoDB!'
2+
title: 'Configuring NocoDB'
43
tags: [ 'Open Source' ]
54
keywords: [ 'NocoDB Environment Variables', 'NocoDB env variables', 'NocoDB envs', 'NocoDB .env' ]
65
---
@@ -19,6 +18,54 @@ performance, security, and functionality of NocoDB.
1918
| `DATABASE_URL_FILE` | No | A path to a file containing a JDBC URL can be specified for the database connection as an alternative to `NC_DB`. | |
2019
| `NC_CONNECTION_ENCRYPT_KEY` | No | The key used to encrypt the credentials of external databases. <br/> **Warning:** Changing this variable may break the application. If you must change it, use the CLI as described in the [NocoDB Secret CLI documentation](/docs/product-docs/data-sources/updating-secret). | Keep connection credentials as plain text in the database if not set. |
2120

21+
## Docker Image Configuration
22+
23+
The NocoDB docker image supports flexible environment variable management across its internal services.
24+
All environment variables that begin with `nc_aio_` are processed by the AIO Docker image itself to control the internal setup and orchestration.
25+
26+
| Variable | Mandatory | Description | Default |
27+
|--------------------------|-----------|---------------------------------------|-----------|
28+
| `nc_aio_minio_enable` | No | enable aio minio for s3 storage | false |
29+
| `nc_aio_redis_enable` | No | enable aio redis for caching | true |
30+
| `nc_aio_postgres_enable` | No | enable aio PostgreSQL | true |
31+
| `nc_aio_ssl_enable` | No | enable ssl | false |
32+
| `nc_aio_ssl_email` | No | email used for ssl | null |
33+
| `nc_aio_ssl_domain` | No | domain to fetch ssl certs for | localhost |
34+
| `nc_aio_worker_enable` | No | enable worker instance | false |
35+
36+
### Shared Variables
37+
38+
* All environment variables except those prefixed with `nc_aio_` are passed **to both the main NocoDB instance and the worker**.
39+
40+
> Example:
41+
>
42+
> ```bash
43+
> -e NC_PUBLIC_URL="https://example.com"
44+
> ```
45+
>
46+
> This will be available in **both** main and worker containers.
47+
48+
### Targeted Variable Injection
49+
50+
The NocoDB docker image supports passing environment variables to individual services using the following prefixes
51+
52+
| Prefix | Targets Service |
53+
| --------------------- | --------------- |
54+
| `nc_aio_pass_main_` | NocoDB (main) |
55+
| `nc_aio_pass_worker_` | Worker process |
56+
| `nc_aio_pass_minio_` | Minio |
57+
| `nc_aio_pass_acme_` | Lego (ACME/SSL) |
58+
59+
These allow fine-grained control over configuration by scoping variables to specific containers managed by the AIO image.
60+
61+
> 🔧 Example:
62+
> To pass `NC_AUTH_JWT_SECRET` only to the main NocoDB instance:
63+
>
64+
> ```bash
65+
> -e nc_aio_pass_main_NC_AUTH_JWT_SECRET="your-secret"
66+
> ```
67+
68+
2269
## Authentication
2370
2471
| Variable | Mandatory | Description | If Not Set |
@@ -157,4 +204,4 @@ has the required permissions. To disable it, set the `NC_DISABLE_PG_DATA_REFLECT
157204
| `AWS_ACCESS_KEY_ID` | No | ***Deprecated***. Please use `LITESTREAM_S3_ACCESS_KEY_ID` instead. | |
158205
| `AWS_SECRET_ACCESS_KEY` | No | ***Deprecated***. Please use `LITESTREAM_S3_SECRET_ACCESS_KEY` instead. | |
159206
| `AWS_BUCKET` | No | ***Deprecated***. Please use `LITESTREAM_S3_BUCKET` instead. | |
160-
| `AWS_BUCKET_PATH` | No | ***Deprecated***. Please use `LITESTREAM_S3_PATH` instead. | |
207+
| `AWS_BUCKET_PATH` | No | ***Deprecated***. Please use `LITESTREAM_S3_PATH` instead. | |

‎content/self-hosting/installation/digital-ocean.mdx‎ renamed to ‎content/self-hosting/digital-ocean.mdx‎

File renamed without changes.

‎content/self-hosting/installation/docker-compose.mdx‎ renamed to ‎content/self-hosting/docker-compose.mdx‎

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,10 @@ import { Tab, Tabs } from 'fumadocs-ui/components/tabs';
88
Docker Compose allows you to define and run multi-container Docker applications. It's a great way to set up NocoDB along with its database in a single configuration file.
99

1010

11-
### Prerequisites
12-
- [Docker](https://www.docker.com/get-started)
11+
## Prerequisites
1312
- [Docker Compose](https://docs.docker.com/compose/install/)
1413

15-
### docker-compose.yml
14+
## docker-compose.yml
1615

1716
<Tabs items={['http', 'https']}>
1817

@@ -63,24 +62,21 @@ volumes:
6362

6463
</Tabs>
6564

66-
## Start nocodb
65+
> If you have other services running on the same server using up port 80,
66+
> see [Behind Traefik section](./traefik) to use HTTPS with NocoDB
6767
68-
```bash
69-
docker-compose up -d
70-
71-
```
72-
> Once the container is running, you can access NocoDB by opening http://localhost in your web browser.
73-
74-
## Stop nocodb
68+
## Start NocoDB
7569

7670
```bash
77-
docker-compose down
71+
docker compose up -d
7872

7973
```
74+
> Once the container is running, you can access NocoDB by opening http://localhost in your web browser.
8075
81-
## Upgrading from a previous version
76+
## Update NocoDB
8277

8378
```bash
8479
docker compose pull
85-
docker-compose up -d
80+
docker compose down
81+
docker compose up -d
8682
```

‎content/self-hosting/docker.mdx‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
---
2+
title: 'Install with Docker'
3+
tags: ['Open Source']
4+
keywords : ['NocoDB installation', 'NocoDB docker installation', 'NocoDB prerequisites']
5+
---
6+
import { Tab, Tabs } from 'fumadocs-ui/components/tabs';
7+
8+
Docker provides an easy way to install and run NocoDB. Follow these steps to get NocoDB up and running using Docker.
9+
NocoDB provides A single image that contains
10+
11+
- 🇳 NocoDB,
12+
- 🐘 PostgreSQL,
13+
- ⚡ Valkey(Redis),
14+
- 🗄 Minio,
15+
- 🌐 nginx gateway.
16+
- 🔒 automated SSL certs and auto renew
17+
18+
## Prerequisites
19+
- [Docker](https://www.docker.com/get-started)
20+
21+
## Normal Installation
22+
> Only use this in production if you have a reverse proxy for TLS encryption
23+
24+
```bash
25+
docker run \
26+
-d \
27+
--name nocodb \
28+
--tmpfs /run:nodev,nosuid,exec,mode=0755 \
29+
-v ./nocodb:/usr/app/data \
30+
-e NC_AUTH_JWT_SECRET="your-super-secret-string" \
31+
-e NC_PUBLIC_URL="__your_nocodb_domain__.com" \
32+
-p 80:8080 \
33+
--restart unless-stopped \
34+
-it nocodb/nocodb:latest
35+
```
36+
37+
## with HTTPS Support
38+
39+
```bash
40+
docker run \
41+
-d \
42+
--name nocodb \
43+
--tmpfs /run:nodev,nosuid,exec,mode=0755 \
44+
-v ./nocodb:/usr/app/data \
45+
-e nc_aio_ssl_domain=example.com \
46+
-e nc_aio_ssl_enable=true \
47+
-e nc_aio_ssl_email=your@mail.com \
48+
-e NC_AUTH_JWT_SECRET="your-super-secret-string" \
49+
-p 80:80 \
50+
-p 443:443 \
51+
--restart unless-stopped \
52+
-it nocodb/nocodb:latest
53+
```
54+
55+
> Read the [Configuring NocoDB section](./configuring-nocodb#docker-image-configuration) to review all supported options
56+
57+
> Once the container is running, you can access NocoDB by opening http://localhost in your web browser.
58+
59+
## Update NocoDB
60+
61+
```bash
62+
docker pull nocodb/nocodb:latest
63+
docker stop nocodb
64+
docker rm nocodb
65+
66+
```
67+
> use the the docker run command to start nocodb again
68+
69+
## Exposed ports on the AIO Image
70+
71+
- 80: https redirect & ssl acme challenge
72+
- 443: https
73+
- 8080: http & ssl acme challenge
74+
- 9000: minio
75+
76+
## Additional Notes
77+
78+
- variables set by aio can be overridden by the end user by using `docker run -e var_name=var_value`
79+
- the code used to build the aio image is publicly available at [github.com/nocodb/nocodb/tree/develop/nix/docker/all_in_one](https://github.com/nocodb/nocodb/tree/develop/nix/docker/all_in_one)

‎content/self-hosting/installation/gcp-cloud-run.mdx‎ renamed to ‎content/self-hosting/gcp-cloud-run.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: 'Install on GCP Cloud Run'
2+
title: 'Install on GCP'
33
tags: ['Open Source']
44
keywords : ['NocoDB installation', 'NocoDB Google Cloud run installation', 'NocoDB prerequisites']
55
---

‎content/self-hosting/index.mdx‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
11
---
2-
title: 'Self-hosting'
3-
description: 'NocoDB Self-hosting Documentation'
4-
icon: 'code'
2+
title: 'Overview'
3+
icon: 'monitor'
54
---
65

7-
## Overview
8-
96
Self-hosting NocoDB allows you to run NocoDB on your own server, giving you full control over your data and infrastructure.
107

118
## Key Features

‎content/self-hosting/installation/docker.mdx‎

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

0 commit comments

Comments
 (0)