Skip to content

v6.1 Changes #314

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
simonhammes wants to merge 7 commits into
base: main
Choose a base branch
from
Draft

v6.1 Changes #314

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8ecf961
Document `monthly_automation_limit_per_user`
simonhammes Jan 15, 2026
f25d4c7
EMAIL_USE_SSL can now be configured via ENV
simonhammes Feb 12, 2026
40ddf32
Add SEATABLE_EMAIL_USE_SSL to list of environment variables
simonhammes Feb 12, 2026
3900e0f
Restructure configuration section
simonhammes Feb 13, 2026
1ffd71a
Document environment variables
simonhammes Feb 12, 2026
9799373
Update links
simonhammes Feb 18, 2026
134e357
Update links
simonhammes Feb 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .../configuration/dtable-api-gateway-conf.md → ...guration/components/dtable-api-gateway.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ This section contains settings about api-gateway working with dtable-db.
| `cluster_mode` | Indicates whether dtable-db is running in cluster mode. Can be `true` or `false`. | `false` |
| `server_address` | Address of the dtable-db instance. It's required if `cluster_mode` is set to `false`. You should not set it if `cluster_mode` is set to `true`. | 127.0.0.1:7777 |

**TODO:** Is now `inner_dtable_db_url`, old setting is still read

### `[dtable-server]`

This section contains settings about api-gateway working with dtable-server.
Expand All @@ -65,3 +67,4 @@ This section contains settings about api-gateway working with dtable-server.
| `cluster_mode` | Indicates whether dtable-server is running in cluster mode. Can be `true` or `false`. | `false` |
| `server_address` | Address of the dtable-server instance. It's required if `cluster_mode` is set to `false`. You should not set it if `cluster_mode` is set to `true`. | 127.0.0.1:7777 |

**TODO:** Is now `inner_dtable_server_url`, old setting is still read
4 changes: 3 additions & 1 deletion docs/configuration/dtable-db-conf.md → docs/configuration/components/dtable-db.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,8 @@ This sections defines where the database files for bases with activated big data

This sections contains options for caching bases from dtable-server.

**TODO:** is now `inner_dtable_server_url`, but `dtable_server_url` is still read as of v6.1

| Parameter | Description | Default |
| ------------------- | ------------------------------------------------------------------------------------------ | --------------------- |
| `dtable_server_url` | local address for dtable-server. You must specify this option. | http://127.0.0.1:5000 |
Expand Down Expand Up @@ -120,7 +122,7 @@ Section `[backup]` contains options to configure backup functions for big data b

??? note "[database] is not necessary anymore"

Since version 5.3, `dtable-db` reads database connection settings from [environment variables](/configuration/environment-variables).
Since version 5.3, `dtable-db` reads database connection settings from [environment variables](/configuration/overview).
From version 2.7 to version 5.2, `dtable-db` used the database settings in `dtable_server_config.json`.

The section `[database]` contained options for accessing the MySQL database used by dtable-server.
Expand Down
71 changes: 49 additions & 22 deletions docs/configuration/dtable-events-conf.md → ...configuration/components/dtable-events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Configuration of dtable-events

This is a cheat sheet for the [dtable-events](/introduction/architecture/#dtable-events) configuration file `dtable-events.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 [dtable-events](/introduction/architecture/#dtable-events). 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. It is not necessary the value, that is written in the configuration file on first startup.

Expand All @@ -10,6 +10,45 @@ In the default values below, a value in the form `$XYZ` refers to an environment

New configuration options will only apply after a restart of SeaTable.

## Environment Variables

This section lists the environment variables read by [dtable-events](/introduction/architecture/#dtable-events).

Please note that these variables are not included in `seatable-server.yml` by default.
We recommend that you do not modify the included `*.yml` files since any changes will be removed when upgrading SeaTable.
Instead, add an additional `custom-seatable-server.yml` file that includes the additional environment variables:

```yaml
services:
seatable-server:
environment:
- AUTOMATION_WORKERS=10
```

This file then needs to be added to the `COMPOSE_FILE` variable inside your `.env` file.
This ensures that SeaTable upgrades stay seamless.

### Automations

| Environment Variable | Description | Default |
| ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | ------- |
| `AUTOMATION_WORKERS` | Configures the number of worker threads used to process automation rule events | 5 |
| `AUTOMATION_RATE_LIMIT_WINDOW_SECS` | The time window (in seconds) used to calculate automation rate limits | 300 |
| `AUTOMATION_RATE_LIMIT_PERCENT` | The maximum percentage of total available automation capacity a single team can use within the defined time window. Defaults to 25%. | 0.25 |

By default, these settings will limit a single team to 25% of the available automation running time (calculated by `AUTOMATION_WORKERS * AUTOMATION_RATE_LIMIT_WINDOW_SECS`) within 5 minutes.

### PDF Generation

| Environment Variable | Description | Default |
| ---------------------------------- | --------------------------------------------------------- | ------- |
| `CONVERT_PDF_BROWSERS` | Number of browser processes started to generate PDF files | 2 |
| `CONVERT_PDF_SESSIONS_PER_BROWSER` | Number of sessions per browser instance | 3 |

## Configuration File

The following section describes the structure and possible configuration values of the configuration file `dtable-events.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.
Expand All @@ -20,7 +59,7 @@ In the default values below, a value in the form `$XYZ` refers to an environment

!!! warning "dtable-events reads values from dtable_web_settings.py"

Before SeaTable 5.3, `dtable-events` reads `dtable_web_settings.py` for internal URLs and various key settings. Ensure these configurations are correct.
`dtable-events` reads `dtable_web_settings.py` for internal URLs and various key settings. Ensure these configurations are correct.

Other configuration files are not used, if you run dtable-events separately.

Expand All @@ -33,22 +72,20 @@ In the default values below, a value in the form `$XYZ` refers to an environment

The following options are grouped by their sections.

## Example configuration
**Example Configuration**

By default, `dtable-events.conf` will contain the following configuration after the first startup of SeaTable:

```python
```ini
[CLEAN DB]
enabled = true
```

## Available configuration options

### `[DATABASE]`

??? success "Database can be configured in .env"

From SeaTable 5.3, you can specify the database configurations in [`.env`](./environment-variables.md#table-of-settings). There is no need to keep this configuration in your `dtable-events.conf`.
From SeaTable 5.3, you can specify the database configurations in [`.env`](../overview.md). There is no need to keep this configuration in your `dtable-events.conf`.

| Parameter | Description | Default |
| ---------- | ------------------------------------------------------------------------------------------------------- | ----------------- |
Expand All @@ -62,7 +99,7 @@ enabled = true
### `[REDIS]`

??? success "Redis can be configured in .env"
From SeaTable 5.3, you can specify the redis configurations in [`.env`](./environment-variables.md#table-of-settings). There is no need to keep this configuration in your `dtable-events.conf`.
From SeaTable 5.3, you can specify the redis configurations in [`.env`](../overview.md). There is no need to keep this configuration in your `dtable-events.conf`.

| Parameter | Description | Default |
| ---------- | --------------------- | ------- |
Expand Down Expand Up @@ -105,17 +142,6 @@ SeaTable runs this task every hour to send base email notifications for base upd
| --------- | ------------------------------------------------------------ | ------- |
| `enabled` | Enables or disables the email notifications for base updates | true |

### `[AUTOMATION]`

**enabled** by default.

In SeaTable, users have the ability to define triggers and actions within an automation rule.
These rules are then automatically executed on a base.

| Parameter | Description | Default |
| ------------------------------ | ------------------------------------------------------------------- | ------- |
| `per_update_auto_rule_workers` | Number of worker threads used for processing automation rule events | 3 |

### `[COMMON DATASET SYNCER]`

**enabled** by default.
Expand All @@ -141,7 +167,7 @@ SeaTable runs this event at the 30th minute of every hour. The job processes ema

**disabled** by default.

SeaTable could sync LDAP accounts, if activated. This requires additional settings in `dtable_web_settings.py`. Please refer to [LDAP Authentication](../configuration/authentication/ldap.md).
SeaTable could sync LDAP accounts, if activated. This requires additional settings in `dtable_web_settings.py`. Please refer to [LDAP Authentication](../authentication/ldap.md).

| Parameter | Description | Default |
| --------------- | --------------------------------------------------------------------------------------- | ------- |
Expand Down Expand Up @@ -177,7 +203,7 @@ This section configures how files are scanned for viruses:

??? note "[DATABASE] is not necessary anymore"

Since version 5.3, `dtable-events` reads database settings from [environment variables](/configuration/environment-variables).
Since version 5.3, `dtable-events` reads database settings from [environment variables](/configuration/overview).

The section `[DATABASE]` contained options for accessing the MySQL database used by `dtable-events`.

Expand All @@ -192,7 +218,7 @@ This section configures how files are scanned for viruses:

??? note "[REDIS] is not necessary anymore"

Since version 5.3, `dtable-events` reads Redis connection settings from [environment variables](/configuration/environment-variables).
Since version 5.3, `dtable-events` reads Redis connection settings from [environment variables](/configuration/overview).

The section `[REDIS]` used to contain the following options:

Expand All @@ -203,6 +229,7 @@ This section configures how files are scanned for viruses:
### `[AUTOMATION]`

- `per_minute_trigger_limit`: This setting allowed an administrator to restrict the frequency of automation rule executions. It has been removed in SeaTable 5.3.
- `per_update_auto_rule_workers`: This setting allowed an administrator to configure the number of worker threads used to process automation rule events. It has been removed in SeaTable 6.1. You should use the environment variable `AUTOMATION_WORKERS` instead.

### `[ROWS COUNTER]`

Expand Down
53 changes: 39 additions & 14 deletions docs/configuration/dtable-server-config.md → ...configuration/components/dtable-server.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Configuration of dtable-server

This is a cheat sheet for the [dtable-server](/introduction/architecture/#dtable-server) configuration file `dtable_server_config.json`. 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 [dtable-server](/introduction/architecture/#dtable-server). 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. It is not necessary the value, that is written in the configuration file on first startup.

Expand All @@ -10,6 +10,34 @@ In the default values below, a value in the form `$XYZ` refers to an environment

New configuration options will only apply after a restart of SeaTable.

## Environment Variables

This section lists the environment variables read by [dtable-server](/introduction/architecture/#dtable-server).

Please note that these variables are not included in `seatable-server.yml` by default.
We recommend that you do not modify the included `*.yml` files since any changes will be removed when upgrading SeaTable.
Instead, add an additional `custom-seatable-server.yml` file that includes the additional environment variables:

```yaml
services:
seatable-server:
environment:
- AUTOMATION_RATE_LIMIT_PER_BASE_MINUTE=100
```

This file then needs to be added to the `COMPOSE_FILE` variable inside your `.env` file.
This ensures that SeaTable upgrades stay seamless.

### Automations

| Environment Variable | Description | Default |
| --------------------------------------- | -------------------------------------------------------------------------- | ------- |
| `AUTOMATION_RATE_LIMIT_PER_BASE_MINUTE` | Limits the number of automations that can be triggered per base per minute | 1000 |

## Configuration File

The following section describes the structure and possible configuration values of the configuration file `dtable_server_config.json`.

??? abstract "Notes about the configuration file format"

The configuration file uses the **JSON format** (JavaScript Object Notation), which is a lightweight, text-based format for storing and transmitting structured data. It consists of key-value pairs and nested objects, represented by curly braces {}. Comments are not supported in JSON.
Expand All @@ -18,16 +46,14 @@ In the default values below, a value in the form `$XYZ` refers to an environment

JSON is strict about syntax, particularly with commas. Each key-value pair in an object must be separated by a comma, and there should be no trailing comma after the last key-value pair.

## Example configuration
**Example configuration**

By default, `dtable_server_config.json` will be empty after the first startup of SeaTable:

```json
{}
```

## Available configuration options

### Redis

| Parameter | Description | Default |
Expand Down Expand Up @@ -56,7 +82,7 @@ By default, `dtable_server_config.json` will be empty after the first startup of

### Row Limits

Please note that increasing this value requires corresponding updates in `dtable_web_settings.py`, as detailed [here](../configuration/base-rows-limit.md).
Please note that increasing this value requires corresponding updates in `dtable_web_settings.py`, as detailed [here](../base-rows-limit.md).

| Parameter | Description | Default |
| --------------------- | ---------------------------------------------------------------------------------- | ------- |
Expand All @@ -69,12 +95,6 @@ Please note that increasing this value requires corresponding updates in `dtable
| --------------- | ------------------------------------------------------------------------- | ------- |
| `base_max_size` | Maximum size of a base's JSON file (excluding assets and big data) in MB. | 200 |

### Automation Limits

| Parameter | Description | Default |
| -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
| `per_minute_trigger_limit` | Limits the number of automations that can be triggered per base per minute. This setting only works for SeaTable versions up to (and including) v6.0.10. | 50 |

### Expert Configuration

It is not recommended to change these values
Expand All @@ -92,10 +112,15 @@ For more information on setting up a SeaTable cluster, which is typically suitab

## Deprecated settings

### Automation Limits

The setting `per_minute_trigger_limit`, which allowed limiting the number of automations that could be triggered per base per minute, has been removed in v6.1.
You can use the environment variable `AUTOMATION_RATE_LIMIT_PER_BASE_MINUTE` instead if you want to modify the default setting.

### MariaDB Database Connection

`dtable-server` used to read the database connection settings from `dtable_server_config.json`.
Since version 5.3, `dtable-server` reads these settings from [environment variables](/configuration/environment-variables) instead.
Since version 5.3, `dtable-server` reads these settings from [environment variables](/configuration/overview) instead.

| Parameter | Description | Default |
| ---------- | ---------------------- | ----------------- |
Expand All @@ -108,7 +133,7 @@ Since version 5.3, `dtable-server` reads these settings from [environment variab
### Redis Connection

`dtable-server` used to read the Redis connection settings from `dtable_server_config.json`.
Since version 5.3, `dtable-server` reads these settings from [environment variables](/configuration/environment-variables) instead.
Since version 5.3, `dtable-server` reads these settings from [environment variables](/configuration/overview) instead.

| Parameter | Description | Default |
| ----------------------------- | ---------------------------------------- | ------- |
Expand All @@ -120,7 +145,7 @@ Since version 5.3, `dtable-server` reads these settings from [environment variab
### Private Key

Starting with version 5.3, it is no longer required to provide `private_key` that is used to sign JWTs inside the configuration file.
`dtable-server` reads this value from the `JWT_PRIVATE_KEY` [environment variable](/configuration/environment-variables) instead.
`dtable-server` reads this value from the `JWT_PRIVATE_KEY` [environment variable](/configuration/overview) instead.

| Parameter | Description | Default |
| ------------- | ---------------------------------------------------------------------------------------------------- | ------- |
Expand Down
Loading