APITable Docs
Configuration

Configuration

Environment Variables

The following table lists all the server configuration properties.

Backend Server Environment Variable Table

CategoryEnvironment Variable NameDescriptionDefault Value
ServerAPI_DOCS_ENABLEDWhether enable openapi document, access address is localhost
/api/v1/doc.html		false
ServerMAX_HTTP_HEADER_SIZEMax size of http request header32KB
ServerMAX_FILE_SIZEMax upload size of http request1GB
ServerMAX_REQUEST_SIZEMax size of http request1GB
ServerSESSION_NAMESPACEHttp cookies namespace key in cacheapitable
ServerSESSION_TIMEOUTHttp cookies survival time30d
ServerDEFAULT_LOCALEDefault server locale, support en-US/zh-CNen-US
ServerSERVER_DOMAINServer access address for all services, usually the ip address deployed by gateway services (like nginx,openresty, et), eg. http(s)://apitable.comhttp://127.0.0.1
ServerASSETS_LTD_URLThe url of assets storage server like minio/s3 et, eg. http(s)://xxx.comhttp://127.0.0.1
/assets
ServerASSETS_LTD_BUCKETBucket name of assets storage. keep default value if not necessaryassets
DatabaseMYSQL_HOSTThe host for the mysql database127.0.0.1
DatabaseMYSQL_PORTThe port for the mysql database3306
DatabaseMYSQL_DATABASEThe db schema for the mysql databaseapitable
DatabaseMYSQL_USERNAMEThe user name for the mysql databaseapitable
DatabaseMYSQL_PASSWORDThe password for the mysql databaseapitable@com
Redis CacheREDIS_HOSTThe host for redis cache127.0.0.1
Redis CacheREDIS_USERNAMEThe username for redis cacheNULL
Redis CacheREDIS_PASSWORDThe password for redis cacheNULL
Redis CacheREDIS_PORTThe port for redis cache6379
Redis CacheREDIS_DBThe db index for redis cache0
MQRABBITMQ_HOSTThe host for rabbitmq server127.0.0.1
MQRABBITMQ_PORTThe port for rabbitmq server5672
MQRABBITMQ_USERNAMEThe username for rabbitmq serverapitable
MQRABBITMQ_PASSWORDThe password for rabbitmq serverapitable@com
MQRABBITMQ_VHOSTThe vhost path for rabbitmq server/
MailEMAIL_PERSONALEmail sign personal show in emailAPITable
MailMAIL_HOSTThe host for smtp serverNULL
MailMAIL_USERNAMEThe username for smtp server, usually email addressNULL
MailMAIL_PASSWORDThe password for smtp server, usually email passwordNULL
MailMAIL_PORTThe port for smtp server, 465 for production, 25 for development465
MailMAIL_SSL_ENABLEWhether mail ssl enabletrue
SocketSOCKET_URLConnect to room server for collaborating working by this properties, set this value in cluster mode, eg. http://room-server
http://127.0.0.1
SocketSOCKET_RECONNECTION_ATTEMPTSSet this value for attempting to reconnect socket times2
SocketSOCKET_RECONNECTION_DELAYTime delay to attempt reconnect socket, unit is seconds1000
SocketSOCKET_TIMEOUTTimeout to connect socket server, unit is seconds1000
StorageOSS_ENABLEDWhether to enable storage, usually opened for uploading attachment in datasheettrue
StorageOSS_CLIENT_TYPEWhich client sdk type you want to use, aws s3 sdk is best, keep default valueaws
StorageAWS_ACCESS_KEYAccess key of AWS S3NULL
StorageAWS_ACCESS_SECRETAccess secret of AWS S3NULL
StorageAWS_ENDPOINTEndpoint of AWS S3NULL
StorageAWS_REGIONRegion of AWS S3NULL
StorageQINIU_ACCESS_KEYAccess key of QINIU CloudNULL
StorageQINIU_SECRET_KEYSecret key of QINIU CloudNULL
StorageQINIU_REGIONRegion of QINIU CloudNULL
StorageQINIU_DOWNLOAD_DOMAINDownload domain of QINIU Cloud, optionalNULL
StorageQINIU_UPLOAD_URLUpload of QINIU Cloud, optionalNULL
StorageQINIU_CALLBACK_URLCallback url of QINIU Cloud, optionalNULL
StorageQINIU_CALLBACK_BODY_TYPECallback body type of QINIU Cloud, optionalNULL
StorageMINIO_ENDPOINTEndpoint of MinIONULL
StorageMINIO_ACCESS_KEYAccess key of MinIONULL
StorageMINIO_SECRET_KEYSecret key of MinIONULL
ReportSENTRY_DSNSentry organization DSN url, set this value to open sentry bug reportNULL
ReportENVSentry env, it depend on your environment, eg. development/test/productionNULL
ConnectSOCKET_DOMAINThe socket server address in cluster mode, eg. http://socket-server
/socket		http://127.0.0.1
/socket
ConnectNEST_GRPC_ADDRESSThe room server grpc service, eg. static://room-server
static://localhost
------------
AuthAUTH0_ENABLEDWhether enable auth0 connect, only for enterprisefalse
AuthAUTH0_CLIENT_IDAuth0 tenant application client id, only for enterpriseNULL
AuthAUTH0_CLIENT_SECRETAuth0 tenant application client secret, only for enterpriseNULL
AuthAUTH0_CLIENT_DOMAINAuth0 tenant client domain, only for enterpriseNULL
AuthAUTH0_CLIENT_ISSUER_URIAuth0 tenant client issuer url, only for enterpriseNULL
AuthAUTH0_REDIRECT_URIAuth0 tenant redirect uri, only for enterpriseNULL
AuthAUTH0_DB_CONNECTION_IDAuth0 tenant db connect id, only for enterpriseNULL
AuthAUTH0_DB_CONNECTION_NAMEAuth0 tenant db connect name, only for enterpriseNULL

Init-db Server Environment Variable Table

Environment Variable NameDescriptionDefault ValueRequire
DB_HOSTthe host of mysql databaseNULLtrue
DB_PORTthe port of mysql databaseNULLtrue
DB_NAMEthe db schema name of mysql databaseNULLtrue
DB_USERNAMEthe username of mysql databaseNULLtrue
DB_PASSWORDthe password of mysql databaseNULLtrue
DATABASE_TABLE_PREFIXtable prefixapitable_true
ACTIONliquibase run actionupdatetrue

Room Server Environment Variable Table

Environment Variable NameDescriptionDefault Value
NODE_ENVEnvironment variable (development)development
PORT-3333
LOG_LEVELLogging leveldebug
DATABASE_TABLE_PREFIX-apitable_
MYSQL_CONNECTION_LIMIT-20
MYSQL_DATABASE-apitable
MYSQL_HOSTMySQL configuration127.0.0.1
MYSQL_KEEP_CONNECTION_ALIVE-true
MYSQL_PASSWORD-apitable@com
MYSQL_PORT-3306
MYSQL_RETRY_DELAY(in ms)300
MYSQL_USERNAME-root
REDIS_DBIf not configured, default is 03
REDIS_HOSTRedis configuration127.0.0.1
REDIS_PASSWORD-apitable@com
REDIS_PORT-6379
SOCKET_GRPC_URLSOCKET-server configuration0.0.0.0
BACKEND_BASE_URLBackend service addresshttp://localhost
/api/v1/
SERVER_MAX_FIELD_COUNT-200
SERVER_MAX_RECORD_COUNT-50000
SERVER_MAX_VIEW_COUNT-30
SERVER_RECORD_REMIND_RANGE-90
SERVER_TRANSFORM_LIMIT-100000
OSS_BUCKET-QNY1
OSS_CACHE_TYPE-
OSS_HOSTOSS configurationhttps://s1.vika.cn
OSS_MINIOMinio{ "endPoint": "", "port": 9000, "useSSL": true, "accessKey": "", "secretKey": "" }
OSS_MINIO_BUCKET_CACHE-{ "name": "api.cache" }
OSS_S3_BUCKET_CACHES3{ "name": "api.cache", "region": "cn-northwest-1" }
ACTUATOR_DNS_URLHealth check configurationhttp://health-check-monitor.vika.cn
ACTUATOR_HEAP_RATIO-100
ACTUATOR_RSS_RATIO-90
LIMIT_DURATION-1
LIMIT_POINTSCurrent limit configuration5
LIMIT_WHITE_LIST-{ "test1": { "points": 5, "duration": 1}, "test2": {"points": 5, "duration": 1 } }
ENABLE_OTEL_JAEGEREnable tracking service (self-hosted)false
OTEL_JAEGER_ENDPOINT-
OTEL_JAEGER_TRACE_ID_RATIO_BASEDInterval value (0 to 1)0.1
SENTRY_DSNSentryhttps://14aceedcbea54ef8ac7ee4d70525f530@sentry.apitable.com/
ENABLE_SOCKETenable socket module for collaboration

Web Server Environment Variable Table

CategoryEnvironment Variable NameDescriptionDefault Value
LimitVIEW_NAME_MAX_COUNTMaximum number of views for a datasheet50
LimitMAXIMUM_VIEW_COUNT_PER_DATASHEETMaximum number of of widgets30
LimitVIEW_NAME_MAX_COUNTMaximum length of view name50
UIFAVICONfaviconNULL
UILOGIN_DEFAULT_ACCOUNT_TYPEDefault login methodmail
UIACCOUNT_LOGOUT_VISIBLEAllow login outtrue
UIACCOUNT_RESET_PASSWORD_VISIBLEAllow reset passwordtrue
UIROBOT_DEFAULT_AVATARRobot default avatarNULL
UIINVITATION_CODE_VISIBLEInvite code visible or notfalse
UIREGENERATE_API_TOKEN_VISIBLERecreate API Token Button visible or notfalse
ThemeSYSTEM_CONFIGURATION_DEFAULT_THEMEDefault themedark
LangSYSTEM_CONFIGURATION_DEFAULT_LANGUAGEDefaut languageen_US
StorageQNY1,QNY2,QNY3OSS bucket or storage urlassets
SentrySENTRY_CONFIG_DSNSentry DSNNULL
ProxyAPI_PROXYhttp://127.0.0.1
ProxyAPI_ROOM_SERVERNULL
ProxyAPI_BACKEND_SERVERNULL
ProxyAPI_FUSION_SERVERNULL
ProxyAPI_SOCKET_SERVER_ROOMNULL
SettingNEXT_PUBLIC_ASSET_PREFIXPublic static folder path""
SettingUSE_CUSTOM_PUBLIC_FILESNULL
SettingPUBLIC_URLNULL
AnalyticsGOOGLE_ANALYTICS_IDGoogle Analytics IDNULL
AnalyticsBAIDU_ANALYSE_IDBaidu Analytics IDNULL
SecurityCOOKIEBOT_IDCookiebot IDNull

\

Docker Images

Previous Page

Automation

Automation Basic Concepts Action is a node in the robot execution process, and the simplest way to understand it is that it is a function. The simplest implementation is also a clo

On this page

Environment VariablesBackend Server Environment Variable TableInit-db Server Environment Variable TableRoom Server Environment Variable TableWeb Server Environment Variable Table