diff --git a/packages/noco-docs/content/en/getting-started/installation.md b/packages/noco-docs/content/en/getting-started/installation.md index 87e072ba3d..51d98198ab 100644 --- a/packages/noco-docs/content/en/getting-started/installation.md +++ b/packages/noco-docs/content/en/getting-started/installation.md @@ -23,6 +23,8 @@ Simple installation - takes about three minutes! ### 1-Click Deploy to 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. + -### Node app / Docker - +### NPX - - +You can run below command if you need an interactive configuration. - ```bash - npx create-nocodb-app - ``` - - - - +```bash +npx create-nocodb-app +``` - ```bash - docker run -d --name nocodb -p 8080:8080 nocodb/nocodb:latest - ``` +#### Preview: - +image - - ```bash - git clone https://github.com/nocodb/nocodb-seed - cd nocodb-seed - npm install - npm start - ``` +### Node Application - - +We provide a simple NodeJS Application for getting started. -> 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`. - +```bash +git clone https://github.com/nocodb/nocodb-seed +cd nocodb-seed +npm install +npm start +``` +### Docker -## Production Setup +If you are a Docker user, you may try this way! -NocoDB requires a database to store metadata of spreadsheets views and external databases. -And connection params for this database can be specified in `NC_DB` environment variable. + + -### Docker + ```bash + docker run -d --name nocodb -p 8080:8080 nocodb/nocodb:latest + ``` + + - - + ```bash docker run -d -p 8080:8080 \ @@ -90,7 +85,7 @@ And connection params for this database can be specified in `NC_DB` environment ```bash docker run -d -p 8080:8080 \ - -e NC_DB="pg://host:port?u=user&p=password&d=database" \ + -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 ``` @@ -101,7 +96,7 @@ And connection params for this database can be specified in `NC_DB` environment ```bash docker run -d -p 8080:8080 \ - -e NC_DB="mssql://host:port?u=user&p=password&d=database" \ + -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 ``` @@ -109,10 +104,63 @@ And connection params for this database can be specified in `NC_DB` environment - -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 MySQL Docker and MySQL Docker Compose. + +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`. + + + +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 MySQL Docker. + + +### Docker Compose + +We provide different docker-compose.yml files under this directory. Here are some examples. + + + + + ```bash + git clone https://github.com/nocodb/nocodb + cd nocodb/docker-compose/mysql + docker-compose up -d + ``` + + + + + + ```bash + git clone https://github.com/nocodb/nocodb + cd nocodb/docker-compose/pg + docker-compose up -d + ``` + + + + + + ```bash + git clone https://github.com/nocodb/nocodb + cd nocodb/docker-compose/mssql + docker-compose up -d + ``` + + + + + +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`. + + + +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 MySQL Docker Compose. +## Production Setup + +By default, sqlite is used for storing meta data. However, you can specify your own database. The connection params for this database can be specified in `NC_DB` environment variable. Moreover, we also provide the below environment variables for configuration. + + ### Environment variables | Variable | Mandatory | Comments | If absent | @@ -149,46 +197,6 @@ If you plan to input some special characters, you may need to change the charact | AWS_BUCKET | No | For Litestream - S3 bucket | If Litestream is configured and NC_DB is not present. SQLite gets backed up to S3 | | AWS_BUCKET_PATH | No | For Litestream - S3 bucket path (like folder within S3 bucket) | If Litestream is configured and NC_DB is not present. SQLite gets backed up to S3 | -### Docker Compose - - - - - ```bash - git clone https://github.com/nocodb/nocodb - cd nocodb - cd docker-compose - cd mysql - docker-compose up -d - ``` - - - - - - ```bash - git clone https://github.com/nocodb/nocodb - cd nocodb - cd docker-compose - cd pg - docker-compose up -d - ``` - - - - - - ```bash - git clone https://github.com/nocodb/nocodb - cd nocodb - cd docker-compose - cd mssql - docker-compose up -d - ``` - - - - ### AWS ECS (Fargate) #### Create ECS Cluster