diff --git a/packages/noco-docs/content/en/developer-resources/accessing-apis.md b/packages/noco-docs/content/en/developer-resources/accessing-apis.md index 713d8d441d..e59d99396e 100644 --- a/packages/noco-docs/content/en/developer-resources/accessing-apis.md +++ b/packages/noco-docs/content/en/developer-resources/accessing-apis.md @@ -18,23 +18,7 @@ Auth Token is a JWT Token generated based on the logged-in user. By default, the ## API Token -NocoDB allows creating API tokens which allow it to be integrated seamlessly with 3rd party apps. API Token is a Nano ID with a length of 40. If you are passing API Token, make sure that the header is called `xc-token`. - -- Open `Project Menu`, click on `Team & Settings` - -image - -- Click `API Tokens Management` tab under `Team & Auth` section - -- Click Add New Token - -![Screenshot 2022-09-14 at 10 20 00 AM](https://user-images.githubusercontent.com/86527202/190062728-9c09934f-b5e4-4fec-b4d2-0cd3648bbb39.png) - -- Type an recognizable name for your token and click `Generate` - -![Screenshot 2022-09-14 at 10 20 10 AM](https://user-images.githubusercontent.com/86527202/190062801-db3fab83-7974-4dfe-9c83-bf0d8a7dba1e.png) - -- Copy API token to your clipboard; use action menu to the right of token list +API tokens allows us to integrate seamlessly with 3rd party apps. See [API Tokens Management](../setup-and-usages/team-and-auth#api-tokens-management) for more. ## Swagger UI diff --git a/packages/noco-docs/content/en/setup-and-usages/account-settings.md b/packages/noco-docs/content/en/setup-and-usages/account-settings.md index 29491b242e..fc9664168d 100644 --- a/packages/noco-docs/content/en/setup-and-usages/account-settings.md +++ b/packages/noco-docs/content/en/setup-and-usages/account-settings.md @@ -54,10 +54,16 @@ Signup without an invitation is disabled by default and can be managed from UI b ## App Store -You can also manage the app store plugins here. - ![image](https://user-images.githubusercontent.com/35857179/203267619-24a8f5f5-1c8c-4419-a7a1-be4377fe6216.png) +We provide different integrations in three main categories. + +| Category | App Name | +|---|---| +| Chat | Microsoft Teams
Discord
Twilio
Whatsapp Twilio
Mattermost
Slack | +| Email | SMTP
MailerSend
AWS SES | +| Storage | AWS S3
Minio
Google Cloud Storage
Spaces
Backblaze B2
Vultr Object Storage
OvhCloud Object Storage
Linode Object Storage
UpCloud Object Storage
Scaleway Object Storage | + ## License You can configure NocoDB Enterprise `License key` here diff --git a/packages/noco-docs/content/en/setup-and-usages/app-store.md b/packages/noco-docs/content/en/setup-and-usages/app-store.md deleted file mode 100644 index 5f8c2852ce..0000000000 --- a/packages/noco-docs/content/en/setup-and-usages/app-store.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: 'Team Settings > App Store' -description: 'NocoDB provides different integrations in three main categories in App Store' -position: 590 -category: 'Product' -menuTitle: 'Team Settings > App Store' ---- - -## Overview - -To access it, click the down arrow button next to Project Name on the top left side, then select `Account Settings` and clicking `App Store`. - -Screenshot 2023-02-07 at 5 14 11 PM | Screenshot 2023-02-07 at 5 14 30 PM -|--|--| - -We provide different integrations in three main categories. - -| Category | App Name | -|---|---| -| Chat | Microsoft Teams
Discord
Twilio
Whatsapp Twilio
Mattermost
Slack | -| Email | SMTP
MailerSend
AWS SES | -| Storage | AWS S3
Minio
Google Cloud Storage
Spaces
Backblaze B2
Vultr Object Storage
OvhCloud Object Storage
Linode Object Storage
UpCloud Object Storage
Scaleway Object Storage | 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 76c833b79d..5483015606 100644 --- a/packages/noco-docs/content/en/setup-and-usages/dashboard.md +++ b/packages/noco-docs/content/en/setup-and-usages/dashboard.md @@ -44,19 +44,16 @@ Click on three-dot menu adjacent to `BASES`. Pick required database option from 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. - - - + ![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) - +![image](https://user-images.githubusercontent.com/35857179/219841162-6456c5cf-fd26-4a88-8de6-e8742c043607.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) +![image](https://user-images.githubusercontent.com/35857179/219841283-1a42f9f6-4677-4e25-8ca9-a060753d1e1e.png) Currently it supports MySQL, Postgres, MSSQL and SQLite. diff --git a/packages/noco-docs/content/en/setup-and-usages/meta-management.md b/packages/noco-docs/content/en/setup-and-usages/meta-management.md index cb496382c2..3c6825bf80 100644 --- a/packages/noco-docs/content/en/setup-and-usages/meta-management.md +++ b/packages/noco-docs/content/en/setup-and-usages/meta-management.md @@ -6,6 +6,8 @@ category: 'Product' menuTitle: 'Team & Settings > Data Sources' --- +## Overview + `Data Sources` sub-menu includes - Database Metadata - UI Access Control @@ -14,46 +16,33 @@ menuTitle: 'Team & Settings > Data Sources' - Edit existing data source configuration - Edit data source visibility options - Note that, currently only one external data source can be added per project. -To access it, click the down arrow button next to Project Name on the top left side, then select `Team & Settings` and clicking `Data Sources`. - - -![Screenshot 2022-12-29 at 4 29 24 PM](https://user-images.githubusercontent.com/86527202/209941906-a9c8d48d-d604-4a2f-8ffb-7a9a494bac6b.png) -![Screenshot 2022-12-29 at 4 27 14 PM](https://user-images.githubusercontent.com/86527202/209941716-70f2aaa7-b035-42b2-835e-eb2ca348be42.png) +## Accessing Data Sources +To access it, click the down arrow button next to Project Name on the top left side, then select `Team & Settings` and clicking `Data Sources`. - - - - -![Screenshot 2022-12-29 at 4 15 00 PM](https://user-images.githubusercontent.com/86527202/209940452-5b867b71-b9f1-4e64-af69-14715ab73be7.png) - +image +![image](https://user-images.githubusercontent.com/35857179/219833316-1fb234f0-583f-4ab8-b8d7-a6e249e7cd97.png) ## Sync Metadata Go to `Data Sources`, click ``Sync Metadata``, you can see your metadata sync status. If it is out of sync, you can sync the schema. See Sync Schema for more.0 -![Screenshot 2022-12-29 at 4 19 35 PM](https://user-images.githubusercontent.com/86527202/209940903-396650b4-e219-494a-863f-c3f1beb51c5e.png) - - - +![image](https://user-images.githubusercontent.com/35857179/219833485-3bcaa6ec-88bc-47cc-b938-5abb4835dc31.png) ## UI Access Control Go to `Data Sources`, click ``UI ACL``, you can control the access to each table by roles. - -![Screenshot 2022-12-29 at 4 20 57 PM](https://user-images.githubusercontent.com/86527202/209941141-deed80a9-7682-48e1-8de9-9c965c990d2d.png) +![image](https://user-images.githubusercontent.com/35857179/219833072-20e9f4ad-fd1c-4e96-9112-6edda1447ec6.png) ## ERD Go to `Data Sources`, click ``ERD``, you can see the ERD of your database. -![Screenshot 2022-12-29 at 4 21 55 PM](https://user-images.githubusercontent.com/86527202/209941168-b53d2898-8448-47fa-a8b3-6f3572f6b3a2.png) - +![image](https://user-images.githubusercontent.com/35857179/219832288-f6266544-a259-4667-95d9-0e5ce7ac5d27.png) ### Junction table names within ERD @@ -61,32 +50,23 @@ Go to `Data Sources`, click ``ERD``, you can see the ERD of your database. - Double click on `Show Columns` to see additional checkboxes get enabled. - Enabling which you should be able to see junction tables and their table names. -Show Junction table names for many to many table +![image](https://user-images.githubusercontent.com/35857179/219832436-9c1311c3-854c-4b31-9c94-8035dfba2a2b.png) ## Edit external database configuration parameters Go to `Data Sources`, click ``Edit``, you can re-configure database credentials. Please make sure database configuration parameters are valid. Any incorrect parameters could lead to schema loss! - -![Screenshot 2022-12-29 at 4 22 08 PM](https://user-images.githubusercontent.com/86527202/209941211-de9670c9-a73c-4719-9957-eeaf05f3a7ee.png) - +![image](https://user-images.githubusercontent.com/35857179/219832592-14209cbf-d980-4e14-9a59-bda1b778a74e.png) ## Unlink data source Go to `Data Sources`, click ``Delete`` against the data source that you wish to un-link. -![Screenshot 2022-12-29 at 4 31 16 PM](https://user-images.githubusercontent.com/86527202/209942178-5ae40f14-0e87-41f7-9630-e2bf6f59a906.png) +![image](https://user-images.githubusercontent.com/35857179/219832810-a3e9ed88-f732-4f30-9228-ff782be0b9d6.png) ## Data source visibility Go to `Data Sources`, toggle ``Radio-button`` against the data source that you wish to hide/un-hide. -![Screenshot 2022-12-29 at 4 31 16 PM 2](https://user-images.githubusercontent.com/86527202/209942198-627f7f14-761b-4709-b9ca-fde5111fa207.png) - - +![image](https://user-images.githubusercontent.com/35857179/219832914-f485099c-423f-4df8-bf00-b509288efe6d.png) \ No newline at end of file diff --git a/packages/noco-docs/content/en/setup-and-usages/project-settings.md b/packages/noco-docs/content/en/setup-and-usages/project-settings.md index 611fa80015..48fce3da98 100644 --- a/packages/noco-docs/content/en/setup-and-usages/project-settings.md +++ b/packages/noco-docs/content/en/setup-and-usages/project-settings.md @@ -14,8 +14,4 @@ Generic project configuration options are retained under `Project Settings` menu Then, under SETTINGS, click `Project Settings`. -## Miscellaneous - -- Enabling, `Show M2M Tables` will show junction tables between many to many tables. - -![Screenshot 2022-12-29 at 7 05 04 PM](https://user-images.githubusercontent.com/86527202/209961654-ffe8ddc6-c7e2-4c0d-9762-2b57fb883cfa.png) +![image](https://user-images.githubusercontent.com/35857179/219830971-9518fa21-a45c-4d49-af3f-2f933d779ecd.png) diff --git a/packages/noco-docs/content/en/setup-and-usages/sync-schema.md b/packages/noco-docs/content/en/setup-and-usages/sync-schema.md index 3ce8c23e98..6257c95974 100644 --- a/packages/noco-docs/content/en/setup-and-usages/sync-schema.md +++ b/packages/noco-docs/content/en/setup-and-usages/sync-schema.md @@ -16,17 +16,19 @@ Below are the steps to sync schema changes. image -### 2. Click `Project Metadata` under SETTINGS, access `Metadata` tab +### 2. Click `Data Source` under SETTINGS, click `Sync Metadata` on the target base -image +![image](https://user-images.githubusercontent.com/35857179/219831352-e6692ba5-5c94-4331-94ce-5796e57f87a1.png) + +![image](https://user-images.githubusercontent.com/35857179/219831634-bbb6f256-45fb-4224-9f82-bc1bed6082db.png) ### 3. Changes carried outside GUI, identified by NocoDB are listed under `Sync state` + - If changes made to the database are not visible, click `Reload` - Identified schema changes are identified for each table in `red` - `Sync now` button gets activated, if Schema changes are identified by NocoDB -![Screenshot 2022-09-13 at 10 42 12 AM](https://user-images.githubusercontent.com/86527202/189814648-ca28f28d-b0ed-4652-a5da-e6472bfd9407.png) - +![image](https://user-images.githubusercontent.com/35857179/219831855-bcac229c-41b6-4689-b7e1-c3cdfe23a0a1.png) ### 4. Click `Sync Now` to complete Schema sync procedure diff --git a/packages/noco-docs/content/en/setup-and-usages/team-and-auth.md b/packages/noco-docs/content/en/setup-and-usages/team-and-auth.md index b6baf4bc04..4fba8a7900 100644 --- a/packages/noco-docs/content/en/setup-and-usages/team-and-auth.md +++ b/packages/noco-docs/content/en/setup-and-usages/team-and-auth.md @@ -6,18 +6,21 @@ category: 'Product' menuTitle: 'Team & Settings > Team & Auth' --- -# Accessing Team & Auth +## Accessing Team & Auth - Click on `Team & Settings` from the `Project Menu` - Access `Team & Auth` under `Settings` image -## How to Add a User +## User Management + +### How to Add a User 1. Go to `Team & Auth`, click on `Invite Team` -image +![image](https://user-images.githubusercontent.com/35857179/219830800-481f372f-86b1-4e2f-865d-3fb7c10663f7.png) + 2. Enter the user's `E-mail`. Select `User Role`, and Click `Invite`. @@ -32,18 +35,16 @@ If you do not have an SMTP sender configured, make sure to copy the invite link ![Screenshot 2022-09-13 at 10 54 22 AM](https://user-images.githubusercontent.com/86527202/189817156-f3dab634-dc25-4f9b-8126-865187aae254.png) -## How to Update user permissions +### How to Update user permissions 1. Use `Edit` <1> menu to assign a different role to existing user 2. Use `Delete` <2> menu to remove a user from accessing current project -![Screenshot 2022-09-13 at 11 06 16 AM](https://user-images.githubusercontent.com/86527202/189818302-80a05245-9dc1-4364-b380-7bd698e5b9e0.png) - +![image](https://user-images.githubusercontent.com/35857179/219830858-be7a4656-9f3b-440c-9a79-165f919223d7.png) ------ - -# User Role Permissions +### User Role Permissions ### Advanced Options & Configurations |                                                     |     Owner    |     Creator     |     Editor    | Commenter |     Viewer    | @@ -106,6 +107,25 @@ If you do not have an SMTP sender configured, make sure to copy the invite link | Project Info | ✅ | ✅ | ✅ | ✅ | ✅ | | Swagger API | ✅ | ✅ | ✅ | ✅ | ✅ | +## API Tokens Management + +NocoDB allows creating API tokens which allow it to be integrated seamlessly with 3rd party apps. API Token is a Nano ID with a length of 40. If you are passing API Token, make sure that the header is called `xc-token`. + +- Open `Project Menu`, click on `Team & Settings` + +image + +- Click `API Tokens Management` tab under `Team & Auth` section + +- Click Add New Token + +![image](https://user-images.githubusercontent.com/35857179/219835108-037127bd-4bf6-4d96-b691-139bd141631c.png) + +- Type an recognizable name for your token and click `Generate` + +![Screenshot 2022-09-14 at 10 20 10 AM](https://user-images.githubusercontent.com/86527202/190062801-db3fab83-7974-4dfe-9c83-bf0d8a7dba1e.png) + +- Copy API token to your clipboard; use action menu to the right of token list + --> \ No newline at end of file