From 74cae0c2a6eddc3fcb7a14bd13300873c88ef8a1 Mon Sep 17 00:00:00 2001 From: Wing-Kam Wong Date: Tue, 5 Apr 2022 13:53:47 +0800 Subject: [PATCH] docs: revise Dashboard Signed-off-by: Wing-Kam Wong --- .../content/en/setup-and-usages/dashboard.md | 69 +++++++++++++++---- 1 file changed, 54 insertions(+), 15 deletions(-) diff --git a/packages/noco-docs/content/en/setup-and-usages/dashboard.md b/packages/noco-docs/content/en/setup-and-usages/dashboard.md index 3b514e4b98..553ad9038c 100644 --- a/packages/noco-docs/content/en/setup-and-usages/dashboard.md +++ b/packages/noco-docs/content/en/setup-and-usages/dashboard.md @@ -6,7 +6,7 @@ category: 'Product' menuTitle: 'Dashboard' --- -## Setup your first super admin +## Setup Your First Super Admin Once you have started NocoDB, you can visit the dashboard via `example.com/dashboard`. @@ -22,7 +22,7 @@ Enter your work email and your password. -## Initialize your first project +## Initialize Your First Project Once you have logged into NocoDB, you should see `My Projects`. @@ -34,15 +34,20 @@ To create a project, you can click `New Project`. -### Creating empty project +### Creating Empty Project + +Click `Create`, you need to specify the project name and API type. + + +A local SQLite will be used. + -Click `Create`, you need to specify the project name and API type. A local SQLite will be used. -### Connecting to external database +### Connecting to External Database -Click `Create By Connecting To An external Datbase`, you need to specify the project name, API type, and other database parameters. +Click `Create By Connecting To An External Database`, you need to specify the project name, API type, and other database parameters. ![image](https://user-images.githubusercontent.com/35857179/126597279-c1722d8b-c885-4e9e-9e94-44711102af20.png) @@ -54,17 +59,53 @@ You can also configure associated SSL & advanced parameters. ![image](https://user-images.githubusercontent.com/35857179/126597342-0c61ab15-a112-4269-8f30-78455fa09081.png) -Click `Test Database Connection` to see if the connection can be established or not. + +Tip 1: You can click Edit Connection JSON and modify SSL settings in "ssl". + -> NocoDB create's a new **empty database** with specified parameters, if the database doesn't exist. +```json +{ + "client": "pg", + "connection": { + "host": "", + "port": "5432", + "user": "", + "password": "", + "database": "", + "ssl": { + "require": true, + "rejectUnauthorized": false, + "sslMode": "no-verify" + } + } +} +``` + + +Tip 2: You can click Edit Connection JSON and specify the schema you want to use in "searchPath". + -### Creating project from Excel +```json +{ + "client": "pg", + "connection": { + ... + }, + "searchPath": [ "" ] +} +``` -Click `Create Project from Excel`, you can either upload/ drag and drop Excel file (OR) specify Excel file URL - - - +Click `Test Database Connection` to see if the connection can be established or not. NocoDB create's a new **empty database** with specified parameters, if the database doesn't exist. + +### Creating Project from Excel +Click `Create Project from Excel`, you can either upload / drag and drop Excel file (OR) specify Excel file URL. + + +A local SQLite will be used. + + + Supported file formats @@ -74,5 +115,3 @@ Supported file formats - Ods - Ots -A local SQLite will be used. -