mirror of https://github.com/nocodb/nocodb
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
110 lines
3.7 KiB
110 lines
3.7 KiB
3 years ago
|
---
|
||
3 years ago
|
title: 'Dashboard'
|
||
3 years ago
|
description: 'Accessing the Dashboard!'
|
||
3 years ago
|
---
|
||
|
|
||
3 years ago
|
## Setup Your First Super Admin
|
||
3 years ago
|
|
||
2 years ago
|
Once you have started NocoDB, you can visit the dashboard via `example.com`. You will be redirected to `example.com/#/signup`.
|
||
3 years ago
|
|
||
|
Enter your work email and your password.
|
||
|
|
||
1 year ago
|
<img width="1492" alt="image" src="https://user-images.githubusercontent.com/35857179/194793294-fa027496-c3c3-44eb-a613-2ba3e3bd26c1.png" />
|
||
2 years ago
|
|
||
1 year ago
|
:::note
|
||
|
|
||
|
Your password has at least 8 letters. No other constraints on case, numbers or special characters.
|
||
|
|
||
|
:::
|
||
3 years ago
|
|
||
3 years ago
|
## Initialize Your First Project
|
||
3 years ago
|
|
||
3 years ago
|
Once you have logged into NocoDB, you should see `My Projects`.
|
||
3 years ago
|
|
||
2 years ago
|
![Screenshot 2022-12-29 at 2 54 43 PM](https://user-images.githubusercontent.com/86527202/209932699-743ffea2-986f-443f-8198-f56b597de706.png)
|
||
1 year ago
|
<!-- <img width="1494" alt="image" src="https://user-images.githubusercontent.com/35857179/194793424-c4451bf5-1486-46cf-b62f-86fc6d788d77.png" /> -->
|
||
3 years ago
|
|
||
2 years ago
|
To create a new project, you can click `New Project`.
|
||
1 year ago
|
<!-- <img width="1492" alt="image" src="https://user-images.githubusercontent.com/35857179/194793457-e18e1112-2b44-4efc-8d98-5261a83a150c.png" /> -->
|
||
3 years ago
|
|
||
2 years ago
|
You need to specify the project name. The data will be stored in `NC_DB`. If it is not specified, a local SQLite will be created and used.
|
||
3 years ago
|
|
||
1 year ago
|
:::note
|
||
|
|
||
2 years ago
|
NC_DB is an environment variable used to store the meta data in the given database.
|
||
1 year ago
|
|
||
|
:::
|
||
3 years ago
|
|
||
2 years ago
|
![Screenshot 2022-12-29 at 2 54 57 PM](https://user-images.githubusercontent.com/86527202/209932936-8fe7334c-1a94-4073-ba19-478efb620808.png)
|
||
1 year ago
|
<!-- <img width="1496" alt="image" src="https://user-images.githubusercontent.com/35857179/194793478-a4c20517-1c38-474d-8905-d1d3da560136.png" /> -->
|
||
3 years ago
|
|
||
3 years ago
|
### Connecting to External Database
|
||
3 years ago
|
|
||
2 years ago
|
Click on three-dot menu adjacent to `BASES`. Pick required database option from the menu `Connect to new datasource`.
|
||
3 years ago
|
|
||
1 year ago
|
:::tip
|
||
|
|
||
|
If you are running NocoDB on Docker and your local DB is running on your host machine, your Host Address would be host.docker.internal instead of localhost.
|
||
|
|
||
|
:::
|
||
2 years ago
|
|
||
2 years ago
|
![Screenshot 2022-12-29 at 2 55 39 PM](https://user-images.githubusercontent.com/86527202/209933294-9327ff16-21db-4aca-bf16-8cea8a1eb415.png)
|
||
|
|
||
|
Above menu is also accessible from `Team & Settings` > `Data Sources`. Click on `New` button to add existing database.
|
||
|
|
||
2 years ago
|
![image](https://user-images.githubusercontent.com/35857179/219841162-6456c5cf-fd26-4a88-8de6-e8742c043607.png)
|
||
|
|
||
2 years ago
|
You need to specify the project name, API type, and other database parameters.
|
||
|
|
||
2 years ago
|
![image](https://user-images.githubusercontent.com/35857179/219841283-1a42f9f6-4677-4e25-8ca9-a060753d1e1e.png)
|
||
2 years ago
|
|
||
3 years ago
|
Currently it supports MySQL, Postgres, MSSQL and SQLite.
|
||
|
|
||
3 years ago
|
You can also configure associated SSL & advanced parameters.
|
||
3 years ago
|
|
||
1 year ago
|
<img width="689" alt="image" src="https://user-images.githubusercontent.com/35857179/189047293-05176c44-e162-495a-a7cd-e02377c1f42c.png" />
|
||
|
|
||
|
:::tip
|
||
|
|
||
|
You can click Edit Connection JSON and modify SSL settings in "ssl".
|
||
3 years ago
|
|
||
1 year ago
|
:::
|
||
3 years ago
|
|
||
3 years ago
|
```json
|
||
|
{
|
||
|
"client": "pg",
|
||
|
"connection": {
|
||
|
"host": "<YOUR_HOST>",
|
||
|
"port": "5432",
|
||
|
"user": "<YOUR_DB_USER>",
|
||
|
"password": "<YOUR_DB_PASSWORD>",
|
||
|
"database": "<YOUR_DB_NAME>",
|
||
|
"ssl": {
|
||
|
"require": true,
|
||
|
"rejectUnauthorized": false,
|
||
|
"sslMode": "no-verify"
|
||
|
}
|
||
|
}
|
||
|
}
|
||
|
```
|
||
|
|
||
1 year ago
|
:::tip
|
||
|
|
||
|
You can click Edit Connection JSON and specify the schema you want to use in "searchPath".
|
||
|
|
||
|
:::
|
||
3 years ago
|
|
||
3 years ago
|
```json
|
||
|
{
|
||
|
"client": "pg",
|
||
|
"connection": {
|
||
|
...
|
||
|
},
|
||
|
"searchPath": [ "<YOUR_TARGET_SCHEMA>" ]
|
||
|
}
|
||
|
```
|
||
3 years ago
|
|
||
3 years ago
|
Click `Test Database Connection` to see if the connection can be established or not. NocoDB creates a new **empty database** with specified parameters if the database doesn't exist.
|
||
3 years ago
|
|
||
1 year ago
|
<img width="505" alt="image" src="https://user-images.githubusercontent.com/35857179/194793513-feabf14f-1f62-4896-b06d-88548251511a.png" />
|