v6.2

docs/configuration/authentication/ldap.md

@@ -49,8 +49,8 @@ Some tips on how to select LDAP_BASE_DN and LDAP_ADMIN_DN:
 
 - To determine your LDAP_BASE_DN attribute, you first need to open the graphical interface of the domain manager and browse your organizational structure.
 - If you want all users in the system to be able to access SeaTable, you can use 'cn=users,dc=yourdomain,dc=com' as the BASE option (need to replace your domain name).
-- If you only want people in a certain department to be able to access, you can limit the scope to a certain OU. You can use the `dsquery` command-line tool to find the DN of the corresponding OU. For example, if the name of the OU is `staffs`, you can run `dsquery ou -name staff`. More information can be found [here](https://learn.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server-2012-R2-and-2012/cc770509(v=ws.11)).
-- Although AD supports the use of usernames in email address format as `LDAP_ADMIN_DN` such as administrator@example.com, it sometimes does not correctly recognize this format. At this point, you can use `dsquery` to find the DN of the user. For example, if the username is `seatableuser`, run `dsquery user -name seatableuser` to find the user. More information can be found [here](https://learn.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server-2012-R2-and-2012/cc725702(v=ws.11)).
+- If you only want people in a certain department to be able to access, you can limit the scope to a certain OU. You can use the `dsquery` command-line tool to find the DN of the corresponding OU. For example, if the name of the OU is `staffs`, you can run `dsquery ou -name staff`. More information can be found [here](<https://learn.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server-2012-R2-and-2012/cc770509(v=ws.11)>).
+- Although AD supports the use of usernames in email address format as `LDAP_ADMIN_DN` such as administrator@example.com, it sometimes does not correctly recognize this format. At this point, you can use `dsquery` to find the DN of the user. For example, if the username is `seatableuser`, run `dsquery user -name seatableuser` to find the user. More information can be found [here](<https://learn.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server-2012-R2-and-2012/cc725702(v=ws.11)>).
 
 The following parameters are also available, but optional:
 
@@ -61,8 +61,8 @@ The following parameters are also available, but optional:
 | LDAP_USER_ROLE_ATTR       | Name of user role in the LDAP server                                                                                                                                   | Attribute name, e.g. `title`                                          |
 | LDAP_USER_FIRST_NAME_ATTR | First part of the user's SeaTable nickname when nickname is spliced; default value is ''                                                                               | Attribute name, e.g. `givenName`                                      |
 | LDAP_USER_LAST_NAME_ATTR  | Second part of the user's SeaTable nickname when nickname is spliced; default value is ''                                                                              | Attribute name, e.g. `sn`                                             |
-| LDAP_USER_NAME_REVERSE    | Option to reverse order of first name and last name f spliced nickname; default value is `False`                                                                       | `True` or `False`                                                      |
-| LDAP_SAML_USE_SAME_UID    | Option to allow users to log in via LDAP and SAML using the same username                                                                                              | `True` or `False`                                                      |
+| LDAP_USER_NAME_REVERSE    | Option to reverse order of first name and last name f spliced nickname; default value is `False`                                                                       | `True` or `False`                                                     |
+| LDAP_SAML_USE_SAME_UID    | Option to allow users to log in via LDAP and SAML using the same username                                                                                              | `True` or `False`                                                     |
 | LDAP_CONTACT_EMAIL_ATTR   | Alternative attribute as a mail address when LDAP_LOGIN_ATTR is not `mail`; the attribute overrides the email address imported through LOGIN_ATTR; default value is '' |                                                                       |
 | LDAP_EMPLOYEE_ID_ATTR     | ID of the employee                                                                                                                                                     | Attribute name, e.g. `33`                                             |
 
@@ -80,22 +80,34 @@ To enable LDAP synchronisation (LDAP Sync), LDAP Auth must be configured and the
 
 | Parameter                  | Description                                                                                             | Values                                                                                                                                 |
 | -------------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
-| LDAP_SYNC_GROUP            | On/off switch for group sync                                                                            | `True` or `False`                                                                                                                       |
+| LDAP_SYNC_GROUP            | On/off switch for group sync                                                                            | `True` or `False`                                                                                                                      |
 | LDAP_GROUP_MEMBER_ATTR     | Attribute used when syncing group members                                                               | For most directory servers, the attributes is "member", which is the default value. For "posixGroup", it should be set to "memberUid". |
 | LDAP_GROUP_MEMBER_UID_ATTR | User attribute set in 'memberUid' option, which is used in "posixGroup"; default value is `uid`         |                                                                                                                                        |
 | LDAP_USER_OBJECT_CLASS     | Name of the class used to search for user objects; default value is `person`                            |                                                                                                                                        |
 | LDAP_GROUP_OBJECT_CLASS    | Name of the class used to search for group objects; default value is `group`                            | For LDAP: `groupOfNames`, `groupOfUniqueNames`, `posixGroup`<br />For AD: `group`                                                      |
 | LDAP_GROUP_UUID_ATTR       | ...; default value is `ObjectGUID`                                                                      | For LDAP: refer to https://ldapwiki.com/wiki/Universally%20Unique%20Identifier<br />For AD: `ObjectGUID`                               |
-| SYNC_GROUP_AS_DEPARTMENT   | Option to sync LDAP groups as departments rather than SeaTable groups                                   | `True` or `False`                                                                                                                       |
+| SYNC_GROUP_AS_DEPARTMENT   | Option to sync LDAP groups as departments rather than SeaTable groups                                   | `True` or `False`                                                                                                                      |
 | LDAP_DEPARTMENT_NAME_ATTR  | Name of the department when SYNC_GROUP_AS_DEPARTMENT = True, the default department name is the OU name | Object name, e.g. `description`                                                                                                        |
 
-Additionally, the following parameters must be added to `dtable-events.conf`:
-
-```ini
-[LDAP SYNC]
-enabled = true
-sync_interval = 60  # The unit is seconds
-```
+Depending on your SeaTable version, additional settings must be configured:
+
+=== "SeaTable <= v6.1"
+    The following parameters must be added to `dtable-events.conf`:
+
+    ```ini
+    [LDAP SYNC]
+    enabled = true
+    sync_interval = 60  # The unit is seconds
+    ```
+=== "SeaTable v6.2+"
+    Two environment variables must be configured.
+    Please read our [guide](../../configuration/customizations.md) that explains how to configure these additional environment variables before proceeding.
+
+    ```ini
+    LDAP_SYNC_ENABLED=true
+    # Specified in seconds
+    LDAP_SYNC_INTERVAL=3600
+    ```
 
 ## LDAP and SAML
 

docs/configuration/base-rows-limit.md

@@ -13,20 +13,31 @@ Base rows are limited for the following technical reasons:
 
 Starting from version 3.4, for private deployment users, if your application scenario needs to support more than 100,000 rows in a base, but the storage space occupied by the base itself is not large (for example, it contains a large number of blank cells), you can modify the server's configuration, to support more than 100,000 rows.
 
-#### dtable-server
+## dtable-server
 
-`dtable_server_config.json`
+The configuration depends on your SeaTable version::
 
-```json
-{
-   "base_writable_limit": 100000,
-   "base_max_rows_limit": 150000
-}
-```
+=== "SeaTable <= v6.1"
+    The following parameters must be added to `dtable_server_config.json`:
+
+      ```json
+      {
+         "base_writable_limit": 100000,
+         "base_max_rows_limit": 150000
+      }
+      ```
+=== "SeaTable v6.2+"
+    Two environment variables must be configured.
+    Please read our [guide](./customizations.md) that explains how to configure these additional environment variables before proceeding.
+
+    ```ini
+    BASE_WRITABLE_LIMIT=100000
+    BASE_MAX_ROWS_LIMIT=150000
+    ```
 
-Among them, base_writable_limit is used to limit the rows written into the base. base_max_rows_limit is used to control when the rows in the base is greater than the number, the server refuses to load the base into memory. base_max_rows_limit needs to be greater than base_writable_limit.
+Among them, `base_writable_limit` is used to limit the rows written into the base. `base_max_rows_limit` is used to control when the rows in the base is greater than the number, the server refuses to load the base into memory. `base_max_rows_limit` needs to be greater than `base_writable_limit`.
 
-#### dtable-web
+## dtable-web
 
 `dtable_web_settings.py`
 

docs/configuration/components/dtable-api-gateway.md

@@ -1,19 +1,72 @@
 ---
-description: Complete reference for all api-gateway configuration options in dtable-api-gateway.conf including rate limits and cluster settings.
+description: Complete reference for all api-gateway configuration options including rate limits and cluster settings.
 ---
 
 # Configuration of api-gateway
 
-This is a cheat sheet for the [api-gateway](/introduction/architecture.md#api-gateway) configuration file `dtable-api-gateway.conf`. It contains all possible settings that can be configured as well as their default values.
+This is a cheat sheet for the possible configuration options of the [api-gateway](../../introduction/architecture.md#api-gateway).
+It contains all possible settings that can be configured as well as their default values.
 
-The default values provided here are best-effort (not built automatically). They will be used, if no value is defined at all.
-
-In the default values below, a value in the form `$XYZ` refers to an environment variable.
+The default values provided here are best-effort (not built automatically). They will be used if no value is defined at all.
 
 ??? tip "Configuration changes require a restart"
 
     New configuration options will only apply after a restart of SeaTable.
 
+## Environment Variables
+
+<!-- md:version 6.2 -->
+
+This section lists the environment variables read by the [api-gateway](../../introduction/architecture.md#api-gateway).
+Please read our guide that explains how you can [customize the configuration](../customizations.md) of your SeaTable instance before you proceed.
+
+### General
+
+| Environment Variable                    | Description                                         | Default |
+| --------------------------------------- | --------------------------------------------------- | ------- |
+| `API_GATEWAY_HOST`                      | The address the api-gateway listens on.             | 0.0.0.0 |
+| `API_GATEWAY_PORT`                      | The port the api-gateway listens on.                | 7780    |
+| `API_GATEWAY_MAX_BASE_CACHE_SIZE`       | Maximum base cache size in MB.                      | 1024    |
+| `API_GATEWAY_BASE_API_LIMIT_PER_MINUTE` | Limits the number of API calls per base per minute. | 500     |
+
+### dtable-db
+
+| Environment Variable  | Description                    | Default               |
+| --------------------- | ------------------------------ | --------------------- |
+| `INNER_DTABLE_DB_URL` | URL of the dtable-db instance. | http://127.0.0.1:7777 |
+
+### dtable-server
+
+| Environment Variable      | Description                        | Default               |
+| ------------------------- | ---------------------------------- | --------------------- |
+| `INNER_DTABLE_SERVER_URL` | URL of the dtable-server instance. | http://127.0.0.1:5000 |
+
+### Metrics
+
+| Environment Variable                    | Description                                                          | Default |
+| --------------------------------------- | -------------------------------------------------------------------- | ------- |
+| `API_GATEWAY_METRICS_ENABLE_BASIC_AUTH` | Whether basic authentication is enabled for the `/metrics` endpoint. | false   |
+| `API_GATEWAY_METRICS_USERNAME`          | Username for basic authentication for the `/metrics` endpoint.       |         |
+| `API_GATEWAY_METRICS_PASSWORD`          | Password for basic authentication for the `/metrics` endpoint.       |         |
+
+### Access Logs
+
+| Environment Variable                          | Description                                                                              | Default |
+| --------------------------------------------- | ---------------------------------------------------------------------------------------- | ------- |
+| `API_GATEWAY_ENABLE_ACCESS_LOG`               | Whether the api-gateway logs information about incoming HTTP requests to a Redis stream. | false   |
+| `API_GATEWAY_ACCESS_LOG_REDIS_STREAM_KEY`     | Key of the Redis stream that will contain access log entries.                            |         |
+| `API_GATEWAY_ACCESS_LOG_REDIS_STREAM_MAX_LEN` | Maximum length of the Redis stream.                                                      | 100000  |
+
+## Configuration File (Legacy)
+
+!!! warning "Configuration file is not read anymore from v6.2 onwards"
+
+    `dtable-api-gateway.conf` will not be read anymore after upgrading from v6.1 to v6.2.
+
+    Please migrate any custom settings to the respective [environment variables](#environment-variables).
+
+The following section describes the structure and possible configuration values of the configuration file `dtable-api-gateway.conf`.
+
 ??? abstract "Notes about the configuration file format"
 
     The configuration file uses the **INI format**, which is a simple text-based format for storing configuration data. It consists of sections (denoted by square brackets, e.g., [general]) and key-value pairs.
@@ -22,14 +75,10 @@ In the default values below, a value in the form `$XYZ` refers to an environment
 
     When dealing with special characters like single quotes `'`, double quotes `"` or the hash symbol `#`, it's generally best to enclose the value in double quotes.
 
-The following options are grouped by their sections.
-
-## Example configuration
+**Example Configuration**
 
 SeaTable does not create the `dtable-api-gateway.conf` file by default. The `api-gateway` will use the default configuration values if the file does not exist.
 
-## Available configuration options
-
 ### `[general]`
 
 This section contains general settings about api-gateway service.