diff --git a/docs/configuration/components/dtable-api-gateway.md b/docs/configuration/components/dtable-api-gateway.md index 4e776c95..b0fe30bf 100644 --- a/docs/configuration/components/dtable-api-gateway.md +++ b/docs/configuration/components/dtable-api-gateway.md @@ -1,19 +1,85 @@ --- -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 + + + +This section lists the environment variables read by the [api-gateway](../../introduction/architecture.md#api-gateway). + +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: + - API_GATEWAY_BASE_API_LIMIT_PER_MINUTE=1000 +``` + +This file then needs to be added to the `COMPOSE_FILE` variable inside your `.env` file. +This ensures that SeaTable upgrades stay seamless. + +### 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 +88,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. diff --git a/docs/configuration/components/dtable-db.md b/docs/configuration/components/dtable-db.md index a59b7629..0f827ced 100644 --- a/docs/configuration/components/dtable-db.md +++ b/docs/configuration/components/dtable-db.md @@ -1,19 +1,115 @@ --- -description: Complete reference for dtable-db configuration in dtable-db.conf including storage, caching, SQL limits, and big data backup options. +description: Complete reference for dtable-db configuration including storage, caching, SQL limits, and big data backup options. --- # Configuration of dtable-db -This is a cheat sheet for the [dtable-db](/introduction/architecture.md#dtable-db) configuration file `dtable-db.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-db](../../introduction/architecture.md#dtable-db). +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. - -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 + + + +This section lists the environment variables read by [dtable-db](../../introduction/architecture.md#dtable-db). + +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: + - DTABLE_DB_BACKUP_KEEP_NUM=100 +``` + +This file then needs to be added to the `COMPOSE_FILE` variable inside your `.env` file. +This ensures that SeaTable upgrades stay seamless. + +### General + +| Environment Variable | Description | Default | +| ----------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ------- | +| `DTABLE_DB_HOST` | The address dtable-db listens on. | 0.0.0.0 | +| `DTABLE_DB_PORT` | The port dtable-db listens on. | 7777 | +| `DTABLE_DB_SLOW_QUERY_THRESHOLD` | If the processing time exceeds this threshold, a slow log will be recorded in addition to the normal log. Unit is in milliseconds. | 1000 | +| `DTABLE_DB_ROW_UPDATE_LIMIT` | Sets the rate or row updates, deletes, and inserts per second and per base. | 5000 | +| `DTABLE_DB_GLOBAL_ROW_UPDATE_LIMIT` | Sets the global rate of row updates, deletes, and inserts per minute, affecting SQL and API operations. | 30000 | +| `DTABLE_DB_QUERY_PER_MINUTE_LIMIT` | Sets the total max. of API calls per minute for the entire system. The default is suitable for most cases. | 50000 | + +### Storage + +These settings define where the database files for bases with activated big data backend are stored and when old data is cleaned: + +| Environment Variable | Description | Default | +| ------------------------------ | ------------------------------------------------------------- | --------------------- | +| `DTABLE_DB_DATA_DIR` | Location of the data directory inside the container. | /opt/seatable/db-data | +| `DTABLE_DB_STORAGE_CLEANUP_AT` | The execution time of clean up deleted data. Format is hh:mm. | 00:00 | + +### DTable Cache + +| Environment Variable | Description | Default | +| ---------------------------- | ---------------------------------- | --------------------- | +| `INNER_DTABLE_SERVER_URL` | URL of the dtable-server instance. | http://127.0.0.1:5000 | +| `DTABLE_DB_TOTAL_CACHE_SIZE` | The base cache size in MB. | 2000 | + +### SQL + +General configuration options of the output of the SQL endpoint: + +| Environment Variable | Description | Default | +| -------------------------------------- | -------------------------------------------------------------------------------------------------------------- | ------- | +| `DTABLE_DB_SQL_DEFAULT_RESULT_ROWS` | Maximal number of rows returned by a query if there's no `LIMIT` specified. | 100 | +| `DTABLE_DB_SQL_RESULT_ROWS_HARD_LIMIT` | Maximal number of rows returned in one query (system wide). Overrides any larger `LIMIT` value in a query. | 10000 | +| `DTABLE_DB_SQL_EXEC_COST_HARD_LIMIT` | Maximal execution cost of a query. If the estimated cost of a query exceeds this limit, the query is rejected. | 5000000 | + +### Backup + +These settings allow configuring how data stored inside the big data backend is backed up: + +| Environment Variable | Description | Default | +| -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | +| `DTABLE_DB_BACKUP_AT` | The execution time of backup. Format is `hh:mm`. | 02:00 | +| `DTABLE_DB_BACKUP_KEEP_NUM` | The number of backups that will be kept, oldest backups will be removed. | 3 | +| `DTABLE_DB_BACKUP_KEEP_DAYS` | Specifies the retention period for backups in days. Older backups are deleted. Overrides `DTABLE_DB_BACKUP_KEEP_NUM` if set; otherwise, `DTABLE_DB_BACKUP_KEEP_NUM` is used. | 0 | +| `DTABLE_DB_BACKUP_KEEP_FREQUENCY_DAYS` | Specifies daily backup period. After this, only one backup per month is kept. Requires `DTABLE_DB_BACKUP_KEEP_DAYS` to be set and > `DTABLE_DB_BACKUP_KEEP_FREQUENCY_DAYS`. | 0 | + +**FIXME: dtable-storage-server URL is no longer configurable!?** + +!!! warning "Two different backup methods: which should I choose?" + + SeaTable offers two backup approaches: + + - The first uses `DTABLE_DB_BACKUP_KEEP_NUM`, creating daily backups whenever changes were made and retaining a fixed number of the most recent ones, deleting the oldest when the limit is reached. Note that no new backup will be created if no changes were made to a base. This is the default option. + + - The second approach, using `DTABLE_DB_BACKUP_KEEP_DAYS` and `DTABLE_DB_BACKUP_KEEP_FREQUENCY_DAYS`, offers a tiered retention strategy. + It creates daily backups for the recent period specified by `DTABLE_DB_BACKUP_KEEP_FREQUENCY_DAYS`, then switches to monthly backups for the older period. + This method provides detailed recent backups and efficient long-term storage, balancing data granularity with space conservation. + For example, setting `DTABLE_DB_BACKUP_KEEP_DAYS=180` and `DTABLE_DB_BACKUP_KEEP_FREQUENCY_DAYS=7` would keep daily backups for the past week, then monthly backups for the past six months (except for the past week). + +### Metrics + +| Environment Variable | Description | Default | +| ------------------------------------- | -------------------------------------------------------------------- | ------- | +| `DTABLE_DB_METRICS_ENABLE_BASIC_AUTH` | Whether basic authentication is enabled for the `/metrics` endpoint. | false | +| `DTABLE_DB_METRICS_USERNAME` | Username for basic authentication for the `/metrics` endpoint. | | +| `DTABLE_DB_METRICS_PASSWORD` | Password for basic authentication for the `/metrics` endpoint. | | + +## Configuration File (Legacy) + +!!! warning "Configuration file is not read anymore from v6.2 onwards" + + `dtable-db.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). + ??? 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. @@ -24,7 +120,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. @@ -45,8 +141,6 @@ dtable_storage_server_url = "http://127.0.0.1:6666" keep_backup_num = 3 ``` -## Available configuration options - ### `[general]` This section contains general settings about `dtable-db` service. diff --git a/docs/configuration/components/dtable-events.md b/docs/configuration/components/dtable-events.md index 548afc7e..0cc69fd8 100644 --- a/docs/configuration/components/dtable-events.md +++ b/docs/configuration/components/dtable-events.md @@ -4,11 +4,10 @@ description: Configure dtable-events for automations, email notifications, LDAP # Configuration of dtable-events -This is a cheat sheet for the possible configuration options of [dtable-events](/introduction/architecture.md#dtable-events). 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.md#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. - -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" @@ -16,7 +15,9 @@ In the default values below, a value in the form `$XYZ` refers to an environment ## Environment Variables -This section lists the environment variables read by [dtable-events](/introduction/architecture.md#dtable-events). + + +This section lists the environment variables read by [dtable-events](../../introduction/architecture.md#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. @@ -42,6 +43,67 @@ This ensures that SeaTable upgrades stay seamless. 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. +### Common Dataset Syncer + +SeaTable runs every hour this event to check for pending dataset syncs. The job processes datasets that need syncing based on their interval (per_day, per_hour) and validity. + +| Environment Variable | Description | Default | +| ------------------------------- | --------------------------------------------- | ------- | +| `COMMON_DATASET_SYNCER_ENABLED` | Enables or disables the common dataset syncer | true | + +### Database Cleanup + +**Enabled** by default since v6.2. + +This setting controls whether SeaTable runs automated database cleanup tasks at 00:30 every day. +Enabling this task ensures that your database stays lean and performs well. It also prevents the server from running out of disk space, since operation logs can take up quite a lot of space. + +In addition, the retention periods for the different database tables can be customized. +Setting any value to `0` or `-1` causes the cleanup task to be skipped for the corresponding database table. + +| Environment Variable | Description | Default | +| --------------------------------------------------- | -------------------------------------------------------------------------- | ------- | +| `CLEAN_DB_ENABLED` | Enables the automated database cleanup tasks | true | +| `CLEAN_DB_KEEP_DTABLE_SNAPSHOT_DAYS` | Retention period for snapshot entries in the database (in days) | 365 | +| `CLEAN_DB_KEEP_ACTIVITIES_DAYS` | Retention period for activities (in days) | 30 | +| `CLEAN_DB_KEEP_OPERATION_LOG_DAYS` | Retention period for operation log entries (in days) | 14 | +| `CLEAN_DB_KEEP_DELETE_OPERATION_LOG_DAYS` | Retention period for delete operations in the operation log (in days) | 30 | +| `CLEAN_DB_KEEP_DTABLE_DB_OP_LOG_DAYS` | Retention period for operation log entries inserted by dtable-db (in days) | 30 | +| `CLEAN_DB_KEEP_NOTIFICATIONS_USERNOTIFICATION_DAYS` | Retention period for user notifications (in days) | 30 | +| `CLEAN_DB_KEEP_DTABLE_NOTIFICATIONS_DAYS` | Retention period for base notifications (in days) | 30 | +| `CLEAN_DB_KEEP_SESSION_LOG_DAYS` | Retention period for session log entries (in days) | 30 | +| `CLEAN_DB_KEEP_AUTO_RULES_TASK_LOG_DAYS` | Retention period for automation rule logs (in days) | 30 | +| `CLEAN_DB_KEEP_USER_ACTIVITY_STATISTICS_DAYS` | Retention period for user activity statistics (in days) | 0 | +| `CLEAN_DB_KEEP_DTABLE_APP_PAGES_OPERATION_LOG_DAYS` | Retention period for app pages operation log entries (in days) | 14 | +| `CLEAN_DB_KEEP_EMAIL_SENDING_LOG_DAYS` | Retention period for log entries regarding sent emails (in days) | 30 | +| `CLEAN_DB_KEEP_SYSADMIN_EXTRA_USERLOGINLOG_DAYS` | Retention period for login logs (in days) | 30 | + +### Email Notices + +SeaTable runs this task every hour to send base email notifications for base updates to the users. It also generates the log file `dtable_updates_sender.log`. + +| Environment Variable | Description | Default | +| ---------------------- | ------------------------------------------------------------ | ------- | +| `EMAIL_SENDER_ENABLED` | Enables or disables the email notifications for base updates | true | + +### Email Syncer + +SeaTable runs this event at the 30th minute of every hour. The job processes email sync tasks defined in a base by the user. + +| Environment Variable | Description | Default | +| -------------------------- | ---------------------------------------------------------------- | ------- | +| `EMAIL_SYNCER_ENABLED` | Enables or disables the email syncer | true | +| `EMAIL_SYNCER_MAX_WORKERS` | Maximum number of worker threads for processing email sync tasks | 5 | + +### LDAP Sync + +SeaTable is able to sync LDAP accounts. This requires additional settings in `dtable_web_settings.py`. Please refer to [LDAP Authentication](../authentication/ldap.md). + +| Environment Variable | Description | Default | +| -------------------- | ---------------------------------------------------------------------------------------- | ------- | +| `LDAP_SYNC_ENABLED` | Enables or disables the LDAP sync | false | +| `LDAP_SYNC_INTERVAL` | Specifies the interval at which the LDAP synchronization process should run (in seconds) | 3600 | + ### PDF Generation | Environment Variable | Description | Default | @@ -49,7 +111,36 @@ By default, these settings will limit a single team to 25% of the available auto | `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 +### Virus Scan + +**Disabled** by default. + +This section configures how files are scanned for viruses: + +- Whether scanning is enabled +- The command used to scan files +- Return codes indicating infected or clean files +- Limits on file size and extensions to skip +- Concurrency settings + +| Parameter | Description | Default | +| ---------------------------- | ---------------------------------------------------------------- | --------------------------------------------------------- | +| `VIRUS_SCAN_ENABLED` | Enables or disables virus scanning | false | +| `VIRUS_SCAN_SCAN_COMMAND` | Command used for virus scanning (e.g. `clamscan`) | | +| `VIRUS_SCAN_VIRUS_CODE` | Return codes indicating a file is infected (e.g. 0) | | +| `VIRUS_SCAN_NONVIRUS_CODE` | Return codes indicating a file is clean (e.g. 1) | | +| `VIRUS_SCAN_SCAN_INTERVAL` | The interval at which the virus scan runs (in minutes) | 60 | +| `VIRUS_SCAN_SCAN_SIZE_LIMIT` | Maximum file size to scan (in MB); larger files are skipped | 20 | +| `VIRUS_SCAN_SCAN_SKIP_EXT` | Comma-separated list of file extensions to exclude from scanning | `.bmp,.gif,.ico,.png,.jpg,.mp3,.mp4,.wav,.avi,.rmvb,.mkv` | +| `VIRUS_SCAN_THREADS` | Number of threads for parallel scanning | 4 | + +## Configuration File (Legacy) + +!!! warning "Configuration file is not read anymore from v6.2 onwards" + + `dtable-events.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-events.conf`. diff --git a/docs/configuration/components/dtable-server.md b/docs/configuration/components/dtable-server.md index 870f7e34..aab8c5e6 100644 --- a/docs/configuration/components/dtable-server.md +++ b/docs/configuration/components/dtable-server.md @@ -4,11 +4,10 @@ description: Complete reference for dtable-server configuration including row li # Configuration of dtable-server -This is a cheat sheet for the possible configuration options of [dtable-server](/introduction/architecture.md#dtable-server). 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.md#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. - -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" @@ -16,7 +15,9 @@ In the default values below, a value in the form `$XYZ` refers to an environment ## Environment Variables -This section lists the environment variables read by [dtable-server](/introduction/architecture.md#dtable-server). + + +This section lists the environment variables read by [dtable-server](../../introduction/architecture.md#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. @@ -38,7 +39,29 @@ This ensures that SeaTable upgrades stay seamless. | --------------------------------------- | -------------------------------------------------------------------------- | ------- | | `AUTOMATION_RATE_LIMIT_PER_BASE_MINUTE` | Limits the number of automations that can be triggered per base per minute | 1000 | -## Configuration File +### Persistence + +**FIXME: SAVE_INTERVAL cannot be configured through ENV** + +### Service URLs + +**FIXME: Service URLs cannot be configured through ENV** + +### Row Limits + +**FIXME: Row limits cannot be configured through ENV** + +### Base Size Limit + +**FIXME: Base size limit cannot be configured through ENV** + +## Configuration File (Legacy) + +!!! warning "Configuration file is not read anymore from v6.2 onwards" + + `dtable_server_config.json` 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_server_config.json`. diff --git a/docs/configuration/components/dtable-storage-server.md b/docs/configuration/components/dtable-storage-server.md index 98a5e63d..08756bfb 100644 --- a/docs/configuration/components/dtable-storage-server.md +++ b/docs/configuration/components/dtable-storage-server.md @@ -4,11 +4,10 @@ description: Configure dtable-storage-server for filesystem or S3 storage backen # Configuration of dtable-storage-server -This is a cheat sheet for the possible configuration options of [dtable-storage-server](/introduction/architecture.md#dtable-storage-server). 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.md#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. - -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" @@ -16,7 +15,9 @@ In the default values below, a value in the form `$XYZ` refers to an environment ## Environment Variables -This section lists the environment variables read by [dtable-storage-server](/introduction/architecture.md#dtable-storage-server). + + +This section lists the environment variables read by [dtable-storage-server](../../introduction/architecture.md#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. @@ -32,6 +33,31 @@ services: This file then needs to be added to the `COMPOSE_FILE` variable inside your `.env` file. This ensures that SeaTable upgrades stay seamless. +### General + +| Environment Variable | Description | Default | +| --------------------- | --------------------------------------------- | ------- | +| `STORAGE_SERVER_HOST` | The address dtable-storage-server listens on. | 0.0.0.0 | +| `STORAGE_SERVER_PORT` | The port dtable-storage-server listens on. | 6666 | + +### Storage Backend + +| Environment Variable | Description | Default | +| ----------------------------- | --------------------------------------------------------------- | ---------- | +| `STORAGE_SERVER_BACKEND_TYPE` | The type of storage backend. Options are `filesystem` and `s3`. | filesystem | + +Depending on the chosen storage backend, there are additional settings: + +#### Filesystem Backend + +| Environment Variable | Description | Default | +| ------------------------ | -------------------------------- | -------------------------- | +| `STORAGE_SERVER_FS_PATH` | The filepath of storage backend. | /opt/seatable/storage-data | + +#### S3 Backend + +Please refer to the [S3 docs](../../installation/advanced/s3.md). + ### Snapshots | Environment Variable | Description | Default | @@ -41,7 +67,13 @@ This ensures that SeaTable upgrades stay seamless. | `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 +## Configuration File (Legacy) + +!!! warning "Configuration file is not read anymore from v6.2 onwards" + + `dtable-storage-server.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). ??? abstract "Notes about the configuration file format" @@ -86,8 +118,8 @@ This section contains general settings about the `dtable-storage-server` service This section is used to configure the storage backend. -| Parameter | Description | Default | -| --------- | --------------------------------------------------------------- | ----------- | +| Parameter | Description | Default | +| --------- | --------------------------------------------------------------- | ------------ | | `type` | The type of storage backend. Options are `filesystem` and `s3`. | `filesystem` | Depending on the chosen storage backend, there are additional settings: @@ -100,16 +132,16 @@ Depending on the chosen storage backend, there are additional settings: #### S3 Storage Backend -| Parameter | Description | Default | -| -------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | ------- | -| `bucket` | The bucket name for the S3 backend. | | -| `key_id` | The access key id for the bucket. | | -| `key` | The secret access key for the bucket. | | -| `use_v4_signature` | Whether to use v4 signature. For a S3-compatible storage, it should be `false`. | | -| `aws_region` | The AWS region (only when v4 signature is used). | | -| `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. | | +| Parameter | Description | Default | +| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------- | +| `bucket` | The bucket name for the S3 backend. | | +| `key_id` | The access key id for the bucket. | | +| `key` | The secret access key for the bucket. | | +| `use_v4_signature` | Whether to use v4 signature. For a S3-compatible storage, it should be `false`. | | +| `aws_region` | The AWS region (only when v4 signature is used). | | +| `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. | | ### `[snapshot]` diff --git a/docs/upgrade/extra-upgrade-notice.md b/docs/upgrade/extra-upgrade-notice.md index da978cb9..f8cea0cb 100644 --- a/docs/upgrade/extra-upgrade-notice.md +++ b/docs/upgrade/extra-upgrade-notice.md @@ -4,6 +4,13 @@ description: Version-specific upgrade notices and required configuration changes # Extra upgrade notice +## 6.2 + +- SECRET_KEY aus dtable_web_settings.py in .env +- wenn rollen verwendet, dann: `sed -i "s/'scripts_running_limit'/'scripts_running_limit_per_user'/" /opt/dtable-web/seatable/conf/dtable_web_settings.py` +- env anstelle von configurationsdateien - diese sollten bis auf dtable_web_settings.py sogar weg! +für uns: dokumentation von "kopiere die yml vollständig" in patch-yamls. + ## 6.1 Several Docker image tags have been updated to newer versions. These changes are applied automatically when you pull the latest images. Remember to also update your [plugins](../configuration/plugins.md).