diff --git a/packages/noco-docs/docs/020.getting-started/020.quick-start.md b/packages/noco-docs/docs/020.getting-started/020.quick-start.md index e6eefa63d7..b37931936d 100644 --- a/packages/noco-docs/docs/020.getting-started/020.quick-start.md +++ b/packages/noco-docs/docs/020.getting-started/020.quick-start.md @@ -43,7 +43,7 @@ Your new workspace is now ready, and you can start building your base within it. ### Build a Base -Building a base in NocoDB is where you define the structure of your database, create tables to store your data, add fields to those tables, and establish relationships between tables using Links. This relational approach helps you organize and manage your data effectively, making it easier to work with complex datasets and build powerful applications. Add a [new Base](/bases/create-base). Alternatively, you can also [import existing base from Airtable](/bases/import-base-from-airtable) as a NocoDB project in minutes. +Building a base in NocoDB is where you define the structure of your database, create tables to store your data, add fields to those tables, and establish relationships between tables using Links. This relational approach helps you organize and manage your data effectively, making it easier to work with complex datasets and build powerful applications. Add a [new Base](/bases/create-base). Alternatively, you can also [import existing base from Airtable](/bases/import-base-from-airtable) as a NocoDB base in minutes. #### Create Tables diff --git a/packages/noco-docs/docs/030.workspaces/020.create-workspace.md b/packages/noco-docs/docs/030.workspaces/020.create-workspace.md index ae4eacfd19..92e502260e 100644 --- a/packages/noco-docs/docs/030.workspaces/020.create-workspace.md +++ b/packages/noco-docs/docs/030.workspaces/020.create-workspace.md @@ -24,8 +24,8 @@ In the following section, lets look at the process of creating your NocoDB works When you start a new workspace, you automatically become the owner. Once your workspace is set up, you can [create tables](/tables/create-table) and [invite others](/workspaces/workspace-collaboration) to join and work together. -You can invite as many people as you want, and you can create as many tables as you need in your workspace. -But remember, there can only be one owner, and only the owner can delete the workspace. +You can invite as many people as you want, and you can create as many tables as you need in your workspace. Workspace ownership is transferable, but a workspace must always have at least one owner. + :::info The Open Source NocoDB includes a default workspace, and it does not allow the creation of additional workspaces. diff --git a/packages/noco-docs/docs/030.workspaces/030.workspace-collaboration.md b/packages/noco-docs/docs/030.workspaces/030.workspace-collaboration.md index 542b54256a..7bf3f5d550 100644 --- a/packages/noco-docs/docs/030.workspaces/030.workspace-collaboration.md +++ b/packages/noco-docs/docs/030.workspaces/030.workspace-collaboration.md @@ -15,7 +15,11 @@ A comprehensive guide regarding roles and permissions can be accessed [here](/ro 4. Click on `Role` dropdown menu 5. Choose the appropriate access permission for the member from the dropdown menu. 6. Conclude the process by selecting the `Add Member(s)` button. - + +:::info +**Note**: Any user can invite members to the workspace, but they can only assign a role to new members that is at most equal to their own role. +::: + ![image](/img/v2/workspace/workspace-collaboration.png) :::tip @@ -29,6 +33,10 @@ The `Members` tab in `Team & Settings` displays a list of users who have been gr 1. Navigate to the Workspace configuration page by selecting `Team & Settings` in the left sidebar. 2. Access the `Members` tab. +:::info +**Note**: Members list is accessible to all workspace members. +::: + ![image](/img/v2/workspace/workspace-members-list.png) ## Modify Workspace Member Roles @@ -38,6 +46,10 @@ You can modify the access permissions of members by following these steps: 3. Access the dropdown menu. 4. Select the desired new role option. +:::info +**Note**: Updates to existing workspace member roles can only be made by the workspace **owner** or **creator**. +::: + ![image](/img/v2/workspace/workspace-members-role-change.png) ## Remove Workspace Members @@ -47,6 +59,11 @@ To remove a member from the workspace, take the following steps: 3. Click on the vertical ellipses `⋮` to open the context menu. 4. Select the `Remove User` option. +:::info +**Note**: Only the workspace **owner** or **creator** can remove members from the workspace. +::: + + ![image](/img/v2/workspace/workspace-members-remove.png) ## Related articles diff --git a/packages/noco-docs/docs/040.bases/010.base-overview.md b/packages/noco-docs/docs/040.bases/010.base-overview.md index 2352f582e7..86c0440355 100644 --- a/packages/noco-docs/docs/040.bases/010.base-overview.md +++ b/packages/noco-docs/docs/040.bases/010.base-overview.md @@ -5,7 +5,7 @@ tags: ['Bases', 'Overview', 'Dashboard'] 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, and webhooks, 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. +In NocoDB, bases are the foundational elements that encompass tables, views, forms, and webhooks, 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'. A base can have multiple owners, each with the authority to manage the base settings and access permissions. At least one owner is required for each base for it to remain operational. Bases also come with their unique set of members 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 members 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. diff --git a/packages/noco-docs/docs/040.bases/020.create-base.md b/packages/noco-docs/docs/040.bases/020.create-base.md index df575ceec2..2d942d483c 100644 --- a/packages/noco-docs/docs/040.bases/020.create-base.md +++ b/packages/noco-docs/docs/040.bases/020.create-base.md @@ -16,7 +16,7 @@ To initiate the creation of a new database from the ground up, follow these step :::info - 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. +- Only Users with `base owner` permission state possesses the authority to delete a base. - It is possible to create multiple bases within a single workspace. ::: diff --git a/packages/noco-docs/docs/040.bases/050.base-collaboration.md b/packages/noco-docs/docs/040.bases/050.base-collaboration.md index 497c6da328..e47d129276 100644 --- a/packages/noco-docs/docs/040.bases/050.base-collaboration.md +++ b/packages/noco-docs/docs/040.bases/050.base-collaboration.md @@ -14,8 +14,21 @@ A member added to a workspace will carry his assigned role specific permissions ![image](/img/v2/base/base-collaboration.png) +:::note +- Any existing user can invite members to the base, but they can only assign a role to new members that is at most equal to their own role. +- Only the base owner / creator can change the role of a base member. +::: + More details about roles & permissions can be found [here](/roles-and-permissions/roles-permissions-overview). +## Removing members from your base +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. Assign the `No Access` role to the user. + +![image](/img/v2/base/base-collaboration.png) + ## Related articles - [Base overview](/bases/base-overview) - [Create an empty base](/bases/create-base) diff --git a/packages/noco-docs/docs/040.bases/060.share-base.md b/packages/noco-docs/docs/040.bases/060.share-base.md index c3096bd87a..c6d830d34a 100644 --- a/packages/noco-docs/docs/040.bases/060.share-base.md +++ b/packages/noco-docs/docs/040.bases/060.share-base.md @@ -8,7 +8,7 @@ keywords: ["NocoDB base", "share base", "base collaboration", "Public share"] 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. +3. The generated link for the shared base will be displayed above and can be utilized to share this base with others. To copy the URL, simply click on the `Copy Link` option. ![Share base](/img/v2/base/share-base-1.png) diff --git a/packages/noco-docs/docs/050.tables/060.actions-on-table.md b/packages/noco-docs/docs/050.tables/060.actions-on-table.md index 8ae9ade948..4fc886bb3b 100644 --- a/packages/noco-docs/docs/050.tables/060.actions-on-table.md +++ b/packages/noco-docs/docs/050.tables/060.actions-on-table.md @@ -41,7 +41,7 @@ A new table will be generated, mirroring the original table's schema and content :::info - Duplicate table will be created in the same base as the original table - Duplicate table will carry suffix ` Copy` in its name. -- Duplicate table option is not available for `External DB` projects +- Duplicate table option is not available for `External DB` bases ::: ## Delete table diff --git a/packages/noco-docs/docs/110.roles-and-permissions/010.roles-permissions-overview.md b/packages/noco-docs/docs/110.roles-and-permissions/010.roles-permissions-overview.md index 8236792f6e..72d10ab895 100644 --- a/packages/noco-docs/docs/110.roles-and-permissions/010.roles-permissions-overview.md +++ b/packages/noco-docs/docs/110.roles-and-permissions/010.roles-permissions-overview.md @@ -9,10 +9,12 @@ keywords: ['Roles overview', 'Permissions overview', 'NocoDB roles', 'NocoDB per In NocoDB, we have roles that determine what people can do in a Workspace or Base. You can give a member one of these roles: +* Owner * Creator * Editor * Commenter -* Viewer +* Viewer +* No Access :::info If a role is assigned to a member at the base level, it takes precedence over a role assigned at the workspace level. @@ -26,19 +28,18 @@ in workspace or base management. ## Roles Roles serve as the basis for user privileges in NocoDB. They are associated with members at two levels: Workspace and Base. When a member is invited to a Workspace with a specific role, like an "Editor," they -automatically have that role in all Bases within that Workspace. However, project owners or creators can customize -permissions at the project level to align with specific needs. This dual-level role assignment system +automatically have that role in all Bases within that Workspace. However, base owners or creators can customize +permissions at the base level to align with specific needs. This dual-level role assignment system ensures adaptable user permissions and access management in NocoDB. **Owner**: When a member creates a new Workspace or Base, they automatically become the Workspace or Base "Owner." -This role grants exclusive privileges, including the authority to delete the Workspace or Base. -The "Owner" role's privileges are non-transferable, ensuring ownership and control integrity. +This role grants exclusive privileges, including the authority to delete the Workspace or Base. **Creator**: The "Creator" role shares all privileges with an "Owner," except for deleting the workspace or base. "Creators" have full administrative rights, except for deletion authority, which remains exclusive to the "Owner." This ensures balanced workspace or base management. -**Editor**: An "Editor" can create and edit records but cannot modify the project schema, +**Editor**: An "Editor" can create and edit records but cannot modify the base schema, like adding tables or fields. They strike a balance between data input and schema management. **Commenter**: The "Commenter" role cannot add or edit records but can provide comments on existing records @@ -47,8 +48,7 @@ like adding tables or fields. They strike a balance between data input and schem **Viewer**: "Viewers" can only access records and associated comments, without the ability to contribute or make changes, ensuring controlled access for informational purposes. -**No Access**: This role, applied exclusively at the base level, revokes project access for the designated user, -ensuring robust security and access management. +**No Access**: This role, applied at the base level, revokes base access for the designated user. When applied at the workspace level, it gives the user no default access to any base within the workspace. ### Workspace level permissions diff --git a/packages/noco-docs/docs/120.collaboration/010.workspace-collaboration.md b/packages/noco-docs/docs/120.collaboration/010.workspace-collaboration.md index 6f03654ecd..9b6f27364e 100644 --- a/packages/noco-docs/docs/120.collaboration/010.workspace-collaboration.md +++ b/packages/noco-docs/docs/120.collaboration/010.workspace-collaboration.md @@ -17,6 +17,10 @@ A comprehensive guide regarding roles and permissions can be accessed [here](/ro 5. Choose the appropriate access permission for the member from the dropdown menu. 6. Conclude the process by selecting the `Add Member(s)` button. +:::info +**Note**: Any user can invite members to the workspace, but they can only assign a role to new members that is at most equal to their own role. +::: + ![image](/img/v2/workspace/workspace-collaboration.png) :::info @@ -26,16 +30,31 @@ You have the capability to invite multiple members simultaneously by entering th ## List Workspace members The `Members` tab displays a list of users who have been granted access to the workspace. + +:::info +**Note**: Members list is accessible to all workspace members. +::: + ![image](/img/v2/workspace/workspace-members-list.png) ## Modify Workspace Member Roles You can modify the access permissions of members by following these steps: 1. Access the dropdown menu. 2. Select the desired new role option. - ![image](/img/v2/workspace/workspace-members-role-change.png) + +:::info +**Note**: Updates to existing workspace member roles can only be made by the workspace **owner** or **creator**. +::: + +![image](/img/v2/workspace/workspace-members-role-change.png) ## Remove Workspace Members To remove a member from the workspace, take the following steps: 1. Click on the vertical ellipses `⋮` to open the context menu. 2. Select the `Remove User` option. - ![image](/img/v2/workspace/workspace-members-remove.png) + +:::info +**Note**: Only the workspace **owner** or **creator** can remove members from the workspace. +::: + +![image](/img/v2/workspace/workspace-members-remove.png) diff --git a/packages/noco-docs/docs/120.collaboration/020.base-collaboration.md b/packages/noco-docs/docs/120.collaboration/020.base-collaboration.md index 0bc44db7a4..5a32ca55aa 100644 --- a/packages/noco-docs/docs/120.collaboration/020.base-collaboration.md +++ b/packages/noco-docs/docs/120.collaboration/020.base-collaboration.md @@ -15,6 +15,11 @@ When a member is added to a workspace, they will carry their assigned role-speci ![image](/img/v2/base/base-collaboration.png) +:::note +- Any existing user can invite members to the base, but they can only assign a role to new members that is at most equal to their own role. +- Only the base owner / creator can change the role of a base member. + ::: + More details about roles & permissions can be found [here](/roles-and-permissions/roles-permissions-overview). ## Removing members from your base diff --git a/packages/noco-docs/docs/120.collaboration/030.share-base.md b/packages/noco-docs/docs/120.collaboration/030.share-base.md index a2e891233a..b548db68b0 100644 --- a/packages/noco-docs/docs/120.collaboration/030.share-base.md +++ b/packages/noco-docs/docs/120.collaboration/030.share-base.md @@ -8,14 +8,14 @@ keywords: ["NocoDB base", "share base", "base collaboration", "base actions", "b 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. +3. The generated link for the shared base will be displayed above and can be utilized to share this base with others. To copy the URL, simply click on the `Copy Link` option. ![Share base](/img/v2/base/share-base-1.png) ![Share base](/img/v2/base/share-base-2.png) ## Copy base -The `Copy base` feature allows users to create a copy of the base (import base) into their own Workspace. This feature is also useful for users who wish to utilize a base as a template for future projects. To copy a base, follow the steps below: +The `Copy base` feature allows users to create a copy of the base (import base) into their own Workspace. This feature is also useful for users who wish to utilize a base as a template for future bases. To copy a base, follow the steps below: 1. Access shared base URL that you wish to copy. 2. Click on the `Copy base` button located in the top right corner of the toolbar. diff --git a/packages/noco-docs/docs/120.collaboration/050.oss-specific-details.md b/packages/noco-docs/docs/120.collaboration/050.oss-specific-details.md index c0f783b707..22f282c450 100644 --- a/packages/noco-docs/docs/120.collaboration/050.oss-specific-details.md +++ b/packages/noco-docs/docs/120.collaboration/050.oss-specific-details.md @@ -8,7 +8,7 @@ keywords: ['Collaboration', 'Open Source', 'User management', 'User permissions' Open source NocoDB includes a default workspace, and it does not allow the creation of additional workspaces. And hence, the user management on Open source is different from Cloud hosted solutions. This article details the specifics of User management on Open source. ## User Management -Organisation is an workspace equivalent concept in Open-source NocoDB. An organisation can have multiple bases. Permissions within NocoDB are divided into two levels: `Organisation level` and `Base level`. +Organisation is a workspace equivalent concept in Open-source NocoDB. An organisation can have multiple bases. Permissions within NocoDB are divided into two levels: `Organisation level` and `Base level`. ### Organisation Level Permissions: - `Org Level Creator`: Allows users to create new bases and access invited bases. @@ -22,12 +22,12 @@ Organisation is an workspace equivalent concept in Open-source NocoDB. An organi ### Base Level Permissions: The permissions at base level in Open source NocoDB remain same as cloud solutions. The base level permissions are summarized below: -- `Owner`: The user who created the project. A project can have only one owner. The owner persists until the project exists and the role is non-transferable. The owner has access to carry out any operations within the project, including deleting it. -- `Creator`: Has access to carry out any operations within the project except deleting the project and removing the "Owner." +- `Owner`: The user who created the base. A base can have multiple owners, and the owner has access to carry out any operations within the base, including deleting it. +- `Creator`: Can perform any operations within the base, except for deleting the base and removing the "Owner." - `Editor`: Can modify data but cannot modify the schema (add/remove fields, tables, users, and such). - `Commenter`: Can neither modify data nor schema, can only see data and can mark record-level comments. - `Viewer`: Can only see data. Please note that the above-mentioned Base Level Permissions are additional to the already defined Organisation Level Permissions. -In addition to the previously defined permissions, NocoDB also includes the role of `Super Admin`. The `Super Admin` is the first user to sign up on this NocoDB installation. An organisation can have only one `Super Admin` and this role is non-transferable. The `Super Admin` will have the equivalent permissions of an "Org Level Creator" and "Owner" for all projects within the organisation. +In addition to the previously defined permissions, NocoDB also includes the role of `Super Admin`. The `Super Admin` is the first user to sign up on this NocoDB installation. An organisation can have only one `Super Admin` and this role is non-transferable. The `Super Admin` will have the equivalent permissions of an "Org Level Creator" and "Owner" for all bases within the organisation. diff --git a/packages/noco-docs/docs/150.engineering/010.architecture.md b/packages/noco-docs/docs/150.engineering/010.architecture.md index 7c858fa4cb..0f7635ba9d 100644 --- a/packages/noco-docs/docs/150.engineering/010.architecture.md +++ b/packages/noco-docs/docs/150.engineering/010.architecture.md @@ -10,8 +10,8 @@ By default, if `NC_DB` is not specified, then SQLite will be used to store your ![image](/img/architecture.png) -| Project Type | Metadata stored in | Data stored in | -|---------|-----------|--------| -| Create new project | NC_DB | NC_DB | -| Create new project with External Database | NC_DB | External Database | -| Create new project from Excel | NC_DB | NC_DB | \ No newline at end of file +| Project Type | Metadata stored in | Data stored in | +|----------------------------------------|-----------|--------| +| Create new base | NC_DB | NC_DB | +| Create new base with External Database | NC_DB | External Database | +| Create new base from Excel | NC_DB | NC_DB | \ No newline at end of file diff --git a/packages/noco-docs/docs/990.FAQs.md b/packages/noco-docs/docs/990.FAQs.md index fa3f3b16b8..c4c4f3300c 100644 --- a/packages/noco-docs/docs/990.FAQs.md +++ b/packages/noco-docs/docs/990.FAQs.md @@ -11,7 +11,7 @@ description: 'General FAQs' - Available since [0.81.1](https://github.com/nocodb/nocodb/releases/tag/0.81.1) -## How to share the project with read only access ? +## How to share the base with read only access ? - Either you can invite by email with 'viewer' access control - Share the base with publicly accessible link. Available since [0.82.0](https://github.com/nocodb/nocodb/releases/tag/0.82.0) @@ -46,7 +46,7 @@ PackageVersion: **0.111.0** - Automations - API Token Support - And we would never move these features from free to an enterprise version of NocoDB. -- There is no limitations to number of projects, records or fields either. +- There is no limitations to number of bases, records or fields either. ## What is the difference between Auth Token and API Token ? diff --git a/packages/noco-docs/static/img/v2/workspace/workspace-members-assign-owner.png b/packages/noco-docs/static/img/v2/workspace/workspace-members-assign-owner.png new file mode 100644 index 0000000000..09d253d6f4 Binary files /dev/null and b/packages/noco-docs/static/img/v2/workspace/workspace-members-assign-owner.png differ