mirror of https://github.com/nocodb/nocodb
Raju Udava
1 year ago
28 changed files with 323 additions and 303 deletions
@ -1,36 +1,54 @@
|
||||
--- |
||||
title: 'Base overview' |
||||
description: 'This article explains the concept of bases in NocoDB.' |
||||
tags: ['bases', 'base overview', 'base dashboard', 'base collaboration', 'base actions', 'delete base'] |
||||
keywords: ['NocoDB base', 'base overview', 'base dashboard', 'base collaboration', 'base actions', 'delete base', 'base management', 'base administration', 'base settings', 'base organization'] |
||||
--- |
||||
|
||||
In NocoDB, bases are the foundational elements that encompass tables, views, forms, reports, dashboards, and automations, providing a structured framework for data organization and collaborative work. It's essential to understand that each base is inherently tied to a specific workspace and cannot be transferred between different workspaces. The creator of a base is designated as the 'base owner,' and this ownership status is non-transferable, conferring exclusive authority over the base, including the ability to delete it. |
||||
|
||||
Bases are the core building blocks of NocoDB. A base is a collection of tables, views, forms, reports, dashboards, and automations. You can create multiple bases to organize your data and collaborators. Some of the key points to note about bases are: |
||||
- A base can be a part of only one workspace & cannot be moved between workspaces. |
||||
- Creator of a base is the `base owner`. There can be only one `base owner` (non-transferable). |
||||
- Only base owner has the authority to delete a base. |
||||
- Each base has its own set of collaborators and access permissions. |
||||
- Collaborator permissions at base level carry higher precedence than workspace level permissions. |
||||
- There is no limit to the number of collaborators you can invite to your base. |
||||
- There is no limit to the number of tables you can create within a base. |
||||
Bases also come with their unique set of collaborators and access permissions, which take precedence over any permissions set at the workspace level. This fine-grained control allows for tailored collaboration and data management within each base. Importantly, there are no restrictions on the number of collaborators you can invite to a base, fostering open teamwork. Similarly, you have the freedom to create as many tables as needed within a single base, offering the scalability required to accommodate diverse datasets and projects. |
||||
|
||||
[//]: # (Bases are the core building blocks of NocoDB. A base is a collection of tables, views, forms, reports, dashboards, and automations. You can create multiple bases to organize your data and collaborators. Some of the key points to note about bases are:) |
||||
[//]: # (- A base can be a part of only one workspace & cannot be moved between workspaces.) |
||||
[//]: # (- Creator of a base is the `base owner`. There can be only one `base owner` (non-transferable).) |
||||
[//]: # (- Only base owner has the authority to delete a base.) |
||||
[//]: # (- Each base has its own set of collaborators and access permissions.) |
||||
[//]: # (- Collaborator permissions at base level carry higher precedence than workspace level permissions.) |
||||
[//]: # (- There is no limit to the number of collaborators you can invite to your base.) |
||||
[//]: # (- There is no limit to the number of tables you can create within a base.) |
||||
|
||||
## Base Dashboard |
||||
|
||||
Base dashboard is the landing page for a base. It provides a quick overview of the base. It also provides quick access to base settings & collaborations. Click on the base name in the left sidebar **<1>** to open the base dashboard **<2>**. |
||||
The Base Dashboard serves as the primary landing page for a base, offering users a concise summary of its contents and functionality. This central hub provides users with swift access to essential features such as base settings and collaboration tools. To access the Base Dashboard, simply click on the base name located in the left sidebar. |
||||
|
||||
 |
||||
|
||||
Base dashboard has the following sections: |
||||
### Table List |
||||
List of tables in the base. Click on the table name to open the table. A base can consist of tables residing in external data sources as well. They are highlighted accordingly in the table list. |
||||
### Base Collaborators |
||||
List of collaborators in the base along with their current permission levels. Workspace collaborators inherit their access permissions to the base. Base owner can modify the permissions of collaborators at base level (either bump up or bump down). Additional details will be dealt with in section [Base Collaborations](/docs/040.bases/075.base-collaboration.md). |
||||
### Data Sources |
||||
NocoDB allows you to connect to external data sources & work with them as if they are native tables. List of connected data sources are listed here. Additional details will be dealt with in section [Data Sources](/docs/050.data-sources/010.data-sources-overview.md). |
||||
The Base Dashboard is organized into three key sections, each serving a distinct purpose: |
||||
|
||||
1. **Table List**: This section provides a comprehensive list of all tables within the base, including those sourced from external data repositories. Users can conveniently access a specific table by clicking on its name. Tables originating from external sources are clearly highlighted in the list for easy identification. |
||||
|
||||
2. **Base Collaborators**: In this section, users can view a roster of collaborators associated with the base, along with their respective permission levels. It's worth noting that collaborators who are part of the workspace automatically inherit access permissions at the base level. However, the base owner retains the ability to adjust these permissions, either increasing or decreasing them. Further details on collaboration management can be found in the dedicated [Base Collaborations](base-collaboration) section. |
||||
|
||||
3. **Data Sources**: NocoDB offers the functionality to connect with external data sources and seamlessly integrate them as native tables. This section provides a listing of connected data sources, setting the stage for additional details on this feature, which will be covered in the forthcoming [Data Sources](/data-source/data-source-overview) section. This feature empowers users to work with external data as effortlessly as with in-house data tables, enhancing the versatility and scope of data management within the base. |
||||
|
||||
|
||||
[//]: # (Base dashboard has the following sections:) |
||||
[//]: # (### Table List) |
||||
[//]: # (List of tables in the base. Click on the table name to open the table. A base can consist of tables residing in external data sources as well. They are highlighted accordingly in the table list. ) |
||||
[//]: # (### Base Collaborators) |
||||
[//]: # (List of collaborators in the base along with their current permission levels. Workspace collaborators inherit their access permissions to the base. Base owner can modify the permissions of collaborators at base level (either bump up or bump down). Additional details will be dealt with in section [Base Collaborations](/docs/040.bases/075.base-collaboration.md).) |
||||
[//]: # (### Data Sources) |
||||
[//]: # (NocoDB allows you to connect to external data sources & work with them as if they are native tables. List of connected data sources are listed here. Additional details will be dealt with in section [Data Sources](/docs/050.data-sources/010.data-sources-overview.md).) |
||||
|
||||
## Related articles |
||||
- [Create base](/bases/create-base) |
||||
- [Create base using template](/bases/create-base-using-template) |
||||
- [Base overview](/bases/base-overview) |
||||
- [Create an empty base](/bases/create-base) |
||||
- [Import base from Airtable](/bases/import-base-from-airtable) |
||||
- [Base collaboration](/bases/base-collaboration) |
||||
- [Share base](/bases/share-base) |
||||
- [Base actions](/bases/actions-on-base) |
||||
- [Delete base](/bases/delete-base) |
||||
- [Invite team members to work on a base](/bases/base-collaboration) |
||||
- [Share base publicly](/bases/share-base) |
||||
- [Rename base](/bases/actions-on-base#rename-base) |
||||
- [Duplicate base](/bases/actions-on-base#duplicate-base) |
||||
- [Bookmark base](/bases/actions-on-base#star-base) |
||||
- [Delete base](/bases/actions-on-base#delete-base) |
||||
|
||||
|
||||
@ -1,27 +1,35 @@
|
||||
--- |
||||
title: 'Create base' |
||||
description: 'Create a new base in NocoDB.' |
||||
tags: ['bases', 'create base'] |
||||
keywords: ['NocoDB base', 'create base', 'base context menu', 'base owner', 'base collaboration', 'base actions', 'base settings', 'base administration', 'base organization'] |
||||
--- |
||||
|
||||
|
||||
## Create base from scratch |
||||
1. Click on `+` on the left sidebar next to `projects` OR click on `+ New Project` button on the left sidebar. |
||||
2. Fill in the name of the base in the pop-up modal. |
||||
3. Click on `Create Database` button. |
||||
|
||||
To initiate the creation of a new database from the ground up, follow these steps: |
||||
1. Navigate to the left sidebar and either select the `+` icon adjacent to `Projects` or click on the `+ New Project` button. |
||||
2. Input the desired name for the database within the presented pop-up modal. |
||||
3. Conclude the process by clicking on the `Create Database` button. |
||||
|
||||
 |
||||
 |
||||
 |
||||
 |
||||
|
||||
:::info |
||||
- You will be marked as `base owner` on creation of the base. |
||||
- Only `base owner` has the authority to delete a base. |
||||
- You can create multiple bases within a workspace. |
||||
- Upon the creation of the base, you will assume the role of the `base owner.` |
||||
- Only the `base owner` possesses the authority to delete a base. |
||||
- It is possible to create multiple bases within a single workspace. |
||||
::: |
||||
|
||||
On the successful creation of a base, you will be directed to the Base Dashboard, which serves as the primary landing page for the base. This central hub provides users with swift access to essential features such as base settings and collaboration tools. To access the Base Dashboard, simply click on the base name located in the left sidebar. |
||||
|
||||
Find more details on adding tables to a base in the [Tables](/tables/create-table) section. |
||||
|
||||
## Related articles |
||||
- [Base overview](/bases/base-overview) |
||||
- [Create base using template](/bases/create-base-using-template) |
||||
- [Import base from Airtable](/bases/import-base-from-airtable) |
||||
- [Base collaboration](/bases/base-collaboration) |
||||
- [Share base](/bases/share-base) |
||||
- [Base actions](/bases/actions-on-base) |
||||
- [Delete base](/bases/delete-base) |
||||
- [Invite team members to work on a base](/bases/base-collaboration) |
||||
- [Share base publicly](/bases/share-base) |
||||
- [Rename base](/bases/actions-on-base#rename-base) |
||||
- [Duplicate base](/bases/actions-on-base#duplicate-base) |
||||
- [Bookmark base](/bases/actions-on-base#star-base) |
||||
- [Delete base](/bases/actions-on-base#delete-base) |
||||
|
||||
@ -0,0 +1,100 @@
|
||||
--- |
||||
title: 'Import Airtable to NocoDB' |
||||
description: 'A complete import of your Airtable to any MySQL, Postgres, SQLite and SQL server databases within minutes' |
||||
--- |
||||
|
||||
NocoDB offers a streamlined process for seamlessly transferring your Airtable database to various database management systems, including MySQL, Postgres and SQLite, in just a matter of minutes. This feature is particularly useful for users who wish to migrate their Airtable database to a more robust and scalable database management system. |
||||
|
||||
:::info |
||||
Import from Airtable is in beta version. See [Importing Airtable To NocoDB](https://github.com/nocodb/nocodb/discussions/2122) for the migration notes. |
||||
::: |
||||
|
||||
:::info |
||||
To proceed, you must have valid Airtable Credentials. Ensure you have access to the following information from your Airtable account: |
||||
- [API key](#retrieve-api-key) or [Personal Access Token](#create-personal-access-token) |
||||
- [Shared Base ID / URL](#retrieve-share-base-id--url) |
||||
::: |
||||
|
||||
Below are 3 simple steps |
||||
|
||||
1. Go to your Base dashboard, click on `Import Data` |
||||
|
||||
 |
||||
2. Select `Airtable` |
||||
|
||||
 |
||||
3. Import configurations |
||||
1. [API key](#retrieve-api-key) / [Personal Access Token](#create-personal-access-token) |
||||
2. [Shared Base ID / URL](#retrieve-share-base-id--url) |
||||
3. [Configuration options](#configuration-options) [**Optional**] |
||||
4. Click `Import` |
||||
|
||||
 |
||||
|
||||
:::info |
||||
Wait until `Go To Dashboard` button is activated on the modal. Import details are captured in log window. |
||||
::: |
||||
|
||||
 |
||||
|
||||
[//]: # () |
||||
|
||||
### Configuration options |
||||
1. **Import Data**: You have the option to disable this feature to import only the schema information of tables and views, excluding actual data records. |
||||
2. **Import Secondary Views**: If you disable this option, only the primary grid view for each table will be imported, omitting any secondary views. |
||||
3. **Import Rollup Columns**: By deactivating this choice, you can skip the import of Rollup columns, which aggregate data from other columns. |
||||
4. **Import Lookup Columns**: You can choose not to import Lookup columns by disabling this option. Lookup columns are used to reference data from another table. |
||||
5. **Import Attachments Columns**: Disable this option if you wish to exclude the import of Attachment columns, which typically store file attachments associated with records. |
||||
6. **Import Formula Columns**: Please be aware that this option is not currently available for use, and therefore, cannot be selected for import at this time. |
||||
|
||||
|
||||
## Get Airtable Credentials |
||||
|
||||
### Create Personal Access Token |
||||
Here are the steps to generate an Airtable Personal Access Token: |
||||
|
||||
1. Visit the [Airtable Create Tokens](https://airtable.com/create/tokens) page and click the "Create token" button. |
||||
2. Provide a meaningful name for your token in the `Token name` field. |
||||
3. Choose the necessary access scopes, with a minimum requirement of `data.records:read`. |
||||
4. Select the specific Base you wish to access with this token. |
||||
5. Confirm your choices by clicking the `Create token` button. |
||||
6. Copy the newly generated `Personal Access Token` for your use. |
||||
|
||||
For detailed information, you can refer to the [Airtable Personal Access Token guide](https://airtable.com/developers/web/guides/personal-access-tokens). |
||||
|
||||
 |
||||
 |
||||
 |
||||
|
||||
### Retrieve API Key |
||||
- Copy your Airtable API Key from [Airtable Accounts](https://airtable.com/account) page |
||||
 |
||||
|
||||
### Retrieve Share Base ID / URL |
||||
|
||||
See [here](https://support.airtable.com/hc/en-us/articles/205752117-Creating-a-base-share-link-or-a-view-share-link#basesharelink) for detailed procedures. |
||||
|
||||
1. Open `Share` menu in your Project / Base |
||||
2. Open tab `Share Publicly` |
||||
3. Enable `Turn on full base access` |
||||
4. Copy generated shared base URL |
||||
|
||||
 |
||||
|
||||
[//]: # ( ) |
||||
[//]: # ( ) |
||||
|
||||
|
||||
## Related articles |
||||
- [Base overview](/bases/base-overview) |
||||
- [Create an empty base](/bases/create-base) |
||||
- [Import base from Airtable](/bases/import-base-from-airtable) |
||||
- [Invite team members to work on a base](/bases/base-collaboration) |
||||
- [Share base publicly](/bases/share-base) |
||||
- [Rename base](/bases/actions-on-base#rename-base) |
||||
- [Duplicate base](/bases/actions-on-base#duplicate-base) |
||||
- [Bookmark base](/bases/actions-on-base#star-base) |
||||
- [Delete base](/bases/actions-on-base#delete-base) |
||||
|
||||
|
||||
|
||||
@ -0,0 +1,28 @@
|
||||
--- |
||||
title: 'Base Collaboration' |
||||
description: 'Invite team members to work on a base' |
||||
tags: ['bases', 'base collaboration'] |
||||
keywords: ['NocoDB base', 'base collaboration', 'base context menu', 'base owner', 'base collaboration', 'base actions', 'base settings', 'base administration', 'base organization'] |
||||
--- |
||||
|
||||
A member added to a workspace will carry his assigned role specific permissions to all the base with in workspace. To override collaborator permissions to your base, please follow the clear steps outlined below: |
||||
|
||||
1. Go to the left sidebar and select `Base name` to access the `Base Dashboard.` |
||||
2. Click on the `Members` tab. |
||||
3. Use the dropdown menu to specify the access permissions for the member you wish to collaborate. |
||||
4. Finalize the process by assigning the desired role to the user. |
||||
|
||||
 |
||||
|
||||
More details about roles & permissions can be found [here](/roles-and-permissions/overview). |
||||
|
||||
## Related articles |
||||
- [Base overview](/bases/base-overview) |
||||
- [Create an empty base](/bases/create-base) |
||||
- [Import base from Airtable](/bases/import-base-from-airtable) |
||||
- [Invite team members to work on a base](/bases/base-collaboration) |
||||
- [Share base publicly](/bases/share-base) |
||||
- [Rename base](/bases/actions-on-base#rename-base) |
||||
- [Duplicate base](/bases/actions-on-base#duplicate-base) |
||||
- [Bookmark base](/bases/actions-on-base#star-base) |
||||
- [Delete base](/bases/actions-on-base#delete-base) |
||||
@ -1,13 +0,0 @@
|
||||
--- |
||||
title: 'Create base using template' |
||||
--- |
||||
|
||||
|
||||
## Related articles |
||||
- [Base overview](/bases/base-overview) |
||||
- [Create base](/bases/create-base) |
||||
- [Import base from Airtable](/bases/import-base-from-airtable) |
||||
- [Base collaboration](/bases/base-collaboration) |
||||
- [Share base](/bases/share-base) |
||||
- [Base actions](/bases/actions-on-base) |
||||
- [Delete base](/bases/delete-base) |
||||
@ -0,0 +1,101 @@
|
||||
--- |
||||
title: "Share Base" |
||||
description: "Procedures to share a base & generating embedded iframe" |
||||
tags: ["bases", "share base"] |
||||
keywords: ["NocoDB base", "share base", "base collaboration", "base actions", "base settings"] |
||||
--- |
||||
|
||||
To share a base, follow the steps below: |
||||
1. Navigate to the top right corner of the top navigation bar and click on the `Share` button. |
||||
2. In the `Shared base` section, toggle the switch to `Enable public access` in order to activate the shared base feature. |
||||
3. The generated link for the shared base will be displayed above and can be utilized to share this project with others. To copy the URL, simply click on the `Copy Link` option. |
||||
|
||||
 |
||||
 |
||||
 |
||||
|
||||
[//]: # () |
||||
[//]: # () |
||||
[//]: # () |
||||
|
||||
|
||||
## Modify Share base |
||||
Amending the `Share base` setting will render the previously generated `Share base` link invalid and generate a new link in its place. |
||||
Here are the steps to modify it: |
||||
1. Click on the `Share` button located in the top right corner of the toolbar. |
||||
2. Toggle the option labeled `Enable public access` to deactivate the base share. |
||||
3. Toggle the same option, `Enable public access,` to reactivate the base share, subsequently generating a new link. |
||||
|
||||
|
||||
## Disable Share base |
||||
Disabling `Share base` will render the previously generated `Share base` link invalid |
||||
Here are the steps to disable it: |
||||
1. Click on the 'Share' button located in the top right corner of the toolbar. |
||||
2. Toggle the option labeled `Enable public access` to deactivate the base share. |
||||
|
||||
 |
||||
|
||||
## Share base Access Permissions |
||||
The "Shared base" can be configured in two modes: |
||||
|
||||
1. **Viewer** - Users with the provided link will have **read-only** access to the base data. |
||||
2. **Editor** - Users with the provided link will have **read and write** access to the base data. |
||||
|
||||
Toggle `Enable Editor Access` button to configure permissions as desired |
||||
 |
||||
|
||||
|
||||
## Embeddable Frame |
||||
|
||||
The NocoDB interface can be seamlessly integrated into existing applications through the utilization of the [HTML IFRAME](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe) attribute. This feature empowers users to embed the NocoDB interface into their applications, allowing for a unified user experience. To generate the embeddable HTML code, follow these steps: |
||||
|
||||
**To Generate Embeddable HTML Code:** |
||||
1. Click the `Share` button located in the top right corner of the toolbar. |
||||
2. Within the `Shared base link` tab, select the button to copy the `Embeddable HTML code` to your clipboard. |
||||
|
||||
 |
||||
|
||||
Example: |
||||
|
||||
```html |
||||
<iframe |
||||
class="nc-embed" |
||||
src="https://nocodb-nocodb-rsyir.ondigitalocean.app/dashboard/#/nc/base/e3bba9df-4fc1-4d11-b7ce-41c4a3ad6810?embed" |
||||
frameBorder="0" |
||||
width="100%" |
||||
height="700" |
||||
style="background: transparent; border: 1px solid #ddd" |
||||
> |
||||
</iframe> |
||||
``` |
||||
|
||||
### Embed into application's HTML Body |
||||
|
||||
Sample code with embedded iframe generated above |
||||
|
||||
```html |
||||
<!DOCTYPE html> |
||||
<html> |
||||
<body> |
||||
<iframe |
||||
class="nc-embed" |
||||
src="http://localhost:3000/#/nc/base/7d4b551c-b5e0-41c9-a87b-f3984c21d2c7?embed" |
||||
frameBorder="0" |
||||
width="100%" |
||||
height="700" |
||||
style="background: transparent; " |
||||
></iframe> |
||||
</body> |
||||
</html> |
||||
``` |
||||
|
||||
## Related articles |
||||
- [Base overview](/bases/base-overview) |
||||
- [Create an empty base](/bases/create-base) |
||||
- [Import base from Airtable](/bases/import-base-from-airtable) |
||||
- [Invite team members to work on a base](/bases/base-collaboration) |
||||
- [Share base publicly](/bases/share-base) |
||||
- [Rename base](/bases/actions-on-base#rename-base) |
||||
- [Duplicate base](/bases/actions-on-base#duplicate-base) |
||||
- [Bookmark base](/bases/actions-on-base#star-base) |
||||
- [Delete base](/bases/actions-on-base#delete-base) |
||||
@ -1,86 +0,0 @@
|
||||
--- |
||||
title: 'Import Airtable to NocoDB' |
||||
description: 'A complete import of your Airtable to any MySQL, Postgres, SQLite and SQL server databases within minutes' |
||||
--- |
||||
|
||||
|
||||
|
||||
|
||||
NocoDB allows a complete import of your Airtable base to any MySQL, Postgres, SQLite and SQL server databases within minutes. |
||||
|
||||
:::info |
||||
Import from Airtable is in beta version. See [Importing Airtable To NocoDB](https://github.com/nocodb/nocodb/discussions/2122) for the migration notes. |
||||
::: |
||||
|
||||
## Import Airtable to NocoDB |
||||
|
||||
:::info |
||||
Prerequisites: <br/> - A NocoDB Base <br/> - Airtable Credentials |
||||
You need to have access to `API key` / `Personal Access Token` and `Shared Base ID` / `Shared Base URL` from Airtable. |
||||
::: |
||||
|
||||
|
||||
Below are 3 simple steps |
||||
|
||||
1. Go to your Base dashboard, click on `Import Data` |
||||
 |
||||
2. Select `Airtable` |
||||
 |
||||
3. Input API key & Shared Base ID / URL (retrieved from `Get Airtable Credentials` detailed below). |
||||
a. API Key |
||||
b. Share Base ID |
||||
c. Configuration option |
||||
`Import Data`: disable this option to import only table & view schema's |
||||
`Import Secondary Views`: disable this option to import only primary grid view per table |
||||
`Import Rollup Columns`: disable this option to skip Rollup column import |
||||
`Import Lookup Columns`: disable this option to skip Lookup column import |
||||
`Import Attachments Columns`: disable this option to skip Attachment column import |
||||
`Import Formula Columns`: disable this option to skip Formula column import (Not available yet) |
||||
|
||||
 |
||||
4. Click `Import` and you will see the status |
||||
5. Wait until `Go To Dashboard` button is activated on the modal. Import details are captured in log window. |
||||
 |
||||
|
||||
|
||||
## Get Airtable Credentials |
||||
|
||||
### Create Personal Access Token |
||||
Reference: [Airtable Personal Access Token](https://airtable.com/developers/web/guides/personal-access-tokens) |
||||
1. Go to [Airtable Create Tokens](https://airtable.com/create/tokens) page, click on `Create token` button |
||||
2. Input `Token name` |
||||
3. Select `Scopes` (`data.records:read` is required) |
||||
4. Select `Base` that you want to import |
||||
5. Click on `Create token` button |
||||
6. Copy generated `Personal Access Token` |
||||
|
||||
 |
||||
 |
||||
 |
||||
|
||||
### Retrieve API Key |
||||
- Copy your Airtable API Key from [Airtable Accounts](https://airtable.com/account) page |
||||
 |
||||
|
||||
### Retrieve Share Base ID / URL |
||||
|
||||
See [here](https://support.airtable.com/hc/en-us/articles/205752117-Creating-a-base-share-link-or-a-view-share-link#basesharelink) for detailed procedures. |
||||
|
||||
1. Open `Share` menu in your Project / Base |
||||
 |
||||
2. Open tab `Share Publicly` |
||||
3. Enable `Turn on full base access` |
||||
4. Copy generated shared base URL |
||||
 |
||||
|
||||
|
||||
## Related articles |
||||
- [Base overview](/bases/base-overview) |
||||
- [Create base](/bases/create-base) |
||||
- [Create base using template](/bases/create-base-using-template) |
||||
- [Base collaboration](/bases/base-collaboration) |
||||
- [Share base](/bases/share-base) |
||||
- [Base actions](/bases/actions-on-base) |
||||
- [Delete base](/bases/delete-base) |
||||
|
||||
|
||||
@ -1,26 +0,0 @@
|
||||
--- |
||||
title: 'Base Collaboration' |
||||
--- |
||||
|
||||
|
||||
Invite collaborators to your base by following simple steps below: |
||||
1. Click on `Base name` on the left sidebar to open `Base Dashboard`. |
||||
2. Select `Collaborators` tab. |
||||
3. Fill in the email address of the collaborator you want to invite. |
||||
4. Select the access permission for the collaborator from the dropdown menu. |
||||
5. Click on `Add User(s)` button. |
||||
|
||||
 |
||||
|
||||
:::info |
||||
You can invite multiple collaborators at once by entering multiple email addresses separated by comma. |
||||
::: |
||||
|
||||
## Related articles |
||||
- [Base overview](/bases/base-overview) |
||||
- [Create base](/bases/create-base) |
||||
- [Create base using template](/bases/create-base-using-template) |
||||
- [Import base from Airtable](/bases/import-base-from-airtable) |
||||
- [Share base](/bases/share-base) |
||||
- [Base actions](/bases/actions-on-base) |
||||
- [Delete base](/bases/delete-base) |
||||
@ -1,101 +0,0 @@
|
||||
--- |
||||
title: "Share Base" |
||||
description: "Procedures to share a base & generating embedded iframe" |
||||
--- |
||||
|
||||
## Generate Share base |
||||
|
||||
- Open Project |
||||
- Click on `Share` button to the top right in the top navigation bar |
||||
|
||||
 |
||||
|
||||
- Under `Shared base` section and toggle `Enable public access` to enable shared base |
||||
|
||||
 |
||||
|
||||
- Share base link generated is displayed over & can be used to share this project to others. Click `Copy Link` to copy URL |
||||
|
||||
 |
||||
|
||||
|
||||
## Modify Share base |
||||
|
||||
Modifying `Share base` will invalidate the `Share base` link generated previously and will generate a new link. |
||||
|
||||
- Open Project base |
||||
- Click on 'Share' button on top right tool bar |
||||
- Toggle ``Enable public access`` to disable base share |
||||
- Toggle ``Enable public access`` to re-enable base share & generate a new link |
||||
|
||||
|
||||
## Disable Share base |
||||
|
||||
Disabling `Share base` will invalidate the generated `Share base` link |
||||
|
||||
- Open Project base |
||||
- Click on 'Share' button on top right tool bar |
||||
- Toggle ``Enable public access`` to disable base share |
||||
|
||||
## Share base Access Permissions |
||||
|
||||
Shared base can be configured as |
||||
|
||||
- Viewer - User with the link will get **READ ONLY** access to the project data. |
||||
- Editor - User with the link will get **READ & WRITE** access to the project data. |
||||
|
||||
Toggle `Enable Editor Access` button to configure permissions as desired |
||||
|
||||
## Embeddable Frame |
||||
|
||||
NocoDB interface can be embedded into existing applications easily by making use of [HTML IFRAME](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe)) attribute. |
||||
|
||||
### Generate embeddable HTML code |
||||
|
||||
- Open Project base |
||||
- Click on 'Share' button on top right tool bar |
||||
- Under 'Shared base link' tab |
||||
- Click on button to copy 'Embeddable HTML code' |
||||
|
||||
Example: |
||||
|
||||
```html |
||||
<iframe |
||||
class="nc-embed" |
||||
src="https://nocodb-nocodb-rsyir.ondigitalocean.app/dashboard/#/nc/base/e3bba9df-4fc1-4d11-b7ce-41c4a3ad6810?embed" |
||||
frameBorder="0" |
||||
width="100%" |
||||
height="700" |
||||
style="background: transparent; border: 1px solid #ddd" |
||||
> |
||||
</iframe> |
||||
``` |
||||
|
||||
### Embed into application's HTML Body |
||||
|
||||
Sample code with embedded iframe generated above |
||||
|
||||
```html |
||||
<!DOCTYPE html> |
||||
<html> |
||||
<body> |
||||
<iframe |
||||
class="nc-embed" |
||||
src="http://localhost:3000/#/nc/base/7d4b551c-b5e0-41c9-a87b-f3984c21d2c7?embed" |
||||
frameBorder="0" |
||||
width="100%" |
||||
height="700" |
||||
style="background: transparent; " |
||||
></iframe> |
||||
</body> |
||||
</html> |
||||
``` |
||||
|
||||
## Related articles |
||||
- [Base overview](/bases/base-overview) |
||||
- [Create base](/bases/create-base) |
||||
- [Create base using template](/bases/create-base-using-template) |
||||
- [Import base from Airtable](/bases/import-base-from-airtable) |
||||
- [Base collaboration](/bases/base-collaboration) |
||||
- [Base actions](/bases/actions-on-base) |
||||
- [Delete base](/bases/delete-base) |
||||
@ -1,33 +0,0 @@
|
||||
--- |
||||
title: 'Delete base' |
||||
--- |
||||
|
||||
|
||||
If you determine that a base is no longer necessary, you have the option to permanently remove it from your workspace. Deleting a base will delete all the tables and data associated with it. |
||||
|
||||
:::danger |
||||
**This action cannot be undone.** |
||||
::: |
||||
|
||||
:::info |
||||
Only **base owner** can delete a workspace. |
||||
::: |
||||
|
||||
To delete a base: |
||||
|
||||
1. Open `base context menu` by clicking on the ellipses `...` next to base name` on the left sidebar. |
||||
2. From the dropdown, select `Delete` option. |
||||
3. Click on `Delete base` button on the confirmation dialog box. |
||||
|
||||
 |
||||
|
||||
 |
||||
|
||||
## Related articles |
||||
- [Base overview](/bases/base-overview) |
||||
- [Create base](/bases/create-base) |
||||
- [Create base using template](/bases/create-base-using-template) |
||||
- [Import base from Airtable](/bases/import-base-from-airtable) |
||||
- [Base collaboration](/bases/base-collaboration) |
||||
- [Share base](/bases/share-base) |
||||
- [Base actions](/bases/actions-on-base) |
||||
@ -1,5 +1,5 @@
|
||||
--- |
||||
title: 'Data Sources' |
||||
title: 'Data Sources overview' |
||||
description: 'NocoDB Data-Source sync, access control & re-config' |
||||
--- |
||||
|
||||
|
After Width: | Height: | Size: 63 KiB |
|
After Width: | Height: | Size: 188 KiB |
|
After Width: | Height: | Size: 110 KiB |
|
After Width: | Height: | Size: 80 KiB |
|
After Width: | Height: | Size: 59 KiB |
|
After Width: | Height: | Size: 104 KiB |
|
After Width: | Height: | Size: 98 KiB |
|
After Width: | Height: | Size: 55 KiB |
|
After Width: | Height: | Size: 113 KiB |
|
After Width: | Height: | Size: 120 KiB |
|
After Width: | Height: | Size: 30 KiB |
|
After Width: | Height: | Size: 71 KiB |
|
After Width: | Height: | Size: 104 KiB |
|
After Width: | Height: | Size: 58 KiB |
|
After Width: | Height: | Size: 58 KiB |
|
After Width: | Height: | Size: 59 KiB |
Loading…
Reference in new issue