diff --git a/packages/noco-docs/content/en/getting-started/installation.md b/packages/noco-docs/content/en/getting-started/installation.md index 2e75b8574a..9db5254941 100644 --- a/packages/noco-docs/content/en/getting-started/installation.md +++ b/packages/noco-docs/content/en/getting-started/installation.md @@ -276,93 +276,142 @@ It is mandatory to configure `NC_DB` environment variables for production usecas ### AWS ECS (Fargate) -#### Create ECS Cluster +
+ Click to Expand -``` -aws ecs create-cluster \ ---cluster-name -``` + #### Create ECS Cluster -#### Create Log group + ``` + aws ecs create-cluster \ + --cluster-name + ``` -``` -aws logs create-log-group \ ---log-group-name /ecs// -``` + #### Create Log group -#### Create ECS Task Definiton + ``` + aws logs create-log-group \ + --log-group-name /ecs// + ``` -Every time you create it, it will add a new version. If it is not existing, the version will be 1. + #### Create ECS Task Definiton -```bash -aws ecs register-task-definition \ ---cli-input-json "file://./.json" -``` + Every time you create it, it will add a new version. If it is not existing, the version will be 1. - -This json file defines the container specification. You can define secrets such as NC_DB and environment variables here. - + ```bash + aws ecs register-task-definition \ + --cli-input-json "file://./.json" + ``` -Here's the sample Task Definition - -```json -{ - "family": "nocodb-sample-task-def", - "networkMode": "awsvpc", - "containerDefinitions": [{ - "name": "", - "image": "nocodb/nocodb:latest", - "essential": true, - "logConfiguration": { - "logDriver": "awslogs", - "options": { - "awslogs-group": "/ecs//", - "awslogs-region": "", - "awslogs-stream-prefix": "ecs" - } - }, - "secrets": [{ - "name": "", - "valueFrom": "" - }], - "environment": [{ - "name": "", - "value": "" - }], - "portMappings": [{ - "containerPort": 8080, - "hostPort": 8080, - "protocol": "tcp" - }] - }], - "requiresCompatibilities": [ - "FARGATE" - ], - "cpu": "256", - "memory": "512", - "executionRoleArn": "", - "taskRoleArn": "" -} -``` + + This json file defines the container specification. You can define secrets such as NC_DB and environment variables here. + + + Here's the sample Task Definition + + ```json + { + "family": "nocodb-sample-task-def", + "networkMode": "awsvpc", + "containerDefinitions": [{ + "name": "", + "image": "nocodb/nocodb:latest", + "essential": true, + "logConfiguration": { + "logDriver": "awslogs", + "options": { + "awslogs-group": "/ecs//", + "awslogs-region": "", + "awslogs-stream-prefix": "ecs" + } + }, + "secrets": [{ + "name": "", + "valueFrom": "" + }], + "environment": [{ + "name": "", + "value": "" + }], + "portMappings": [{ + "containerPort": 8080, + "hostPort": 8080, + "protocol": "tcp" + }] + }], + "requiresCompatibilities": [ + "FARGATE" + ], + "cpu": "256", + "memory": "512", + "executionRoleArn": "", + "taskRoleArn": "" + } + ``` -#### Create ECS Service + #### Create ECS Service -```bash -aws ecs create-service \ ---cluster \ ---service-name \ ---task-definition : \ ---desired-count \ ---launch-type "FARGATE" \ ---platform-version \ ---health-check-grace-period-seconds \ ---network-configuration "awsvpcConfiguration={subnets=[""], securityGroups=[""], assignPublicIp=ENABLED}" \ ---load-balancer targetGroupArn=,containerName=,containerPort= -``` + ```bash + aws ecs create-service \ + --cluster \ + --service-name \ + --task-definition : \ + --desired-count \ + --launch-type "FARGATE" \ + --platform-version \ + --health-check-grace-period-seconds \ + --network-configuration "awsvpcConfiguration={subnets=[""], securityGroups=[""], assignPublicIp=ENABLED}" \ + --load-balancer targetGroupArn=,containerName=,containerPort= + ``` + + + 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. + + ``` + +
+ +### DigitalOcean (App) + +
+ Click to Expand + + #### Create Apps + + On Home page, Click on Create icon & Select Apps (Deploy your code). + + ![Screenshot 2022-02-19 at 12 17 43 PM](https://user-images.githubusercontent.com/86527202/154790558-f8fe5580-5a58-412c-9c2e-145587712bf2.png) + + #### Choose Source: Docker Hub + + ![Screenshot 2022-02-19 at 12 22 01 PM](https://user-images.githubusercontent.com/86527202/154790563-b5b6d5b4-0bdc-4718-8cea-0a7ee52f283b.png) + + #### Choose Source: Repository + + Configure Source Repository as `nocodb/nocodb`. Optionally you can pick release tag if you are interested in specific NocoDB version. + + ![Screenshot 2022-02-19 at 12 23 11 PM](https://user-images.githubusercontent.com/86527202/154790564-1dcb5e33-3a57-471a-a44c-835a410a0cb7.png) + + #### [Optional] Additional Configurations + + ![Screenshot 2022-02-19 at 12 24 44 PM](https://user-images.githubusercontent.com/86527202/154790565-c0234b2e-ad50-4042-90b6-4f8798f1d585.png) + + #### Name your web service + Pick a name for your NocoDB application. This name will become part of URL subsequently + Pick nearest Region for cloud hosting + ![Screenshot 2022-02-19 at 12 28 11 PM](https://user-images.githubusercontent.com/86527202/154790567-a6e65e4e-9aa0-4edb-998e-da8803ad6e23.png) + + #### Finalize and Launch + + - Select hosting plan for your NocoDB application + + - Click "Launch APP" + + ![Screenshot 2022-02-19 at 12 29 23 PM](https://user-images.githubusercontent.com/86527202/154790570-62044713-5cca-4d06-82ec-f3cc257218a1.png) + + Application will be build & URL will be live in a minute! The URL will be something like https://simply-nocodb-rsyir.ondigitalocean.app/ + +
- - 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. - ## Sample Demos