Skip to content

Commit 4423c60

Browse files
authored
update dtable-events.conf (#242)
* update dtable-events.conf * update dtable-events.conf * update dtable-events-conf
1 parent 7fdb605 commit 4423c60

File tree

1 file changed

+15
-42
lines changed

1 file changed

+15
-42
lines changed

docs/configuration/dtable-events-conf.md

Lines changed: 15 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -24,30 +24,22 @@ In the default values below, a value in the form `$XYZ` refers to an environment
2424

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

27-
The following options are grouped by their sections.
28-
29-
## Example configuration
27+
!!! note "Configurations in dtable-events.conf`"
3028

31-
This is a typical configuration file, created automatically on the first startup by SeaTable.
29+
Since SeaTable 5.3, by default, you can start the dtable-events service without adding any configurations to `dtable-events.conf`, as the the key startup configurations (i.e. *MySQL* and *Redis*) are already configured in the environment variables by default (i.e., `.env`). On the other hand, you can also add other dtable-events service related configurations to `dtable-events.conf`, which mainly contains some sections and their options:
30+
31+
- Section names in `dtable-events.conf` compose of **uppercase** and **spaces** (such as `[COMMON DATASET SYNCER]`).
32+
- Option names will be mainly **lowercase** with **underscores** (such as `per_update_auto_rule_workers`).
3233

33-
```ini
34-
[DATABASE]
35-
type = mysql
36-
host = mariadb
37-
port = 3306
38-
username = root
39-
password = topsecret
40-
db_name = dtable_db
41-
42-
[REDIS]
43-
host = redis
44-
port = 6379
45-
```
34+
The following options are grouped by their sections.
4635

4736
## Available configuration options
4837

4938
### `[DATABASE]`
5039

40+
??? success "Database can configure in .env"
41+
From SeaTable 5.3, you can specify the database configurations in [`.env`](./environment-variables.md#table-of-settings).
42+
5143
| Parameter | Description | Default |
5244
| ---------- | ------------------------------------------------------------------------------------------------------- | ----------------- |
5345
| `type` | The database connection type. Use `mysql` for MySQL and MariaDB (other databases are not yet supported) | mysql |
@@ -59,6 +51,9 @@ port = 6379
5951

6052
### `[REDIS]`
6153

54+
??? success "Redis can configure in .env"
55+
From SeaTable 5.3, you can specify the redis configurations in [`.env`](./environment-variables.md#table-of-settings).
56+
6257
| Parameter | Description | Default |
6358
| ---------- | --------------------- | ------- |
6459
| `host` | Redis server address | redis |
@@ -75,17 +70,6 @@ SeaTable runs this task every hour to send base email notifications for base upd
7570
| --------- | ------------------------------------------------------------ | ------- |
7671
| `enabled` | Enables or disables the email notifications for base updates | true |
7772

78-
### `[NOTIFY-SCANNER]`
79-
80-
**disabled** by default.
81-
82-
Notification rules are a feature that allows users to set criteria for a base and receive notifications when these criteria are met.
83-
This runs a daily job at midnight to clean up inactive notification rules. Rules that have not been triggered for 180 days or were created but never triggered are marked as invalid.
84-
85-
| Parameter | Description | Default |
86-
| --------- | -------------------------------------------- | ------- |
87-
| `enabled` | Enables or disables the notification scanner | false |
88-
8973
### `[AUTOMATION]`
9074

9175
**enabled** by default.
@@ -95,10 +79,9 @@ These rules are then automatically executed on a base.
9579

9680
| Parameter | Description | Default |
9781
| ------------------------------ | -------------------------------------------------------------------------------------------------------------------- | ------- |
98-
| `per_minute_trigger_limit` | To maintain server stability, SeaTable includes a feature that restricts the frequency of automation rule executions | 50 |
9982
| `per_update_auto_rule_workers` | Number of worker threads used for processing automation rule events | 3 |
10083

101-
### `[COMMON-DATASET-SYNCER]`
84+
### `[COMMON DATASET SYNCER]`
10285

10386
**enabled** by default.
10487

@@ -108,7 +91,7 @@ SeaTable runs every hour this event to check for pending dataset syncs. The job
10891
| --------- | --------------------------------------------- | ------- |
10992
| `enabled` | Enables or disables the common dataset syncer | true |
11093

111-
### `[EMAIL-SYNCER]`
94+
### `[EMAIL SYNCER]`
11295

11396
**enabled** by default.
11497

@@ -119,7 +102,7 @@ SeaTable runs this event at the 30th minute of every hour. The job processes ema
119102
| `enabled` | Enables or disables the email syncer | true |
120103
| `max_workers` | Maximum number of worker threads for processing email sync tasks | 5 |
121104

122-
### `[LDAP_SYNC]`
105+
### `[LDAP SYNC]`
123106

124107
**disabled** by default.
125108

@@ -130,16 +113,6 @@ SeaTable could sync LDAP accounts, if activated. This requires additional settin
130113
| `enabled` | Enables or disables the ldap sync | false |
131114
| `sync_interval` | Specifies the interval at which the LDAP synchronization process should run, in seconds | 3600 |
132115

133-
### `[ROWS-COUNTER]`
134-
135-
**enabled** by default.
136-
137-
SeaTable runs this event every 24 hours. It counts and updates the total number of rows of a team.
138-
139-
| Parameter | Description | Default |
140-
| --------- | ---------------------------------------------- | ------- |
141-
| `enabled` | Enables or disables the rows counter for teams | true |
142-
143116
### `[VIRUS SCAN]`
144117

145118
**disabled** by default.

0 commit comments

Comments
 (0)