From 8ecf9613cfc6851aefea8e1fec7c217e4d863468 Mon Sep 17 00:00:00 2001 From: Simon Hammes Date: Thu, 15 Jan 2026 15:17:50 +0100 Subject: [PATCH 1/7] Document `monthly_automation_limit_per_user` --- docs/configuration/roles-and-permissions.md | 70 ++++++++++----------- 1 file changed, 35 insertions(+), 35 deletions(-) diff --git a/docs/configuration/roles-and-permissions.md b/docs/configuration/roles-and-permissions.md index 83ea86264..1307e50e2 100644 --- a/docs/configuration/roles-and-permissions.md +++ b/docs/configuration/roles-and-permissions.md @@ -17,18 +17,18 @@ A user role is comprised of up to 10 permissions and up to 7 quotas. If a permis The following permissions are supported in user roles: -| Permission | Added in version | Permission to ... | Additional information | -| ------------------------------ | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| can_add_dtable | 1.0 | Create bases | If set to False, the user cannot create bases, neither under "My bases" nor in groups. | -| can_add_group | 1.0 | Create groups | If set to False, the user cannot create groups. The permission can_add_dtable is necessary to create bases inside a group. | -| can_generate_external_link | 1.0 | Create external links | If set to False, the user cannot create external links. (The menu item "External link" in the share dialog is hidden.) | -| can_create_common_dataset | 1.0 | Create common datasets (CDS) | If set to False, the user cannot create CDS. | -| can_use_advanced_permissions | 1.1 | Use advanced permissions | Advanced permissions include table permissions, column permissions, view share, custom sharing permissions, and row locking. | -| can_run_python_script | 1.4 | Run Python scripts | If set to False, the action "Run script" in the button column and "Run script" in the script side panel are disabled; in automation rules, the action "Run Python script" is not available. The execution of Python scripts requires the installation of [Python Pipeline](../installation/components/python-pipeline.md). Does not apply to org users and group bases. | -| can_use_advanced_customization | 2.0 | Use advanced customizations | Advanced customization includes custom team logo, custom form logo, custom URL for forms and app, base security settings, and role permissions in apps. | -| can_use_external_app | 2.2 | Create and manage apps | If set to False, the user cannot create apps or access apps in edit mode. (The app-icon is hidden in the base.) | -| can_use_automation_rules | 2.2 | Create and manage automation rules | If set to False, the user cannot create or modify automation rules. (The menu item "Automation rules" is hidden in the base.) Does not apply to org users and group bases. | -| can_archive_rows | 2.3 | Manage big data and move rows into the big data storage | If set to False, the user cannot enable/disable big data management in a base, nor can the user move rows into the big data storage; if set to False, but big data is enabled in a base, the user can create and access big data views as well as unarchive rows. | +| Permission | Added in version | Permission to ... | Additional information | +| ------------------------------ | ---------------- | ------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| can_add_dtable | 1.0 | Create bases | If set to False, the user cannot create bases, neither under "My bases" nor in groups. | +| can_add_group | 1.0 | Create groups | If set to False, the user cannot create groups. The permission can_add_dtable is necessary to create bases inside a group. | +| can_generate_external_link | 1.0 | Create external links | If set to False, the user cannot create external links. (The menu item "External link" in the share dialog is hidden.) | +| can_create_common_dataset | 1.0 | Create common datasets (CDS) | If set to False, the user cannot create CDS. | +| can_use_advanced_permissions | 1.1 | Use advanced permissions | Advanced permissions include table permissions, column permissions, view share, custom sharing permissions, and row locking. | +| can_run_python_script | 1.4 | Run Python scripts | If set to False, the action "Run script" in the button column and "Run script" in the script side panel are disabled; in automation rules, the action "Run Python script" is not available. The execution of Python scripts requires the installation of [Python Pipeline](../installation/components/python-pipeline.md). Does not apply to org users and group bases. | +| can_use_advanced_customization | 2.0 | Use advanced customizations | Advanced customization includes custom team logo, custom form logo, custom URL for forms and app, base security settings, and role permissions in apps. | +| can_use_external_app | 2.2 | Create and manage apps | If set to False, the user cannot create apps or access apps in edit mode. (The app-icon is hidden in the base.) | +| can_use_automation_rules | 2.2 | Create and manage automation rules | If set to False, the user cannot create or modify automation rules. (The menu item "Automation rules" is hidden in the base.) Does not apply to org users and group bases. | +| can_archive_rows | 2.3 | Manage big data and move rows into the big data storage | If set to False, the user cannot enable/disable big data management in a base, nor can the user move rows into the big data storage; if set to False, but big data is enabled in a base, the user can create and access big data views as well as unarchive rows. | The default value for all permissions is True. This means that if a permission is not specifically set, the role grants the permission. @@ -36,17 +36,17 @@ The default value for all permissions is True. This means that if a permission i The following quotas are supported in user roles: -| Quota | Added in version | Description | Additional information | -| ------------------------------ | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| role_asset_quota | 1.0 | Total storage quota for all personal bases: '1G' means a limit of one gigabyte for files and images (assets); '' means no storage quota for assets | Assets in shared bases owned by another user and assets in group bases do not count against the storage quota. Does NOT apply to org users. | -| row_limit | 1.0 | Total row limit for all personal bases: 10000 means a limit of 10 000 rows; -1 means no row limit | Rows in shared bases owned by another user, rows in group bases, and rows in the big data storage do not count against the row limit. Does NOT apply to org users. | -| big_data_row_limit | 3.1 | Total row limit in big data storage for all bases: 100000 means a limit of 100 000 rows | This item is used for the role of teams rather than users. Does NOT apply to org users. | -| big_data_storage_quota | 4.3 | Total storage quota for all bases in big data storage: '1G' means a limit of one gigabyte; '' means no storage quota for big data storage. | Assets in rows in the big data storage do not count against this quota. This item is used for the role of teams rather than users. Does NOT apply to org users. | -| scripts_running_limit | 2.3 | Total number of _Python_ scripts run within a month: 100 means 100 script runs per month; -1 means unlimited script runs | The script run counter is reset at the beginning of every month. | -| snapshot_days | 2.1 | Retention period for snapshots in days: 180 means a storage period of 180 days; no value means an unlimited retention period | Snapshots older than the retention period are automatically removed. | -| share_limit | | Max number of users a base can be shared with: 100 means a base can be shared with 100 users | | -| ai_credit_per_user | 6.0 | The maximum AI quota allowed per user per month (i.e., the maximum amount of tokens that can be used in a single month, converted into an amount. In team mode, the total quota within the team will be shared). `-1` means unlimited quota. | | - +| Quota | Added in version | Description | Additional information | +| --------------------------------- | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| role_asset_quota | 1.0 | Total storage quota for all personal bases: '1G' means a limit of one gigabyte for files and images (assets); '' means no storage quota for assets | Assets in shared bases owned by another user and assets in group bases do not count against the storage quota. Does NOT apply to org users. | +| row_limit | 1.0 | Total row limit for all personal bases: 10000 means a limit of 10 000 rows; -1 means no row limit | Rows in shared bases owned by another user, rows in group bases, and rows in the big data storage do not count against the row limit. Does NOT apply to org users. | +| big_data_row_limit | 3.1 | Total row limit in big data storage for all bases: 100000 means a limit of 100 000 rows | This item is used for the role of teams rather than users. Does NOT apply to org users. | +| big_data_storage_quota | 4.3 | Total storage quota for all bases in big data storage: '1G' means a limit of one gigabyte; '' means no storage quota for big data storage. | Assets in rows in the big data storage do not count against this quota. This item is used for the role of teams rather than users. Does NOT apply to org users. | +| scripts_running_limit | 2.3 | Total number of _Python_ scripts run within a month: 100 means 100 script runs per month; -1 means unlimited script runs | The script run counter is reset at the beginning of every month. | +| snapshot_days | 2.1 | Retention period for snapshots in days: 180 means a storage period of 180 days; no value means an unlimited retention period | Snapshots older than the retention period are automatically removed. | +| share_limit | | Max number of users a base can be shared with: 100 means a base can be shared with 100 users | | +| ai_credit_per_user | 6.0 | The maximum AI quota allowed per user per month (i.e., the maximum amount of tokens that can be used in a single month, converted into an amount. In team mode, the total quota within the team will be shared). `-1` means unlimited quota. | | +| monthly_automation_limit_per_user | 6.1 | The maximum number of automation executions per user per month. In team mode, the total number of allowed executions within the team will be shared. `-1` allows for an unlimited number of executions. | | ### Standard User Roles @@ -122,18 +122,18 @@ Similar to a user role, an administrator role is comprised of several permission The following permissions are supported in administrator roles: -| Permission | Added in version | Permission to ... | Additional information | -| ------------------------------ | ---------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| can_view_system_info | 1.0 | See/access "Info" menu in System admin | | -| can_view_statistic | 1.0 | See/access "Statistic" menu in System admin | | -| can_config_system | 1.0 | See/access "Settings" menu in System admin | | -| can_manage_user | 1.0 | See/access "Users" menu in System admin | | -| can_manage_group | 1.0 | See/access "Groups" menu in System admin | | -| can_manage_external_link | 1.0 | See/access "External links" menu in System admin | | -| can_view_admin_log | 1.0 | See/access "Admin logs" menu in System admin | | -| can_manage_user_log | 1.0 | See/access the tab "Login logs" in "Audit logs" menu in System admin | | -| can_manage_audit_log | 1.0 | See/access the tabs "Action logs" and "File access logs" in "Audit logs" menu in System admin | | -| can_manage_organization | 1.0 | See/access "Organizations" menu in System admin | | +| Permission | Added in version | Permission to ... | Additional information | +| ------------------------ | ---------------- | --------------------------------------------------------------------------------------------- | ---------------------- | +| can_view_system_info | 1.0 | See/access "Info" menu in System admin | | +| can_view_statistic | 1.0 | See/access "Statistic" menu in System admin | | +| can_config_system | 1.0 | See/access "Settings" menu in System admin | | +| can_manage_user | 1.0 | See/access "Users" menu in System admin | | +| can_manage_group | 1.0 | See/access "Groups" menu in System admin | | +| can_manage_external_link | 1.0 | See/access "External links" menu in System admin | | +| can_view_admin_log | 1.0 | See/access "Admin logs" menu in System admin | | +| can_manage_user_log | 1.0 | See/access the tab "Login logs" in "Audit logs" menu in System admin | | +| can_manage_audit_log | 1.0 | See/access the tabs "Action logs" and "File access logs" in "Audit logs" menu in System admin | | +| can_manage_organization | 1.0 | See/access "Organizations" menu in System admin | | ### Standard Admininstrator Roles From f25d4c7b2f9029eb9ecf1bc8679af364b9f0098a Mon Sep 17 00:00:00 2001 From: Simon Hammes Date: Thu, 12 Feb 2026 14:21:56 +0100 Subject: [PATCH 2/7] EMAIL_USE_SSL can now be configured via ENV --- docs/configuration/sending-email.md | 43 +++++++++++++++++------------ 1 file changed, 25 insertions(+), 18 deletions(-) diff --git a/docs/configuration/sending-email.md b/docs/configuration/sending-email.md index 7a7acfec3..16bb91fa1 100644 --- a/docs/configuration/sending-email.md +++ b/docs/configuration/sending-email.md @@ -18,15 +18,16 @@ There are two ways to configure this SMTP account for system wide emails. The SeaTable Server image supports auto configuration via environment variables. Add these variables to your .env file to configure the SMTP account. - | Environment variable | Description | Example values | - | ------------------------------ | ------------------------------------------- | ------------------------------ | - | `SEATABLE_EMAIL_USE_TLS` | Activate/Deactivate TLS/SSL encryption | `true` or leave empty. | - | `SEATABLE_EMAIL_HOST` | URL or IP address or the SMTP server | `mail.gmx.net` | - | `SEATABLE_EMAIL_HOST_USER` | Username for authentication | `seatable@gmx.de` | - | `SEATABLE_EMAIL_HOST_PASSWORD` | Password for authentication | `topsecret` | - | `SEATABLE_EMAIL_PORT` | Port that should be used | Typically `25`, `587` or `465` | - | `SEATABLE_DEFAULT_FROM_EMAIL` | Used for `From:` | `seatable@gmx.de` | - | `SEATABLE_SERVER_EMAIL` | Used for `From:` in case of error reporting | `seatable@gmx.de` | + | Environment variable | Description | Example values | + | ------------------------------ | -------------------------------------------------------------- | ------------------------------ | + | `SEATABLE_EMAIL_USE_TLS` | Activate/Deactivate TLS/SSL encryption | `true` or leave empty. | + | `SEATABLE_EMAIL_USE_SSL` | Activate/Deactivate SSL encryption (only available as of v6.1) | `true` or leave empty. | + | `SEATABLE_EMAIL_HOST` | URL or IP address or the SMTP server | `mail.gmx.net` | + | `SEATABLE_EMAIL_HOST_USER` | Username for authentication | `seatable@gmx.de` | + | `SEATABLE_EMAIL_HOST_PASSWORD` | Password for authentication | `topsecret` | + | `SEATABLE_EMAIL_PORT` | Port that should be used | Typically `25`, `587` or `465` | + | `SEATABLE_DEFAULT_FROM_EMAIL` | Used for `From:` | `seatable@gmx.de` | + | `SEATABLE_SERVER_EMAIL` | Used for `From:` in case of error reporting | `seatable@gmx.de` | See the examples at the end of this article for easy copy-and-paste use. @@ -48,11 +49,6 @@ There are two ways to configure this SMTP account for system wide emails. If you want to use the email service without authentication, leave `EMAIL_HOST_USER` and `EMAIL_HOST_PASSWORD` **blank** (`''`). -!!! warning "SSL (instead of TLS) is not yet supported via environment variable" - - If you mail provider requires SSL instead of TLS, you need to configure your SMTP Settings via the configuration file `dtable_web_settings.py`. - SSL can not be set via environment variable. - Restart SeaTable service to reload the changes. ## Debugging @@ -130,7 +126,7 @@ SeaTable Cloud uses the SMTP relay of Brevo. === "Configuration file" - ```python + ```ini EMAIL_USE_TLS = True EMAIL_HOST = 'smtp-relay.sendinblue.com' EMAIL_HOST_USER = 'username@domain.com' @@ -148,8 +144,19 @@ If you are using Infomaniak as email server, you can use the following settings. !!! warning "SSL support missing" - Infomaniak requires SSL instead of TLS, therefore a configuration via environment variables is not yet possible. - Please use the configuration file approach instead. + Infomaniak requires SSL instead of TLS. Configuring this via environment variables is only possible as of v6.1. + Please use the configuration file approach instead in case you haven't upgraded yet. + + ```ini + SEATABLE_EMAIL_USE_TLS=false + SEATABLE_EMAIL_USE_SSL=true + SEATABLE_EMAIL_HOST='mail.infomaniak.com' + SEATABLE_EMAIL_HOST_USER='username@domain.com' + SEATABLE_EMAIL_HOST_PASSWORD='password' + SEATABLE_EMAIL_PORT=465 + SEATABLE_DEFAULT_FROM_EMAIL='SeaTable ' + SEATABLE_SERVER_EMAIL='noreply@domain.com' + ``` === "Configuration file" @@ -162,4 +169,4 @@ If you are using Infomaniak as email server, you can use the following settings. EMAIL_PORT = 465 DEFAULT_FROM_EMAIL = 'SeaTable ' SERVER_EMAIL = 'noreply@domain.com' - ``` \ No newline at end of file + ``` From 40ddf320e62752e0c00ba6948aef933cf7b8d2de Mon Sep 17 00:00:00 2001 From: Simon Hammes Date: Thu, 12 Feb 2026 14:24:33 +0100 Subject: [PATCH 3/7] Add SEATABLE_EMAIL_USE_SSL to list of environment variables --- docs/configuration/environment-variables.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/configuration/environment-variables.md b/docs/configuration/environment-variables.md index 5d3cf8aba..e17749367 100644 --- a/docs/configuration/environment-variables.md +++ b/docs/configuration/environment-variables.md @@ -41,6 +41,7 @@ PYTHON_SCHEDULER_AUTH_TOKEN='topsecret' # E-Mail SEATABLE_EMAIL_USE_TLS= # (12)! +SEATABLE_EMAIL_USE_SSL= SEATABLE_EMAIL_HOST= SEATABLE_EMAIL_HOST_USER= SEATABLE_EMAIL_HOST_PASSWORD= From 3900e0ff15db45468bc4264fbe7670f4249a9500 Mon Sep 17 00:00:00 2001 From: Simon Hammes Date: Fri, 13 Feb 2026 16:10:32 +0100 Subject: [PATCH 4/7] Restructure configuration section --- .../dtable-api-gateway.md} | 0 .../dtable-db.md} | 0 .../dtable-events.md} | 0 .../dtable-server.md} | 0 .../dtable-storage-server.md} | 0 .../dtable-web.md} | 0 .../gunicorn.md} | 0 .../{nginx-conf.md => components/nginx.md} | 0 .../seafile.md} | 0 mkdocs.yml | 24 +++++++++---------- 10 files changed, 12 insertions(+), 12 deletions(-) rename docs/configuration/{dtable-api-gateway-conf.md => components/dtable-api-gateway.md} (100%) rename docs/configuration/{dtable-db-conf.md => components/dtable-db.md} (100%) rename docs/configuration/{dtable-events-conf.md => components/dtable-events.md} (100%) rename docs/configuration/{dtable-server-config.md => components/dtable-server.md} (100%) rename docs/configuration/{dtable-storage-server-conf.md => components/dtable-storage-server.md} (100%) rename docs/configuration/{dtable-web-settings.md => components/dtable-web.md} (100%) rename docs/configuration/{gunicorn-py.md => components/gunicorn.md} (100%) rename docs/configuration/{nginx-conf.md => components/nginx.md} (100%) rename docs/configuration/{seafile-conf.md => components/seafile.md} (100%) diff --git a/docs/configuration/dtable-api-gateway-conf.md b/docs/configuration/components/dtable-api-gateway.md similarity index 100% rename from docs/configuration/dtable-api-gateway-conf.md rename to docs/configuration/components/dtable-api-gateway.md diff --git a/docs/configuration/dtable-db-conf.md b/docs/configuration/components/dtable-db.md similarity index 100% rename from docs/configuration/dtable-db-conf.md rename to docs/configuration/components/dtable-db.md diff --git a/docs/configuration/dtable-events-conf.md b/docs/configuration/components/dtable-events.md similarity index 100% rename from docs/configuration/dtable-events-conf.md rename to docs/configuration/components/dtable-events.md diff --git a/docs/configuration/dtable-server-config.md b/docs/configuration/components/dtable-server.md similarity index 100% rename from docs/configuration/dtable-server-config.md rename to docs/configuration/components/dtable-server.md diff --git a/docs/configuration/dtable-storage-server-conf.md b/docs/configuration/components/dtable-storage-server.md similarity index 100% rename from docs/configuration/dtable-storage-server-conf.md rename to docs/configuration/components/dtable-storage-server.md diff --git a/docs/configuration/dtable-web-settings.md b/docs/configuration/components/dtable-web.md similarity index 100% rename from docs/configuration/dtable-web-settings.md rename to docs/configuration/components/dtable-web.md diff --git a/docs/configuration/gunicorn-py.md b/docs/configuration/components/gunicorn.md similarity index 100% rename from docs/configuration/gunicorn-py.md rename to docs/configuration/components/gunicorn.md diff --git a/docs/configuration/nginx-conf.md b/docs/configuration/components/nginx.md similarity index 100% rename from docs/configuration/nginx-conf.md rename to docs/configuration/components/nginx.md diff --git a/docs/configuration/seafile-conf.md b/docs/configuration/components/seafile.md similarity index 100% rename from docs/configuration/seafile-conf.md rename to docs/configuration/components/seafile.md diff --git a/mkdocs.yml b/mkdocs.yml index db6325a6d..597011add 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -239,18 +239,18 @@ nav: - SAML for teams: configuration/authentication/saml-team.md - JWT-Token: configuration/authentication/jwt.md - Switch authentication: configuration/authentication/auth-switch.md - - Configuration Files / Options: - - Environment variables: configuration/environment-variables.md - - Configuration files: - - dtable-db.conf: configuration/dtable-db-conf.md - - dtable-events.conf: configuration/dtable-events-conf.md - - dtable_server_config.json: configuration/dtable-server-config.md - - dtable-storage-server.conf: configuration/dtable-storage-server-conf.md - - dtable_web_settings.py: configuration/dtable-web-settings.md - - dtable-api-gateway.conf: configuration/dtable-api-gateway-conf.md - - seafile.conf: configuration/seafile-conf.md - - gunicorn.py: configuration/gunicorn-py.md - - nginx.conf: configuration/nginx-conf.md + - Configuration: + - Environment Variables: configuration/environment-variables.md + - Components: + - dtable-api-gateway: configuration/components/dtable-api-gateway.md + - dtable-db: configuration/components/dtable-db.md + - dtable-events: configuration/components/dtable-events.md + - dtable-server: configuration/components/dtable-server.md + - dtable-storage-server: configuration/components/dtable-storage-server.md + - dtable-web: configuration/components/dtable-web.md + - seafile: configuration/components/seafile.md + - gunicorn: configuration/components/gunicorn.md + - nginx: configuration/components/nginx.md - UI Customization: - Overview: customization/overview.md From 1ffd71afb1a0af0517747a7dbe4389a32c716c5b Mon Sep 17 00:00:00 2001 From: Simon Hammes Date: Thu, 12 Feb 2026 15:26:02 +0100 Subject: [PATCH 5/7] Document environment variables --- .../components/dtable-api-gateway.md | 3 + docs/configuration/components/dtable-db.md | 2 + .../configuration/components/dtable-events.md | 61 +++++++++++++------ .../configuration/components/dtable-server.md | 45 +++++++++++--- .../components/dtable-storage-server.md | 35 +++++++++-- .../{environment-variables.md => overview.md} | 30 ++++++--- mkdocs.yml | 2 +- 7 files changed, 136 insertions(+), 42 deletions(-) rename docs/configuration/{environment-variables.md => overview.md} (76%) diff --git a/docs/configuration/components/dtable-api-gateway.md b/docs/configuration/components/dtable-api-gateway.md index fc763e435..d19a639f0 100644 --- a/docs/configuration/components/dtable-api-gateway.md +++ b/docs/configuration/components/dtable-api-gateway.md @@ -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. @@ -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 diff --git a/docs/configuration/components/dtable-db.md b/docs/configuration/components/dtable-db.md index 187186d47..4c1674ae0 100644 --- a/docs/configuration/components/dtable-db.md +++ b/docs/configuration/components/dtable-db.md @@ -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 | diff --git a/docs/configuration/components/dtable-events.md b/docs/configuration/components/dtable-events.md index 0e3aa751c..1b6a9f6c7 100644 --- a/docs/configuration/components/dtable-events.md +++ b/docs/configuration/components/dtable-events.md @@ -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. @@ -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. @@ -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. @@ -33,17 +72,15 @@ 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" @@ -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. @@ -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]` diff --git a/docs/configuration/components/dtable-server.md b/docs/configuration/components/dtable-server.md index b8c5fceb3..d4060e96d 100644 --- a/docs/configuration/components/dtable-server.md +++ b/docs/configuration/components/dtable-server.md @@ -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. @@ -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. @@ -18,7 +46,7 @@ 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: @@ -26,8 +54,6 @@ By default, `dtable_server_config.json` will be empty after the first startup of {} ``` -## Available configuration options - ### Redis | Parameter | Description | Default | @@ -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 @@ -92,6 +112,11 @@ 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`. diff --git a/docs/configuration/components/dtable-storage-server.md b/docs/configuration/components/dtable-storage-server.md index 3a4314f24..3e983c748 100644 --- a/docs/configuration/components/dtable-storage-server.md +++ b/docs/configuration/components/dtable-storage-server.md @@ -1,6 +1,6 @@ # Configuration of dtable-storage-server -This is a cheat sheet for the [dtable-storage-server](/introduction/architecture/#dtable-storage-server) configuration file `dtable-storage-server.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-storage-server](/introduction/architecture/#dtable-storage-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. @@ -10,6 +10,35 @@ 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-storage-server](/introduction/architecture/#dtable-storage-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: + - STORAGE_SERVER_SNAPSHOT_KEEP_DAYS=720 +``` + +This file then needs to be added to the `COMPOSE_FILE` variable inside your `.env` file. +This ensures that SeaTable upgrades stay seamless. + +### Snapshots + +| Environment Variable | Description | Default | +| --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | +| `STORAGE_SERVER_ENABLE_SNAPSHOT_CLEANUP` | Controls snapshot cleanup. Activate on only one node in multi-server setups. | true | +| `STORAGE_SERVER_SNAPSHOT_CLEANUP_AT` | Specifies the time when old snapshots are deleted. | 03:00 | +| `STORAGE_SERVER_SNAPSHOT_KEEP_DAYS` | Specifies the snapshot retention period in days. Older snapshots are deleted. | 180 | +| `STORAGE_SERVER_SNAPSHOT_KEEP_FREQUENCY_DAYS` | Specifies daily snapshot period for changed bases. After this, only one snapshot per month is kept. Default is 0 (always daily). Requires `STORAGE_SERVER_SNAPSHOT_KEEP_DAYS` to be set and > `STORAGE_SERVER_SNAPSHOT_KEEP_FREQUENCY_DAYS`. | 0 | + +## Configuration File + ??? 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. @@ -20,7 +49,7 @@ 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** This is a typical configuration file, created automatically on the first startup by SeaTable. @@ -38,8 +67,6 @@ interval = 86400 keep_days = 180 ``` -## Available configuration options - ### `[general]` This section contains general settings about the `dtable-storage-server` service. diff --git a/docs/configuration/environment-variables.md b/docs/configuration/overview.md similarity index 76% rename from docs/configuration/environment-variables.md rename to docs/configuration/overview.md index e17749367..1b423265f 100644 --- a/docs/configuration/environment-variables.md +++ b/docs/configuration/overview.md @@ -1,8 +1,21 @@ -# List of available environment variables +# Overview + +SeaTable supports two configuration mechanisms: + +- Environment Variables +- Configuration Files + +Environment variables can be used for the initial deployment and adjustment of the most important settings. +The following pages denote the reference for the configuration file for each system component. + +# List of Available Environment Variables SeaTable supports environment variables for initial deployment and configuration of some settings. This is the complete list of supported settings. With every version, new variables will be added. Please note that this page only denotes environment variables used by SeaTable and its core components. +Since these variables are already defined inside the `seatable-server.yml` file that you have downloaded during the [installation process](../installation/basic-setup.md), +it is sufficient to set/modify these variables directly inside your `.env` file. There's no need to modify the `*.yml` files in order to adjust these settings. + ```ini # components to be used COMPOSE_FILE='caddy.yml,seatable-server.yml' # (1)! @@ -39,6 +52,10 @@ SEADOC_PORT='' PYTHON_SCHEDULER_URL='http://python-scheduler' # (13)! PYTHON_SCHEDULER_AUTH_TOKEN='topsecret' +# SeaTable AI +ENABLE_SEATABLE_AI='false' # (14)! +SEATABLE_AI_SERVER_URL='http://seatable-ai:8888' + # E-Mail SEATABLE_EMAIL_USE_TLS= # (12)! SEATABLE_EMAIL_USE_SSL= @@ -55,16 +72,8 @@ SEATABLE_TEMPLATE_BASE_API_TOKEN= SEATABLE_TEMPLATE_TABLE_NAME= SEATABLE_ENABLE_CREATE_BASE_FROM_TEMPLATE= -# SeaTable Storage Server (Cleanup of snapshots) -# not yet part of the seatable-server.yml -#STORAGE_SERVER_ENABLE_SNAPSHOT_CLEANUP= -#STORAGE_SERVER_SNAPSHOT_CLEANUP_AT= -#STORAGE_SERVER_SNAPSHOT_KEEP_DAYS= -#STORAGE_SERVER_SNAPSHOT_KEEP_FREQUENCY_DAYS= - # Logging SEATABLE_LOG_LEVEL=INFO # (10)! -#SEATABLE_LOG_TO_STDOUT= # Docker Images # You can use these variables to override the default images @@ -90,7 +99,8 @@ SEATABLE_HELP_LINK=https://help.seatable.com # (11)! 11. Please refer to [Manual Link](../customization/manual-in-nav.md) for more information. 12. Please refer to [Email Sending](./sending-email.md) for more information. 13. Please refer to [Python Pipeline](../installation/components/python-pipeline.md) for more information. +14. Please refer to [SeaTable AI](../installation/components/seatable-ai.md) for more information. \ No newline at end of file +--> diff --git a/mkdocs.yml b/mkdocs.yml index 597011add..8854fbb03 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -240,7 +240,7 @@ nav: - JWT-Token: configuration/authentication/jwt.md - Switch authentication: configuration/authentication/auth-switch.md - Configuration: - - Environment Variables: configuration/environment-variables.md + - Overview: configuration/overview.md - Components: - dtable-api-gateway: configuration/components/dtable-api-gateway.md - dtable-db: configuration/components/dtable-db.md From 97993736021fbc148899490cb6555a3c766bb20e Mon Sep 17 00:00:00 2001 From: Simon Hammes Date: Wed, 18 Feb 2026 16:20:32 +0100 Subject: [PATCH 6/7] Update links --- docs/configuration/components/dtable-db.md | 2 +- docs/configuration/components/dtable-events.md | 10 +++++----- docs/configuration/components/dtable-server.md | 6 +++--- docs/configuration/components/dtable-storage-server.md | 2 +- docs/configuration/components/dtable-web.md | 4 ++-- docs/configuration/components/nginx.md | 4 ++-- docs/configuration/components/seafile.md | 4 ++-- docs/customization/page-templates.md | 2 +- docs/installation/components/clamav.md | 2 +- docs/maintenance/backup-recovery.md | 2 +- docs/maintenance/database-cleanup.md | 4 ++-- docs/upgrade/extra-upgrade-notice.md | 6 +++--- 12 files changed, 24 insertions(+), 24 deletions(-) diff --git a/docs/configuration/components/dtable-db.md b/docs/configuration/components/dtable-db.md index 4c1674ae0..f8718791d 100644 --- a/docs/configuration/components/dtable-db.md +++ b/docs/configuration/components/dtable-db.md @@ -122,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. diff --git a/docs/configuration/components/dtable-events.md b/docs/configuration/components/dtable-events.md index 1b6a9f6c7..8fdc56b3d 100644 --- a/docs/configuration/components/dtable-events.md +++ b/docs/configuration/components/dtable-events.md @@ -85,7 +85,7 @@ enabled = true ??? 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 | | ---------- | ------------------------------------------------------------------------------------------------------- | ----------------- | @@ -99,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 | | ---------- | --------------------- | ------- | @@ -167,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 | | --------------- | --------------------------------------------------------------------------------------- | ------- | @@ -203,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`. @@ -218,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: diff --git a/docs/configuration/components/dtable-server.md b/docs/configuration/components/dtable-server.md index d4060e96d..68e47acc4 100644 --- a/docs/configuration/components/dtable-server.md +++ b/docs/configuration/components/dtable-server.md @@ -82,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 | | --------------------- | ---------------------------------------------------------------------------------- | ------- | @@ -120,7 +120,7 @@ You can use the environment variable `AUTOMATION_RATE_LIMIT_PER_BASE_MINUTE` ins ### 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 | | ---------- | ---------------------- | ----------------- | @@ -133,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 | | ----------------------------- | ---------------------------------------- | ------- | diff --git a/docs/configuration/components/dtable-storage-server.md b/docs/configuration/components/dtable-storage-server.md index 3e983c748..d0bddbefd 100644 --- a/docs/configuration/components/dtable-storage-server.md +++ b/docs/configuration/components/dtable-storage-server.md @@ -106,7 +106,7 @@ Depending on the chosen storage backend, there are additional settings: | `host` | The host address of S3 backend. Required for S3-compatible storage. Optional for AWS S3, but can be set to the endpoint you use. | | | `path_style_request` | Whether to use path style requests. For a S3-compatible storage, it should be `true`. | | | `use_https` | Whether to use https. | | -| `sse_c_key` | Use [server-side encryption with customer-provided keys](../installation/advanced/s3-encryption.md) (SSE-C). This setting is optional. | | +| `sse_c_key` | Use [server-side encryption with customer-provided keys](../../installation/advanced/s3-encryption.md) (SSE-C). This setting is optional. | | ### `[snapshot]` diff --git a/docs/configuration/components/dtable-web.md b/docs/configuration/components/dtable-web.md index 6819776d7..5d6f66151 100644 --- a/docs/configuration/components/dtable-web.md +++ b/docs/configuration/components/dtable-web.md @@ -1,6 +1,6 @@ # dtable web settings -You need to [restart SeaTable](../maintenance/restart-seatable.md) so that your changes take effect. +You need to [restart SeaTable](../../maintenance/restart-seatable.md) so that your changes take effect. You can also modify some of the config items as system administrator via web interface. These config items are saved in the database table (dtable_db/constance_config). The configuration in the database has a higher priority then the items in config file. If you want to disable settings via web interface, you can add `ENABLE_SETTINGS_VIA_WEB = False` to `dtable_web_settings.py`. @@ -33,7 +33,7 @@ If you changed your domain, the URLs in above settings must be changed according ## Sending Email Notifications -Refer to [email sending documentation](../configuration/sending-email.md). +Refer to [email sending documentation](../sending-email.md). ## User management options diff --git a/docs/configuration/components/nginx.md b/docs/configuration/components/nginx.md index 2aca66969..809349026 100644 --- a/docs/configuration/components/nginx.md +++ b/docs/configuration/components/nginx.md @@ -24,6 +24,6 @@ When you update SeaTable, all default files in `/opt/seatable-compose` will be o 3. **Update the .env File:** In your `.env` file, update the `COMPOSE_FILES` variable to include your `custom-seatable-server.yml` file. -After making changes, [restart the SeaTable container](../maintenance/restart-seatable.md) for your changes to take effect. +After making changes, [restart the SeaTable container](../../maintenance/restart-seatable.md) for your changes to take effect. -This ensures that your custom configuration is used instead of the original files. \ No newline at end of file +This ensures that your custom configuration is used instead of the original files. diff --git a/docs/configuration/components/seafile.md b/docs/configuration/components/seafile.md index b0cb9bfbe..d89ad66cb 100644 --- a/docs/configuration/components/seafile.md +++ b/docs/configuration/components/seafile.md @@ -51,7 +51,7 @@ keep_days = 60 ### `[database]` -Since version 5.3, Seafile reads the main database configuration settings from [environment variables](/configuration/environment-variables). +Since version 5.3, Seafile reads the main database configuration settings from [environment variables](/configuration/overview). The following options are optional and can be used to further tweak Seafile: @@ -66,7 +66,7 @@ The following options are optional and can be used to further tweak Seafile: ??? note "[database] is not necessary anymore" - Since version 5.3, `Seafile` reads the main database settings from [environment variables](/configuration/environment-variables). + Since version 5.3, `Seafile` reads the main database settings from [environment variables](/configuration/overview). The section `[database]` contained options for accessing the MariaDB database used by `Seafile`. diff --git a/docs/customization/page-templates.md b/docs/customization/page-templates.md index a7c24ef9d..42ae5289b 100644 --- a/docs/customization/page-templates.md +++ b/docs/customization/page-templates.md @@ -1,6 +1,6 @@ # SeaTable Frontend Modification -With the help of [dtable_web_settings.py](../configuration/dtable-web-settings.md) SeaTable offers a wealth of configuration options to enable or disable individual functions in the frontend or to customize the frontend to your own needs. +With the help of [dtable_web_settings.py](../configuration/components/dtable-web.md) SeaTable offers a wealth of configuration options to enable or disable individual functions in the frontend or to customize the frontend to your own needs. At the same time, you can only intervene in the design of the frontend to a limited extent with the help of the configuration files. For this, SeaTable offers a sophisticated template system to selectively replace individual page areas with their own versions. diff --git a/docs/installation/components/clamav.md b/docs/installation/components/clamav.md index 6163f346b..b4e85e6ea 100644 --- a/docs/installation/components/clamav.md +++ b/docs/installation/components/clamav.md @@ -70,7 +70,7 @@ ClamAV offers advanced configuration options in dtable-events.conf, such as: - **Ignored file extensions**: Specify file types to exclude from scanning. - **Thread count**: Define how many threads are used for scanning. -For more details, refer to the [dtable-events configuration documentation](../../configuration/dtable-events-conf.md). +For more details, refer to the [dtable-events configuration documentation](../../configuration/components/dtable-events.md). ## Updating Virus Signature Files diff --git a/docs/maintenance/backup-recovery.md b/docs/maintenance/backup-recovery.md index 7d78ea00b..aa0f1b276 100644 --- a/docs/maintenance/backup-recovery.md +++ b/docs/maintenance/backup-recovery.md @@ -115,7 +115,7 @@ Inside the `/opt/seatable-server/seatable` directory, there are multiple folders The `db-data` directory contains big data content in a sql-like database structure. **It is not recommended to save this folder.** Instead the big data content is dumped to the storage-data folder automatically every 24 hours by default. Therefore it is already part of your backup. - 1. To backup big data more often, change the [dtable-db settings](http://127.0.0.1:8000/configuration/dtable-db-conf/#backup). + 1. To backup big data more often, change the [dtable-db settings](/configuration/components/dtable-db). 2. To force the dump of big data you could execute the following command: ```sh diff --git a/docs/maintenance/database-cleanup.md b/docs/maintenance/database-cleanup.md index e6de7c75f..7eb60ffdb 100644 --- a/docs/maintenance/database-cleanup.md +++ b/docs/maintenance/database-cleanup.md @@ -4,11 +4,11 @@ -Since version 5.3, SeaTable automatically cleans up its database. A background task regularly removes outdated entries from tables that tend to accumulate unnecessary data and cause database bloat. For details on which tables are cleaned and the specific retention periods, refer to the [configuration of dtable-events](../configuration/dtable-events-conf.md#clean-db). +Since version 5.3, SeaTable automatically cleans up its database. A background task regularly removes outdated entries from tables that tend to accumulate unnecessary data and cause database bloat. For details on which tables are cleaned and the specific retention periods, refer to the [configuration of dtable-events](../configuration/components/dtable-events.md#clean-db). !!! warning "Not enabled by default for updated systems" - Database cleanup is enabled by default for new SeaTable installations (version 5.3 and later). However, if you upgrade an existing system to 5.3, the cleanup feature is not activated automatically. In this case, you need to manually configure the [cleanup in dtable-events](../configuration/dtable-events-conf.md#clean-db). + Database cleanup is enabled by default for new SeaTable installations (version 5.3 and later). However, if you upgrade an existing system to 5.3, the cleanup feature is not activated automatically. In this case, you need to manually configure the [cleanup in dtable-events](../configuration/components/dtable-events.md#clean-db). ## Background information and manual cleanup diff --git a/docs/upgrade/extra-upgrade-notice.md b/docs/upgrade/extra-upgrade-notice.md index c81dff9f2..0fff0bd78 100644 --- a/docs/upgrade/extra-upgrade-notice.md +++ b/docs/upgrade/extra-upgrade-notice.md @@ -132,7 +132,7 @@ Of course, you can skip this script and make the changes manually. The following enabled = true ``` - Please refer to [this document](../configuration/dtable-events-conf.md#clean-db) for detailed information on the possible configuration options. + Please refer to [this document](../configuration/components/dtable-events.md#clean-db) for detailed information on the possible configuration options. ??? info "ccnet.conf is obsolete" @@ -221,8 +221,8 @@ Of course, you can skip this script and make the changes manually. The following With version 5.2, SeaTable introduces a tiered retention strategy for Big Data Backups and Base Snapshots. While updating your settings is optional, it's recommended to take advantage of the new features. You can find the new options in: - - [dtable-db.conf](../configuration/dtable-db-conf.md) - - [dtable-storage-server.conf](../configuration/dtable-storage-server-conf.md) + - [dtable-db.conf](../configuration/components/dtable-db.md) + - [dtable-storage-server.conf](../configuration/components/dtable-storage-server.md) ??? info "New Whiteboard plugin" From 134e357e83c9a6bf678065115473e7ca6d743fc7 Mon Sep 17 00:00:00 2001 From: Simon Hammes Date: Wed, 18 Feb 2026 16:24:24 +0100 Subject: [PATCH 7/7] Update links --- docs/configuration/components/dtable-server.md | 2 +- docs/introduction/architecture.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/configuration/components/dtable-server.md b/docs/configuration/components/dtable-server.md index 68e47acc4..1dd7026c5 100644 --- a/docs/configuration/components/dtable-server.md +++ b/docs/configuration/components/dtable-server.md @@ -145,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 | | ------------- | ---------------------------------------------------------------------------------------------------- | ------- | diff --git a/docs/introduction/architecture.md b/docs/introduction/architecture.md index 204b65f00..22c7d49fe 100644 --- a/docs/introduction/architecture.md +++ b/docs/introduction/architecture.md @@ -186,7 +186,7 @@ By default, SeaTable Server stores user data in the following structure on the l These directories contain the following content: -- **conf**: configuration files for SeaTable Server components (see [Configuration](../../configuration/dtable-web-settings/)) +- **conf**: configuration files for SeaTable Server components (see [Configuration](../configuration/overview.md)) - **logs**: log files generated by SeaTable Server components (see [Logging](../../maintenance/logs/)) - **db-data**: data stored in big data storage - **seahub-data**: avatars and image thumbnails