mirror of
https://github.com/nocodb/nocodb.git
synced 2026-04-25 06:36:34 +00:00
update readme instructions
This commit is contained in:
@@ -1,4 +1,4 @@
|
|||||||
# Install full stack nocodb with Docker (compose)
|
# Install all-in-one nocodb with Docker (compose)
|
||||||
|
|
||||||
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
|
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
|
- nocodb
|
||||||
@@ -17,7 +17,7 @@ TIP: you could simply run [./pre-req-check.sh](./pre-req-check.sh) which perform
|
|||||||
|
|
||||||
## Install
|
## Install
|
||||||
Run [install.sh](./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 no external integration required. The defaults properties are just fine.
|
||||||
```
|
```
|
||||||
./install.sh
|
./install.sh
|
||||||
```
|
```
|
||||||
@@ -36,7 +36,7 @@ Note: For most cases where any external integration is not required. The default
|
|||||||
| Press Y to continue or N to skip (Y/N)?
|
| Press Y to continue or N to skip (Y/N)?
|
||||||
Preparing environment file before install..
|
Preparing environment file before install..
|
||||||
| Press Y to continue with defaults or N to customise app properties (Y/N)
|
| 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
|
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.
|
Environment variables written to docker-compose/aio/conf/nc_properties.env file.
|
||||||
Installing docker containers
|
Installing docker containers
|
||||||
```
|
```
|
||||||
@@ -59,8 +59,11 @@ During installation the default properties are configured at [nc_properties.env]
|
|||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
## Read below, if you wish to understand what does install.sh do
|
## what does install.sh do
|
||||||
install script performs the following steps
|
[Install script](./install.sh) 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.
|
||||||
3. runs docker-compose up -d
|
3. runs docker-compose up -d
|
||||||
|
|
||||||
|
## Advanced Operations
|
||||||
|
Refer [advanced secion](./advanced.md) for advanced operations like setting up ssl, updating configurations, restarts etc
|
||||||
|
|||||||
@@ -21,10 +21,10 @@ Below are different approaches to get and configure certificates. Make your choi
|
|||||||
### letsencrypt for generating certificates
|
### letsencrypt for generating certificates
|
||||||
Certificates/key can be obtained by trusted CA (Certificate Authorities), there are many paid vendors found online or you can also use [letsencrypt](https://letsencrypt.org/) a non profit certificate provider for free however we recommend [https://www.abetterinternet.org/donate/](donate) for their service.
|
Certificates/key can be obtained by trusted CA (Certificate Authorities), there are many paid vendors found online or you can also use [letsencrypt](https://letsencrypt.org/) a non profit certificate provider for free however we recommend [https://www.abetterinternet.org/donate/](donate) for their service.
|
||||||
|
|
||||||
### Bring your own certificates
|
### [TBD] Bring your own certificates
|
||||||
If you already have the certificates, either self signed or generated by any other means, you will need to configure them with nginx. Below are the steps
|
If you already have the certificates, either self signed or generated by any other means, you will need to configure them with nginx. Below are the steps
|
||||||
TBD
|
|
||||||
### self signed certificates
|
### [TBD] Self signed certificates
|
||||||
One of the pre-requisite is that your server should be associated with the domain name. In the absence of that you could use self signed certificates which does ecrypt but browsers show warning.
|
One of the pre-requisite is that your server should be associated with the domain name. In the absence of that you could use self signed certificates which does ecrypt but browsers show warning.
|
||||||
|
|
||||||
## Database password rotation
|
## Database password rotation
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ bkp_file=${ENV_FILE}-$(date +%s).bak
|
|||||||
# Source existing nc_envs.env file to get current values
|
# Source existing nc_envs.env file to get current values
|
||||||
if [ -f ${ENV_FILE} ]; then
|
if [ -f ${ENV_FILE} ]; then
|
||||||
source ${ENV_FILE}
|
source ${ENV_FILE}
|
||||||
echo "backing up previous ${ENV_FILE} file to ${bkp_file}"
|
echo "Backing up previous ${ENV_FILE} file to ${bkp_file}"
|
||||||
cp ${ENV_FILE} ${bkp_file}
|
cp ${ENV_FILE} ${bkp_file}
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user