mirror of
https://github.com/nocodb/nocodb.git
synced 2026-04-30 21:16:51 +00:00
chore: updating docs - installation
This commit is contained in:
Naveen MR
@@ -10,12 +10,11 @@ link: https://codesandbox.io/embed/vigorous-firefly-80kq5?hidenavigation=1&theme
|
||||
Simple installation - takes about three minutes!
|
||||
|
||||
## Prerequisites
|
||||
- Must haves
|
||||
- [Node.js with version >= 14](https://nodejs.org/en/download) / [Docker](https://www.docker.com/get-started)
|
||||
- [Docker](https://www.docker.com/get-started) or [Node.js](https://nodejs.org/en/download) ( > v14.x )
|
||||
|
||||
## Quick try
|
||||
|
||||
### 1-Click Deploy to Heroku
|
||||
### Heroku
|
||||
|
||||
Before doing so, make sure you have a Heroku account. By default, an add-on Heroku Postgres will be used as meta database. You can see the connection string defined in `DATABASE_URL` by navigating to Heroku App Settings and selecting Config Vars.
|
||||
|
||||
@@ -27,6 +26,115 @@ Before doing so, make sure you have a Heroku account. By default, an add-on Hero
|
||||
/>
|
||||
</a>
|
||||
|
||||
### Docker
|
||||
|
||||
If you are a Docker user, you may try this way!
|
||||
|
||||
<code-group>
|
||||
<code-block label="SQLite" active>
|
||||
|
||||
```bash
|
||||
docker run -d --name nocodb \
|
||||
-v "$(pwd)"/nocodb:/usr/app/data/ \
|
||||
-p 8080:8080 \
|
||||
nocodb/nocodb:latest
|
||||
```
|
||||
|
||||
</code-block>
|
||||
|
||||
<code-block label="MySQL">
|
||||
|
||||
```bash
|
||||
docker run -d --name nocodb-mysql \
|
||||
-v "$(pwd)"/nocodb:/usr/app/data/ \
|
||||
-p 8080:8080 \
|
||||
-e NC_DB="mysql2://host.docker.internal:3306?u=root&p=password&d=d1" \
|
||||
-e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \
|
||||
nocodb/nocodb:latest
|
||||
```
|
||||
|
||||
</code-block>
|
||||
|
||||
<code-block label="Postgres">
|
||||
|
||||
```bash
|
||||
docker run -d --name nocodb-postgres \
|
||||
-v "$(pwd)"/nocodb:/usr/app/data/ \
|
||||
-p 8080:8080 \
|
||||
-e NC_DB="pg://host.docker.internal:5432?u=root&p=password&d=d1" \
|
||||
-e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \
|
||||
nocodb/nocodb:latest
|
||||
```
|
||||
|
||||
</code-block>
|
||||
|
||||
<code-block label="SQL Server">
|
||||
|
||||
```bash
|
||||
docker run -d --name nocodb-mssql \
|
||||
-v "$(pwd)"/nocodb:/usr/app/data/ \
|
||||
-p 8080:8080 \
|
||||
-e NC_DB="mssql://host.docker.internal:1433?u=root&p=password&d=d1" \
|
||||
-e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \
|
||||
nocodb/nocodb:latest
|
||||
```
|
||||
|
||||
</code-block>
|
||||
</code-group>
|
||||
|
||||
<alert type="success">
|
||||
Tip 1: To persist data in docker you can mount volume at `/usr/app/data/` since 0.10.6. In older version mount at `/usr/src/app`. Otherwise your data will be lost after recreating the container.
|
||||
</alert>
|
||||
|
||||
<alert type="success">
|
||||
Tip 2: If you plan to input some special characters, you may need to change the character set and collation yourself when creating the database. Please check out the examples for <a href="https://github.com/nocodb/nocodb/issues/1340#issuecomment-1049481043" target="_blank">MySQL Docker</a>.
|
||||
</alert>
|
||||
|
||||
### Docker Compose
|
||||
|
||||
We provide different docker-compose.yml files under <a href="https://github.com/nocodb/nocodb/tree/master/docker-compose" target="_blank">this directory</a>. Here are some examples.
|
||||
|
||||
<code-group>
|
||||
<code-block label="MySQL" active>
|
||||
|
||||
```bash
|
||||
git clone https://github.com/nocodb/nocodb
|
||||
cd nocodb/docker-compose/mysql
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
</code-block>
|
||||
|
||||
<code-block label="Postgres">
|
||||
|
||||
```bash
|
||||
git clone https://github.com/nocodb/nocodb
|
||||
cd nocodb/docker-compose/pg
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
</code-block>
|
||||
|
||||
<code-block label="SQL Server">
|
||||
|
||||
```bash
|
||||
git clone https://github.com/nocodb/nocodb
|
||||
cd nocodb/docker-compose/mssql
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
</code-block>
|
||||
</code-group>
|
||||
|
||||
<alert type="success">
|
||||
Tip 1: To persist data in docker you can mount volume at `/usr/app/data/` since 0.10.6. In older version mount at `/usr/src/app`.
|
||||
</alert>
|
||||
|
||||
<alert type="success">
|
||||
Tip 2: If you plan to input some special characters, you may need to change the character set and collation yourself when creating the database. Please check out the examples for <a href="https://github.com/nocodb/nocodb/issues/1313#issuecomment-1046625974" target="_blank">MySQL Docker Compose</a>.
|
||||
</alert>
|
||||
|
||||
|
||||
### NPX
|
||||
|
||||
You can run below command if you need an interactive configuration.
|
||||
@@ -40,16 +148,6 @@ npx create-nocodb-app
|
||||
<img width="587" alt="image" src="https://user-images.githubusercontent.com/35857179/161526235-5ee0d592-0105-4a57-aa53-b1048dca6aad.png">
|
||||
|
||||
|
||||
### Node Application
|
||||
|
||||
We provide a simple NodeJS Application for getting started.
|
||||
|
||||
```bash
|
||||
git clone https://github.com/nocodb/nocodb-seed
|
||||
cd nocodb-seed
|
||||
npm install
|
||||
npm start
|
||||
```
|
||||
|
||||
### Homebrew
|
||||
|
||||
@@ -108,113 +206,18 @@ iwr http://get.nocodb.com/win-arm64.exe
|
||||
.\Noco-win-arm64.exe
|
||||
```
|
||||
|
||||
### Docker
|
||||
### Node Application
|
||||
|
||||
If you are a Docker user, you may try this way!
|
||||
We provide a simple NodeJS Application for getting started.
|
||||
|
||||
<code-group>
|
||||
<code-block label="SQLite" active>
|
||||
```bash
|
||||
git clone https://github.com/nocodb/nocodb-seed
|
||||
cd nocodb-seed
|
||||
npm install
|
||||
npm start
|
||||
```
|
||||
|
||||
```bash
|
||||
docker run -d --name nocodb \
|
||||
-v "$(pwd)"/nocodb:/usr/app/data/ \
|
||||
-p 8080:8080 \
|
||||
nocodb/nocodb:latest
|
||||
```
|
||||
|
||||
</code-block>
|
||||
|
||||
<code-block label="MySQL">
|
||||
|
||||
```bash
|
||||
docker run -d --name nocodb-mysql \
|
||||
-v "$(pwd)"/nocodb:/usr/app/data/ \
|
||||
-p 8080:8080 \
|
||||
-e NC_DB="mysql2://host.docker.internal:3306?u=root&p=password&d=d1" \
|
||||
-e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \
|
||||
nocodb/nocodb:latest
|
||||
```
|
||||
|
||||
</code-block>
|
||||
|
||||
<code-block label="Postgres">
|
||||
|
||||
```bash
|
||||
docker run -d --name nocodb-postgres \
|
||||
-v "$(pwd)"/nocodb:/usr/app/data/ \
|
||||
-p 8080:8080 \
|
||||
-e NC_DB="pg://host.docker.internal:5432?u=root&p=password&d=d1" \
|
||||
-e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \
|
||||
nocodb/nocodb:latest
|
||||
```
|
||||
|
||||
</code-block>
|
||||
|
||||
<code-block label="SQL Server">
|
||||
|
||||
```bash
|
||||
docker run -d --name nocodb-mssql \
|
||||
-v "$(pwd)"/nocodb:/usr/app/data/ \
|
||||
-p 8080:8080 \
|
||||
-e NC_DB="mssql://host.docker.internal:1433?u=root&p=password&d=d1" \
|
||||
-e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \
|
||||
nocodb/nocodb:latest
|
||||
```
|
||||
|
||||
</code-block>
|
||||
</code-group>
|
||||
|
||||
<alert type="success">
|
||||
Tip 1: To persist data in docker you can mount volume at `/usr/app/data/` since 0.10.6. In older version mount at `/usr/src/app`. Otherwise your data will be lost after recreating the container.
|
||||
</alert>
|
||||
|
||||
<alert type="success">
|
||||
Tip 2: If you plan to input some special characters, you may need to change the character set and collation yourself when creating the database. Please check out the examples for <a href="https://github.com/nocodb/nocodb/issues/1340#issuecomment-1049481043" target="_blank">MySQL Docker</a>.
|
||||
</alert>
|
||||
|
||||
### Docker Compose
|
||||
|
||||
We provide different docker-compose.yml files under <a href="https://github.com/nocodb/nocodb/tree/master/docker-compose" target="_blank">this directory</a>. Here are some examples.
|
||||
|
||||
<code-group>
|
||||
<code-block label="MySQL" active>
|
||||
|
||||
```bash
|
||||
git clone https://github.com/nocodb/nocodb
|
||||
cd nocodb/docker-compose/mysql
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
</code-block>
|
||||
|
||||
<code-block label="Postgres">
|
||||
|
||||
```bash
|
||||
git clone https://github.com/nocodb/nocodb
|
||||
cd nocodb/docker-compose/pg
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
</code-block>
|
||||
|
||||
<code-block label="SQL Server">
|
||||
|
||||
```bash
|
||||
git clone https://github.com/nocodb/nocodb
|
||||
cd nocodb/docker-compose/mssql
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
</code-block>
|
||||
</code-group>
|
||||
|
||||
<alert type="success">
|
||||
Tip 1: To persist data in docker you can mount volume at `/usr/app/data/` since 0.10.6. In older version mount at `/usr/src/app`.
|
||||
</alert>
|
||||
|
||||
<alert type="success">
|
||||
Tip 2: If you plan to input some special characters, you may need to change the character set and collation yourself when creating the database. Please check out the examples for <a href="https://github.com/nocodb/nocodb/issues/1313#issuecomment-1046625974" target="_blank">MySQL Docker Compose</a>.
|
||||
</alert>
|
||||
|
||||
## Production Setup
|
||||
It is mandatory to configure `NC_DB` environment variables for production usecases.
|
||||
@@ -361,9 +364,6 @@ aws ecs create-service \
|
||||
If your service fails to start, you may check the logs in ECS console or in Cloudwatch. Generally it fails due to the connection between ECS container and NC_DB. Make sure the security groups have the correct inbound and outbound rules.
|
||||
</alert>
|
||||
|
||||
## Development Setup
|
||||
Please refer to [Development Setup](https://docs-dev.nocodb.com/engineering/development-setup).
|
||||
|
||||
## Sample Demos
|
||||
|
||||
### Code Sandbox
|
||||
|
||||
Reference in New Issue
Block a user