Browse Source

docs: updated procedure for connecting to ext-db

pull/4716/head
Raju Udava 2 years ago committed by GitHub
parent
commit
21ce5716c0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 34
      packages/noco-docs/content/en/setup-and-usages/dashboard.md

34
packages/noco-docs/content/en/setup-and-usages/dashboard.md

@ -22,32 +22,42 @@ Enter your work email and your password.
Once you have logged into NocoDB, you should see `My Projects`. Once you have logged into NocoDB, you should see `My Projects`.
<img width="1494" alt="image" src="https://user-images.githubusercontent.com/35857179/194793424-c4451bf5-1486-46cf-b62f-86fc6d788d77.png"> ![Screenshot 2022-12-29 at 2 54 43 PM](https://user-images.githubusercontent.com/86527202/209932699-743ffea2-986f-443f-8198-f56b597de706.png)
<!-- <img width="1494" alt="image" src="https://user-images.githubusercontent.com/35857179/194793424-c4451bf5-1486-46cf-b62f-86fc6d788d77.png"> -->
To create a project, you can click `New Project`. You can choose create an empty project or a project connecting to an external database. To create a new project, you can click `New Project`.
<!-- <img width="1492" alt="image" src="https://user-images.githubusercontent.com/35857179/194793457-e18e1112-2b44-4efc-8d98-5261a83a150c.png"> -->
<img width="1492" alt="image" src="https://user-images.githubusercontent.com/35857179/194793457-e18e1112-2b44-4efc-8d98-5261a83a150c.png">
### Creating Empty Project 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.
Click `Create Project`, 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.
<alert> <alert>
NC_DB is an environment variable used to store the meta data in the given database. NC_DB is an environment variable used to store the meta data in the given database.
</alert> </alert>
<img width="1496" alt="image" src="https://user-images.githubusercontent.com/35857179/194793478-a4c20517-1c38-474d-8905-d1d3da560136.png"> ![Screenshot 2022-12-29 at 2 54 57 PM](https://user-images.githubusercontent.com/86527202/209932936-8fe7334c-1a94-4073-ba19-478efb620808.png)
<!-- <img width="1496" alt="image" src="https://user-images.githubusercontent.com/35857179/194793478-a4c20517-1c38-474d-8905-d1d3da560136.png"> -->
### Connecting to External Database ### Connecting to External Database
Click `Create By Connecting To An External Database`, you need to specify the project name, API type, and other database parameters. Click on three-dot menu adjacent to `BASES`. Pick required database option from the menu `Connect to new datasource`.
<alert type="success"> <alert type="success">
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. 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.
</alert> </alert>
<img width="1500" alt="image" src="https://user-images.githubusercontent.com/35857179/194793497-3b740bf2-ffc7-48bf-836e-e4cd26631568.png">
<!-- <img width="1500" alt="image" src="https://user-images.githubusercontent.com/35857179/194793497-3b740bf2-ffc7-48bf-836e-e4cd26631568.png"> -->
![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.
![Screenshot 2022-12-29 at 3 16 36 PM](https://user-images.githubusercontent.com/86527202/209936942-f82a293f-2e91-48da-b9cd-79ec143d7d6f.png)
You need to specify the project name, API type, and other database parameters.
![Screenshot 2022-12-29 at 2 56 25 PM](https://user-images.githubusercontent.com/86527202/209933326-e76eee13-4942-4ba8-b184-a28099c089ab.png)
Currently it supports MySQL, Postgres, MSSQL and SQLite. Currently it supports MySQL, Postgres, MSSQL and SQLite.
You can also configure associated SSL & advanced parameters. You can also configure associated SSL & advanced parameters.

Loading…
Cancel
Save