mirror of https://github.com/nocodb/nocodb
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
16 lines
28 KiB
16 lines
28 KiB
<!doctype html> |
|
<html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-current plugin-docs plugin-id-default docs-doc-id-getting-started/self-hosted/environment-variables"> |
|
<head> |
|
<meta charset="UTF-8"> |
|
<meta name="generator" content="Docusaurus v2.4.1"> |
|
<title data-rh="true">Environment variables | NocoDB</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:image" content="https://nocodb.com/img/docusaurus-social-card.jpg"><meta data-rh="true" name="twitter:image" content="https://nocodb.com/img/docusaurus-social-card.jpg"><meta data-rh="true" property="og:url" content="https://nocodb.com/getting-started/self-hosted/environment-variables"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Environment variables | NocoDB"><meta data-rh="true" name="description" content="Environment Variables for NocoDB!"><meta data-rh="true" property="og:description" content="Environment Variables for NocoDB!"><meta data-rh="true" name="keywords" content="NocoDB environment variables,NocoDB env variables,NocoDB envs,NocoDB env"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://nocodb.com/getting-started/self-hosted/environment-variables"><link data-rh="true" rel="alternate" href="https://nocodb.com/getting-started/self-hosted/environment-variables" hreflang="en"><link data-rh="true" rel="alternate" href="https://nocodb.com/getting-started/self-hosted/environment-variables" hreflang="x-default"><link rel="search" type="application/opensearchdescription+xml" title="NocoDB" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.ce2b6fcc.css"> |
|
<link rel="preload" href="/assets/js/runtime~main.582b9e96.js" as="script"> |
|
<link rel="preload" href="/assets/js/main.ba728574.js" as="script"> |
|
</head> |
|
<body class="navigation-with-keyboard"> |
|
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}return t}()||function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus"> |
|
<div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/nocodb-full-color.png" alt="NocoDB" class="themedImage_ToTc themedImage--light_HNdA"><img src="/img/nocodb-full-color.png" alt="NocoDB" class="themedImage_ToTc themedImage--dark_i4oU"></div><b class="navbar__title text--truncate"></b></a></div><div class="navbar__items navbar__items--right"><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a aria-current="page" class="navbar__link active" aria-haspopup="true" aria-expanded="false" role="button" href="/">Latest</a><ul class="dropdown__menu"><li><a aria-current="page" class="dropdown__link dropdown__link--active" href="/getting-started/self-hosted/environment-variables">Latest</a></li><li><a class="dropdown__link" href="/0.109.7/">0.109.7 - Old UI</a></li></ul></div><a href="https://github.com/nocodb/nocodb" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link header-github-link" aria-label="GitHub repository"></a><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)" aria-live="polite"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="searchBox_ZlJk"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><aside class="theme-doc-sidebar-container docSidebarContainer_b6E3"><div class="sidebarViewport_Xe31"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/">Welcome</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" href="/getting-started/quick-start">Getting Started</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/getting-started/quick-start">Quick start</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/getting-started/terminologies">NocoDB terminologies</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/getting-started/keyboard-shortcuts">Keyboard shortcuts</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" tabindex="0" href="/getting-started/self-hosted/installation">In Open Source</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/getting-started/self-hosted/installation">Installation</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/getting-started/self-hosted/environment-variables">Environment variables</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/getting-started/self-hosted/upgrading">Upgrading</a></li></ul></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="true" href="/workspaces/workspace-overview">Workspaces</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/workspaces/workspace-overview">Workspace overview</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/workspaces/create-workspace">Create workspace</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/workspaces/workspace-collaboration">Workspace collaboration</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/workspaces/actions-on-workspace">Actions on workspace</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/bases/base-overview">Bases</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/tables/table-overview">Tables</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/table-operations/overview">Table operations</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/table-details/table-details-overview">Table Details</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/fields/fields-overview">Fields</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/records/records-overview">Records</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/views/views-overview">Views</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/data-sources/data-source-overview">Data sources</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/roles-and-permissions/roles-permissions-overview">Roles and permissions</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/collaboration/collaboration-overview">Collaboration</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/automation/webhook/webhook-overview">Automation</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/account-settings/profile-page">Account settings</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/engineering/architecture">Engineering</a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/FAQs">FAQs</a></li></ul></nav></div></div></aside><main class="docMainContainer_gTbr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">Getting Started</span><meta itemprop="position" content="1"></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">In Open Source</span><meta itemprop="position" content="2"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Environment variables</span><meta itemprop="position" content="3"></li></ul></nav><span class="theme-doc-version-badge badge badge--secondary">Version: Latest</span><div class="theme-doc-markdown markdown"><header><h1>Environment variables</h1></header><p>For production use-cases, it is <strong>recommended</strong> to configure </p><ul><li><code>NC_DB</code>, </li><li><code>NC_AUTH_JWT_SECRET</code>, </li><li><code>NC_PUBLIC_URL</code>, </li><li><code>NC_REDIS_URL</code></li></ul><table><thead><tr><th>Variable</th><th>Comments</th><th>If absent</th></tr></thead><tbody><tr><td>NC_DB</td><td>See our example database URLs <a href="https://github.com/nocodb/nocodb#docker" target="_blank" rel="noopener noreferrer">here</a>.</td><td>A local SQLite will be created in root folder if <code>NC_DB</code> is not provided</td></tr><tr><td>NC_DB_JSON</td><td>Can be used instead of <code>NC_DB</code> and value should be valid knex connection JSON</td><td></td></tr><tr><td>NC_DB_JSON_FILE</td><td>Can be used instead of <code>NC_DB</code> and value should be a valid path to knex connection JSON</td><td></td></tr><tr><td>DATABASE_URL</td><td>Can be used instead of <code>NC_DB</code> and value should be in JDBC URL format</td><td></td></tr><tr><td>DATABASE_URL_FILE</td><td>Can be used instead of <code>DATABASE_URL</code> and value should be a valid path to file containing JDBC URL format.</td><td></td></tr><tr><td>NC_AUTH_JWT_SECRET</td><td>JWT secret used for auth and storing other secrets</td><td>A random secret will be generated</td></tr><tr><td>PORT</td><td>For setting app running port</td><td><code>8080</code></td></tr><tr><td>DB_QUERY_LIMIT_DEFAULT</td><td>Pagination limit</td><td>25</td></tr><tr><td>DB_QUERY_LIMIT_MAX</td><td>Maximum allowed pagination limit</td><td>1000</td></tr><tr><td>DB_QUERY_LIMIT_MIN</td><td>Minimum allowed pagination limit</td><td>1</td></tr><tr><td>NC_TOOL_DIR</td><td>App directory to keep metadata and app related files</td><td>Defaults to current working directory. In docker maps to <code>/usr/app/data/</code> for mounting volume.</td></tr><tr><td>NC_PUBLIC_URL</td><td>Used for sending Email invitations</td><td>Best guess from http request params</td></tr><tr><td>NC_JWT_EXPIRES_IN</td><td>JWT token expiry time</td><td><code>10h</code></td></tr><tr><td>NC_CONNECT_TO_EXTERNAL_DB_DISABLED</td><td>Disable Project creation with external database</td><td></td></tr><tr><td>NC_INVITE_ONLY_SIGNUP</td><td>Removed since version 0.99.0 and now it's recommended to use <a href="/account-settings/oss-specific-details#enable--disable-signup">super admin settings menu</a>. Allow users to signup only via invite URL, value should be any non-empty string.</td><td></td></tr><tr><td>NUXT_PUBLIC_NC_BACKEND_URL</td><td>Custom Backend URL</td><td><code>http://localhost:8080</code> will be used</td></tr><tr><td>NC_REQUEST_BODY_SIZE</td><td>Request body size <a href="https://expressjs.com/en/resources/middleware/body-parser.html#limit" target="_blank" rel="noopener noreferrer">limit</a></td><td><code>1048576</code></td></tr><tr><td>NC_EXPORT_MAX_TIMEOUT</td><td>After NC_EXPORT_MAX_TIMEOUT, CSV gets downloaded in batches</td><td>Default value 5000(in millisecond) will be used</td></tr><tr><td>NC_DISABLE_TELE</td><td>Disable telemetry</td><td></td></tr><tr><td>NC_DASHBOARD_URL</td><td>Custom dashboard URL path</td><td><code>/dashboard</code></td></tr><tr><td>NC_GOOGLE_CLIENT_ID</td><td>Google client ID to enable Google authentication</td><td></td></tr><tr><td>NC_GOOGLE_CLIENT_SECRET</td><td>Google client secret to enable Google authentication</td><td></td></tr><tr><td>NC_MIGRATIONS_DISABLED</td><td>Disable NocoDB migration</td><td></td></tr><tr><td>NC_MIN</td><td>If set to any non-empty string the default splash screen(initial welcome animation) and matrix screensaver will disable</td><td></td></tr><tr><td>NC_SENTRY_DSN</td><td>For Sentry monitoring</td><td></td></tr><tr><td>NC_REDIS_URL</td><td>Custom Redis URL. Example: <code>redis://:authpassword@127.0.0.1:6380/4</code></td><td>Meta data will be stored in memory</td></tr><tr><td>NC_DISABLE_ERR_REPORT</td><td>Disable error reporting</td><td></td></tr><tr><td>NC_DISABLE_CACHE</td><td>To be used only while debugging. On setting this to <code>true</code> - meta data be fetched from db instead of redis/cache.</td><td><code>false</code></td></tr><tr><td>AWS_ACCESS_KEY_ID</td><td>For Litestream - S3 access key id</td><td>If Litestream is configured and <code>NC_DB</code> is not present. SQLite gets backed up to S3</td></tr><tr><td>AWS_SECRET_ACCESS_KEY</td><td>For Litestream - S3 secret access key</td><td>If Litestream is configured and <code>NC_DB</code> is not present. SQLite gets backed up to S3</td></tr><tr><td>AWS_BUCKET</td><td>For Litestream - S3 bucket</td><td>If Litestream is configured and <code>NC_DB</code> is not present. SQLite gets backed up to S3</td></tr><tr><td>AWS_BUCKET_PATH</td><td>For Litestream - S3 bucket path (like folder within S3 bucket)</td><td>If Litestream is configured and <code>NC_DB</code> is not present. SQLite gets backed up to S3</td></tr><tr><td>NC_SMTP_FROM</td><td>For SMTP plugin - Email sender address</td><td></td></tr><tr><td>NC_SMTP_HOST</td><td>For SMTP plugin - SMTP host value</td><td></td></tr><tr><td>NC_SMTP_PORT</td><td>For SMTP plugin - SMTP port value</td><td></td></tr><tr><td>NC_SMTP_USERNAME</td><td>For SMTP plugin (Optional) - SMTP username value for authentication</td><td></td></tr><tr><td>NC_SMTP_PASSWORD</td><td>For SMTP plugin (Optional) - SMTP password value for authentication</td><td></td></tr><tr><td>NC_SMTP_SECURE</td><td>For SMTP plugin (Optional) - To enable secure set value as <code>true</code> any other value treated as false</td><td></td></tr><tr><td>NC_SMTP_IGNORE_TLS</td><td>For SMTP plugin (Optional) - To ignore tls set value as <code>true</code> any other value treated as false. For more info visit <a href="https://nodemailer.com/smtp/" target="_blank" rel="noopener noreferrer">https://nodemailer.com/smtp/</a></td><td></td></tr><tr><td>NC_S3_BUCKET_NAME</td><td>For S3 storage plugin - AWS S3 bucket name</td><td></td></tr><tr><td>NC_S3_REGION</td><td>For S3 storage plugin - AWS S3 region</td><td></td></tr><tr><td>NC_S3_ACCESS_KEY</td><td>For S3 storage plugin - AWS access key credential for accessing resource</td><td></td></tr><tr><td>NC_S3_ACCESS_SECRET</td><td>For S3 storage plugin - AWS access secret credential for accessing resource</td><td></td></tr><tr><td>NC_ADMIN_EMAIL</td><td>For updating/creating super admin with provided email and password</td><td></td></tr><tr><td>NC_ATTACHMENT_FIELD_SIZE</td><td>For setting the attachment field size(in Bytes)</td><td>Defaults to 20MB</td></tr><tr><td>NC_ADMIN_PASSWORD</td><td>For updating/creating super admin with provided email and password. Your password should have at least 8 letters with one uppercase, one number and one special letter(Allowed special chars $&+,:;=?@#<!-- -->|<!-- -->'.^*()%!_-" )</td><td></td></tr><tr><td>NODE_OPTIONS</td><td>For passing Node.js <a href="https://nodejs.org/api/cli.html#node_optionsoptions" target="_blank" rel="noopener noreferrer">options</a> to instance</td><td></td></tr><tr><td>NC_MINIMAL_DBS</td><td>Create a new SQLite file for each project. All the db files are stored in <code>nc_minimal_dbs</code> folder in current working directory. (This option restricts project creation on external sources)</td><td></td></tr><tr><td>NC_DISABLE_AUDIT</td><td>Disable Audit Log</td><td><code>false</code></td></tr><tr><td>NC_AUTOMATION_LOG_LEVEL</td><td>Possible Values: <code>OFF</code>, <code>ERROR</code>, <code>ALL</code>. See <a href="/automation/webhook/create-webhook#call-log">Webhooks</a> for details.</td><td><code>OFF</code></td></tr><tr><td>NC_SECURE_ATTACHMENTS</td><td>Allow accessing attachments only through presigned urls. To enable set value as <code>true</code> any other value treated as false. (⚠ this will make existing links inaccessible ⚠)</td><td><code>false</code></td></tr><tr><td>NC_ATTACHMENT_EXPIRE_SECONDS</td><td>How many seconds before expiring presigned attachment urls. (Attachments will expire in at least set seconds and at most 10mins after set time)</td><td>7200 (2 hours)</td></tr><tr><td>NC_ALLOW_LOCAL_HOOKS</td><td>To enable set value as <code>true</code> any other value treated as false. (⚠ this will allow webhooks to call local links which can raise security issues ⚠)</td><td><code>false</code></td></tr></tbody></table></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-tags-row row margin-bottom--sm"><div class="col"><b>Tags:</b><ul class="tags_jXut padding--none margin-left--sm"><li class="tag_QGVx"><a class="tag_zVej tagRegular_sFm0" href="/tags/open-source">Open Source</a></li></ul></div></div><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/nocodb/nocodb/tree/develop/packages/noco-docs/docs/docs/020.getting-started/050.self-hosted/020.environment-variables.md" target="_blank" rel="noreferrer noopener" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_vwxv"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/getting-started/self-hosted/installation"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Installation</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/getting-started/self-hosted/upgrading"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Upgrading</div></a></nav></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="footer__links text--center"><div class="footer__links"><a href="https://github.com/facebook/docusaurus" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a><span class="footer__link-separator">·</span><a href="https://nocodb.com/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Website<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a><span class="footer__link-separator">·</span><a href="https://community.nocodb.com/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Community<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a><span class="footer__link-separator">·</span><a href="https://discord.gg/5RgZmkW" target="_blank" rel="noopener noreferrer" class="footer__link-item">Discord<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a><span class="footer__link-separator">·</span><a href="https://twitter.com/nocodb" target="_blank" rel="noopener noreferrer" class="footer__link-item">Twitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></div></div><div class="footer__bottom text--center"><div class="margin-bottom--sm"><img src="/img/icon.png" alt="NocoDB" class="themedImage_ToTc themedImage--light_HNdA footer__logo" width="50"><img src="/img/icon.png" alt="NocoDB" class="themedImage_ToTc themedImage--dark_i4oU footer__logo" width="50"></div><div class="footer__copyright">Copyright © 2023 NocoDB</div></div></div></footer></div> |
|
<script src="/assets/js/runtime~main.582b9e96.js"></script> |
|
<script src="/assets/js/main.ba728574.js"></script> |
|
</body> |
|
</html> |