| `DB_QUERY_LIMIT_DEFAULT` | No | Default pagination limit for data tables. | Defaults to `25`. Maximum is `100` |
| `DB_QUERY_LIMIT_GROUP_BY_GROUP` | No | Number of groups per page. | Defaults to `10`. |
| `DB_QUERY_LIMIT_GROUP_BY_RECORD` | No | Number of records per group. | Defaults to `10`. |
| `DB_QUERY_LIMIT_MAX` | No | Maximum allowable pagination limit. | Defaults to `1000`. |
| `DB_QUERY_LIMIT_MIN` | No | Minimum allowable pagination limit. | Defaults to `10` |
| `NC_CONNECT_TO_EXTERNAL_DB_DISABLED` | No | Disables the ability to create bases on external databases. | |
| `NC_INVITE_ONLY_SIGNUP` | No | Disables public signup; signup is possible only via invitations. Integrated into the [super admin settings menu](/account-settings/oss-specific-details#enable--disable-signup) as of version 0.99.0. | |
| `NC_REQUEST_BODY_SIZE` | No | Maximum bytes allowed in the request body, based on [ExpressJS limits](https://expressjs.com/en/resources/middleware/body-parser.html#limit). | Defaults to `1048576` (1 MB). |
| `NC_EXPORT_MAX_TIMEOUT` | No | Sets a timeout in milliseconds for downloading CSVs in batches if not completed within this period. | Defaults to `5000` (5 seconds). |
| `NC_ALLOW_LOCAL_HOOKS` | No | Allows webhooks to call local network links, posing potential security risks. Set to `true` to enable; all other values are considered `false`. | Defaults to `false`. |
| `NC_SANITIZE_COLUMN_NAME` | No | Enables sanitization of column names during their creation to prevent SQL injection and other security issues. | Defaults to `true`. |
| `NC_TOOL_DIR` | No | Specifies the directory to store metadata and app-related files. In Docker setups, this maps to `/usr/app/data/` for mounting volumes. | Defaults to the current working directory. |
| `NC_MINIMAL_DBS` | No | Creates a new SQLite file for each base. All SQLite database files are stored in the `nc_minimal_dbs` folder. Enabling this also disables base creation on external databases. | |
| `NC_MIGRATIONS_DISABLED` | No | Disables NocoDB migrations. | |
| `NC_DISABLE_AUDIT` | No | Disables the audit log feature. | Defaults to `false`. |
| `NC_AUTOMATION_LOG_LEVEL` | No | Configures logging levels for automation features. Possible values: `OFF`, `ERROR`, `ALL`. More details can be found under [Webhooks](/automation/webhook/create-webhook#call-log). | Defaults to `OFF`. |
| `NC_REQUEST_BODY_SIZE` | No | Maximum bytes allowed in the request body, based on [ExpressJS limits](https://expressjs.com/en/resources/middleware/body-parser.html#limit). | Defaults to `1048576` (1 MB). |
| `NC_EXPORT_MAX_TIMEOUT` | No | Sets a timeout in milliseconds for downloading CSVs in batches if not completed within this period. | Defaults to `5000` (5 seconds). |
| `NC_ALLOW_LOCAL_HOOKS` | No | Allows webhooks to call local network links, posing potential security risks. Set to `true` to enable; all other values are considered `false`. | Defaults to `false`. |
| `NC_SANITIZE_COLUMN_NAME` | No | Enables sanitization of column names during their creation to prevent SQL injection and other security issues. | Defaults to `true`. |
| `NC_TOOL_DIR` | No | Specifies the directory to store metadata and app-related files. In Docker setups, this maps to `/usr/app/data/` for mounting volumes. | Defaults to the current working directory. |
| `NC_MINIMAL_DBS` | No | Creates a new SQLite file for each base. All SQLite database files are stored in the `nc_minimal_dbs` folder. Enabling this also disables base creation on external databases. | |
| `NC_MIGRATIONS_DISABLED` | No | Disables NocoDB migrations. | |
| `NC_DISABLE_AUDIT` | No | Disables the audit log feature. | Defaults to `false`. |
| `NC_AUTOMATION_LOG_LEVEL` | No | Configures logging levels for automation features. Possible values: `OFF`, `ERROR`, `ALL`. More details can be found under [Webhooks](/automation/webhook/create-webhook). | Defaults to `OFF`. |
## Logging & Monitoring
| Variable | Mandatory | Description | If Not Set |
@ -15,7 +15,7 @@ Some key points to note about workspaces are:
In summary, NocoDB workspaces streamline data management and member control, providing the flexibility and oversight necessary for various projects and teams.
To begin, you can [create a workspace](/workspaces/create-workspace) tailored to your project. Collaborate seamlessly by [inviting team members](/workspaces/workspace-collaboration) to the workspace. If roles need adjustment, simply [modify a team member's role](/workspaces/workspace-collaboration#modifying-workspace-member-roles). When necessary, you can also [remove team members](/workspaces/workspace-collaboration#removing-workspace-members) from the workspace. For organizational purposes, renaming the workspace is straightforward with the [rename workspace](/workspaces/actions-on-workspace#rename-workspace) feature. Finally, if a workspace is no longer needed, you can easily [delete it](/workspaces/actions-on-workspace#delete-workspace).
To begin, you can [create a workspace](/workspaces/create-workspace) tailored to your project. Collaborate seamlessly by [inviting team members](/workspaces/workspace-collaboration) to the workspace. If roles need adjustment, simply [modify a team member's role](/workspaces/workspace-collaboration#modify-workspace-member-roles). When necessary, you can also [remove team members](/workspaces/workspace-collaboration#remove-workspace-members) from the workspace. For organizational purposes, renaming the workspace is straightforward with the [rename workspace](/workspaces/actions-on-workspace#rename-workspace) feature. Finally, if a workspace is no longer needed, you can easily [delete it](/workspaces/actions-on-workspace#delete-workspace).
:::info
The Open Source NocoDB includes a default workspace, and it does not allow the creation of additional workspaces.
@ -31,8 +31,8 @@ You can easily switch between different workspaces by simply clicking on the res
@ -9,7 +9,7 @@ Records in NocoDB are fundamental components within a database, serving as indiv
In essence, a record can be envisaged as a horizontal collection of data within a NocoDB table, each record representing a distinct piece of information. These records play a pivotal role in organizing, categorizing, and presenting data in a comprehensible and efficient manner, offering users a structured and organized platform for data management.
You can perform a variety of actions to efficiently manage your data. To get started, you can [create a new record](/records/create-record) to input essential information. If you need to make updates to an existing record, you can [modify it](/records/actions-on-record#update-record) or even perform a [bulk update](/records/actions-on-record#bulk-update-records) for multiple records simultaneously. For records that are no longer needed, you have the option to [delete](/records/actions-on-record#delete-record) or [duplicate](/records/actions-on-record#duplicate-record) them with ease. When you're working with records, you can also benefit from our expanded form for a more detailed view, complete with a [record change log](/records/expand-record#record-audit) to track all modifications and a feature to [write comments](/records/expand-record#record-comment) for more context and collaboration. Additionally, you can [share records](/records/expand-record#copy-record-url) quickly by generating a shareable URL.
You can perform a variety of actions to efficiently manage your data. To get started, you can [create a new record](/records/create-record) to input essential information. If you need to make updates to an existing record, you can [modify it](/records/actions-on-record#update-record) or even perform a [bulk update](/records/actions-on-record#bulk-update-records--) for multiple records simultaneously. For records that are no longer needed, you have the option to [delete](/records/actions-on-record#delete-record-single) or [duplicate](/records/expand-record#duplicate-record) them with ease. When you're working with records, you can also benefit from our expanded form for a more detailed view, complete with a [record change log](/records/expand-record#record-audit) to track all modifications and a feature to [write comments](/records/expand-record#record-comment) for more context and collaboration. Additionally, you can [share records](/records/expand-record#copy-record-url) quickly by generating a shareable URL.
In this section, we'll explore the various aspects of records in NocoDB, equipping you with the knowledge to effectively manage your own data.
@ -17,9 +17,9 @@ In this section, we'll explore the various aspects of records in NocoDB, equippi
- [Create Record](/records/create-record)
- [Modify an existing Record](/records/actions-on-record#update-record)
@ -12,7 +12,7 @@ Grid View, as a default type of view, allows you to display your data in a sprea
Grid view is the default view type for all tables. This view type is ideal for viewing and editing data in a spreadsheet-like interface. You can also perform various operations on the grid view, such as sorting, filtering, grouping, and searching. You can also export the data in the grid view to CSV or Excel format. This section will cover all the operations that can be performed on the grid view.
## Grid View Actions
1. [Create a New Grid View](/views/create-view/#create-new-view)
1. [Create a New Grid View](/views/create-view#create-new-view)
2. [Rename an Existing Grid View](/views/actions-on-view#rename-view)
3. [Duplicate a Grid View](/views/actions-on-view#duplicate-view)
4. [Remove a Grid View](/views/actions-on-view#delete-view)
@ -33,7 +33,7 @@ Grid view is the default view type for all tables. This view type is ideal for v
## Grid View Record Operations
1. [Add a New Record to the Grid](/records/create-record)
2. [Edit an Existing Record on the Grid](/records/actions-on-record#row-edit)
2. [Edit an Existing Record on the Grid](/records/actions-on-record#update-record)
3. [Delete a Single Record from the Grid](/records/actions-on-record#delete-record-single)
4. [Delete Multiple Records in Bulk from the Grid](/records/actions-on-record#delete-record-bulk)
@ -23,7 +23,7 @@ SSO functionality is achieved by establishing a connection with an identity prov
Google OAuth, short for Open Authorization, is a widely used and standardized protocol that facilitates secure authentication and authorization processes, particularly in the context of web and mobile applications. Developed by Google, OAuth enables users to grant third-party applications limited access to their resources without exposing their credentials. This authorization framework is based on token-based authentication, where users can log in using their Google credentials, and developers can obtain an access token to interact with Google APIs on the user's behalf.
Please follow the details in the article to integrate with [Google OAuth](google-oauth)
Please follow the details in the article to integrate with [Google OAuth](020.google-oauth.md)
### Security Assertion Markup Language (SAML)
The Security Assertion Markup Language (SAML) stands as a critical protocol in the realm of secure authentication and authorization processes. Developed to enable Single Sign-On (SSO) functionality, SAML facilitates the exchange of authentication and authorization data between an identity provider (IdP) and a service provider (SP). This XML-based protocol ensures the secure transfer of user identity information, allowing individuals to access multiple applications and services with a single set of credentials. SAML operates on a trust model, wherein the identity provider asserts the user's identity to the service provider, which, in turn, grants or denies access based on the provided assertions.
@ -31,11 +31,11 @@ The Security Assertion Markup Language (SAML) stands as a critical protocol in t
[//]: # (This robust framework is widely employed in various industries and platforms, contributing to the seamless and secure integration of disparate systems and applications in the digital landscape. SAML adoption is particularly evident in cloud-based services, enterprise applications, and other environments where a unified and secure authentication process is paramount.)
Please follow the details in the article below to integrate with various popular SAML providers.
The OpenID Connect (OIDC) protocol is a modern authentication layer built on top of the OAuth 2.0 framework, designed to address user authentication and authorization challenges in web and mobile applications. OIDC provides a standardized and secure way for applications to verify the identity of end-users. Leveraging JSON Web Tokens (JWTs), OIDC enables the exchange of user identity information between the identity provider (IdP) and the Service provider, typically a web application.
@ -43,9 +43,9 @@ The OpenID Connect (OIDC) protocol is a modern authentication layer built on top
[//]: # (One of the key advantages of OIDC is its ability to enable Single Sign-On (SSO) capabilities, allowing users to authenticate once and access multiple applications seamlessly. OIDC also provides a standardized set of claims, such as user profile information, making it easier for developers to integrate identity management into their applications. Widely adopted in various industries, OIDC plays a crucial role in enhancing the security and user experience of authentication processes across diverse digital platforms.)
Please follow the details in the article below to integrate with various popular OIDC providers.
Pranav C
3 months ago
committed by
GitHub