This page provides instructions to install nocodb full stack using Docker. The installation will run multiple contianers in single node.
This page provides instructions to install nocodb all-in-one (aio) using Docker-Compse. The installation will run multiple contianers in single node which includes
- nocodb
- postgres
- nginx
- redis
## Prerequisites
## Prerequisites
Before you begin, ensure you have the following prerequisites:
Before you begin, ensure you have the following prerequisites:
@ -9,24 +13,37 @@ Before you begin, ensure you have the following prerequisites:
- Docker-Compose (version 2.17.3 or later)
- Docker-Compose (version 2.17.3 or later)
- Ports 80 and 443 are available
- Ports 80 and 443 are available
TIP: you could simply run ./pre-req-check.sh from this directory which will check.
TIP: you could simply run [./pre-req-check.sh](./pre-req-check.sh) which performs pre-requisite check.
## Install
## Install
Run install.sh, This script performs pre-requisite check, prompts you through required application properties and finally performs `docker-compose up -d`.
Run [install.sh](./install.sh), This script performs pre-requisite check, prompts you through required application properties and finally performs `docker-compose up -d`.
Note: For most cases where any external integration is not required. The defaults properties are just fine.
Note: For most cases where any external integration is not required. The defaults properties are just fine.
```
```
./install.sh
./install.sh
```
```
* At this point, your installation is completed and you should be able to access your nocodb instance *
* At this point, your installation is completed and you should be able to access your nocodb instance *
### An example output will be like below.
### An example output will be like below.
```
```
./install.sh
** Performing nocodb system check and setup. This step may require sudo permissions
| Checking if required tools (docker, docker-compose, jq, lsof) are installed...
| Checking port accessibility...
| Port 80 is free.
| WARNING: Port 443 is in use. Please make sure it is free.
** System check completed successfully. **
** Few pre-requisites are failing. Recommend to resolve and proceed. However you could still proceed to install **
| Press Y to continue or N to skip (Y/N)?
Preparing environment file before install..
| Press Y to continue with defaults or N to customise app properties (Y/N)
backing up previous docker-compose/aio/conf/nc_properties.env file to nocodb/docker-compose/aio/conf/nc_properties.env-1707455571.bak
Environment variables written to docker-compose/aio/conf/nc_properties.env file.
Installing docker containers
```
```
## Data and Conf directories
## Data and Conf directories
This directory acts as the NC_INSTALL_ROOT by default and it will have data, conf directories which are `.gitingore` to avoid accidentlly exposing to git.
This directory acts as the NC_INSTALL_ROOT by default and it will have data, conf directories which are `.gitingore` to avoid accidentlly exposing to git repository.
During installation the default properties are configured at [nc_properties.env](./conf/nc_properties.env) which can be updated if required and restarted
```
```
.
.
@ -47,10 +64,3 @@ install script performs the following steps
1. pre-req-check.sh and warns if there is anything missing which could potentially cause issues at later stage. However it will let you proceed if you wish to.
1. pre-req-check.sh and warns if there is anything missing which could potentially cause issues at later stage. However it will let you proceed if you wish to.
2. create application properties file under conf dir which will then be used for future upgrades etc.
2. create application properties file under conf dir which will then be used for future upgrades etc.
There are atleast 4 main containers which are running as part of this installation through same docker-compose. The same docker-compose can be leveraged to restart any or all of these containers.
There are atleast 4 main containers which are running as part of this installation through same docker-compose. The same docker-compose can be leveraged to restart any or all of these containers.
Use below command to restart all containers\
Use [restart.sh](./bin/restart.sh) or Use below command to restart all containers
``` docker compose restart ```
``` docker compose restart ```
To restart individual containers with name ( names: nocodb, nginx, postgres, redis)\
To restart individual containers with name ( names: nocodb, nginx, postgres, redis)\
@ -38,9 +38,5 @@ There are two main directories where nginx configurations are maintained
- nocodb team managed configurations at [nginx/conf.d](./conf/nginx/conf.d).
- nocodb team managed configurations at [nginx/conf.d](./conf/nginx/conf.d).
[postgres.conf](./data/postgres/postgresql.conf) and [pg_hba.conf](./data/postgres/pg_hba.conf) are created under ./data/postgres directory upon first postgres container creation. The configurations can be updated and restarted continer to take affect.
## Minio integration for resources
## Enable scheduled backups to run nightly on all your instances.