Settings Guide

`backend-server` settings

apitable/backend-server/application/src/main/resources/sysconfig

`room-server` settings

apitable/packages/room-server/env

`web-server` configuration

All env.json key variable descriptions can be found in the web-server section of the documentation.

If you want to modify the datasheet configuration of an edition, you should modify the env.json file in the edition directory. Follow the example below to add the values you want to modify.

{
  "FAVICON": {
		"value": "space/2022/12/08/f8693e8f39774a1c8f0b937f39da0e17"
   },
  "LOGIN_LOGO": {
		"value": "space/2023/01/03/76ecff32aa5a4d4a9324268289c591e0"，
        "description": "Login page Logo URL"
	},
  "SPACE_SECURITY_PAGE_VISIBLE": {
  		"value": true,
  		"description": "Space station management - safety settings, true displays entrance, leave blank to block entrance."
    }
 }

Note that the description field is annotative text.

Custom language text

If you want to modify the string of a certain language, you only need to find the corresponding key in the strings.json file of the language and modify it. For example, modify the English text of the og_page_title field. Find the field og_page_title in strings.en-US.json and change it to the following:

  {
    "og_page_title": "New Custom Title"
  }

In the open source(APItable-CE) version, all configuration strings are located in apitable/packages/l10n/base/strings.json
The enterprise version adds strings base on the open source version, and the configuration files are located in enterprise/i18n-lang/config/strings.json

Modify Other Configurations

Note that json path should be consistent when modifying.

Customize the configuration of emoticons by modifying the value of emojis.json
Modify notifications, static resources, shortcut keys and other configurations by modifying system_config.json

Note: After modifying the json file, execute make l10n-settings or make l10n-apitable-ce to make it take effect

`init-settings` File Directory Structure

For example, Open the init-settings/l10n-apitable-ee folder , you will see the following directory structure:

init-settings/l10n-apitable-ee
├── env.json
├── oss.json
├── strings.en-US.json
├── strings.zh-CN.json
└── strings.zh-HK.json

Download the init-settings sample configuration package

l10n-apitable.tar.gz

How to build init-settings docker image?

In our internal CI process. There are several ways to package theinit-settings image

make command make buildpush-init-settings
manual trigger here, click Run workflow.

Run GitHub Actions Workflow using Curl (workflow_dispatch).

 curl --location --request POST 'https://api.github.com/repos/{owner}/{repo}/dispatches' \
    --header 'Authorization: Bearer xxxxx' \
    --header 'Content-Type: application/json' \
    --data-raw '{
        "event_type": "init-settings",
        "client_payload":{
            "edition": "apitable-ee",
            "semver_edition": "apitable-ee"
        }
    }'

Settings Guide

backend-server settings

room-server settings

web-server configuration