18 | {% endblock %}
19 |
--------------------------------------------------------------------------------
/docs/installation/components/zabbix.md:
--------------------------------------------------------------------------------
1 | ---
2 | status: wip
3 | ---
4 |
5 | # Zabbix Monitoring
6 |
7 | Install Zabbix Agent and Zabbix Server on the same host to monitor system status.
8 |
9 | ## Get the Zabbix Server:
10 |
11 | After installation, you can get access to the zabbix server webinterface
12 |
13 | - Login to Zabbix Server Browser: `https://Browser"] 47 | B[Domain / Subdomain
Ports 80+443] 48 | C[Server or VM
with Docker] 49 | A-->B 50 | B-->C 51 | ``` 52 | 53 | For sure, it is possible to run SeaTable without an internet connection (air-gapped) or with custom SSL certificates. This requires additional settings which are explained in separate chapters. 54 | 55 | ## Ports 56 | 57 | SeaTable needs by default only the default ports **80 (HTTP)** and **443 (HTTPS)**. 58 | 59 | Most of the additional components will require **additional ports** in the range of **6230 to 6240**. You have to open the firewall or create port forwardings if you want to use these functions. If you don't use this component, the port can stay closed. 60 | 61 | ### List of required ports 62 | 63 | - **80**: HTTP access is necessary to receive a Let's Encrypt certificate 64 | - **443**: HTTPS is the main entrance to SeaTable Server 65 | 66 | ### List of optional ports 67 | 68 | - **6230**: Uptime Kuma 69 | - **6231**: n8n 70 | - **6232**: Collabora Online 71 | - **6233**: OnlyOffice 72 | - **6235**: Zabbix 73 | 74 | ## License 75 | 76 | **SeaTable Enterprise Edition** requires a license to start. A free license for two years and three users can be obtained via the command line, which will be explained during the installation. Licenses with more than three users can be obtained from [SeaTable Website](https://seatable.com/prices/). 77 | 78 | **SeaTable Developer Edition** does not require a license. 79 | -------------------------------------------------------------------------------- /docs/maintenance/debugging.md: -------------------------------------------------------------------------------- 1 | --- 2 | status: wip 3 | --- 4 | 5 | # Advanced debugging by adding error messages 6 | 7 | Sometimes SeaTable does not behave like you expect it to behave. Then it is time for some advanced debugging skills. This article debugs a possible problem to give you some knowledge that might help you to solve other problems, too. To follow this explanation you should have at least some development experience. 8 | 9 | ## The problem: User not found 10 | 11 | Imagine the situation that the "Share a base with other users" does not show the users you expected. 12 | 13 |  14 | 15 | You have no idea why the auto complete function is not working as expected. So let's find out. 16 | 17 | ## Check the Developer Tools of your browser 18 | 19 | The first check that you can perform is the Browser Console and the networking tab of your developer tools. 20 | 21 | ### The console tab 22 | 23 | In this case there are not errors in the console tab. That means there are not general JavaScript execution errors or bad Api endpoints. If you have problems inside your network like firewalls blocking traffic, unsigned certificates or something like that, you will most likely see an error in the browser console tab. In this case there is no error message. 24 | 25 | ### The network tab 26 | 27 | In the network tab, you can detect what kind of calls are executed, if you search for a user. 28 | 29 |  30 | 31 | From the results you can see that with every key stroke SeaTable executes a command like: 32 | 33 | ```bash 34 | /api2/search-user/?q=demo 35 | ``` 36 | 37 | So let's find this source code in the SeaTable Container. 38 | 39 | ## Find the Python Source Code 40 | 41 | Access your SeaTable Server container and let's search for the source code. I start my search in `dtable-web/seahub`. 42 | 43 | ```bash 44 | docker exec -it seatable-server bash 45 | cd /opt/seatable/seatable-server-latest/dtable-web/seahub 46 | grep -R "search-user" ./ 47 | 48 | # the result 49 | ./api2/urls.py: re_path(r'^search-user/$', SearchUser.as_view(), name='search-user'), 50 | ``` 51 | 52 | Now let's get a closer look at this `/api2/urls.py` at `/opt/seatable/seatable-server-latest/dtable-web/seahub/api2/urls.py`. 53 | 54 | There you can find at the beginning of this file, this content: 55 | 56 | ```bash 57 | from .endpoints.search_user import SearchUser 58 | ``` 59 | 60 | This tells us, that the source code of this search function is in the file `/opt/seatable/seatable-server-latest/dtable-web/seahub/api2/endpoints/search_user.py`. 61 | 62 | ## Add custom error messages 63 | 64 | In this python file, I can immediately see that there is the `class SearchUser(APIView)`. In the class I can see that the code checks for some parameters like: 65 | 66 | - user.permission.can_use_global_address_book 67 | - CLOUD_MODE 68 | - is_org_context 69 | 70 | Also I can see that SeaTable first generates a list of potential users and then removes out unwanted entries. So why not check if the user we are looking for is in the full list and then removed or if the user is not in there. 71 | 72 | Let's add this additional logging at line 94. Make sure that you use the right indentation, because otherwise the python code will throw errors. 73 | 74 | ```bash 75 | ## search finished, now filter out some users 76 | logger.error("This is email_list: %s " % email_list) 77 | ``` 78 | 79 | ## Check the logs 80 | 81 | Now let's restart SeaTable and check the dtable_web.log for more details. 82 | 83 | ```bash 84 | # we are still in the SeaTable Server container. 85 | seatable.sh restart 86 | tail -f /opt/seatable/logs/dtable_web.log 87 | ``` 88 | -------------------------------------------------------------------------------- /docs/maintenance/helper-scripts.md: -------------------------------------------------------------------------------- 1 | --- 2 | status: new 3 | --- 4 | 5 | # Helper Scripts 6 | 7 | After installing SeaTable, `/opt/seatable-compose/tools` contains the following shell scripts in order to make administrative operations more convenient. 8 | 9 | ## User management 10 | 11 | ### activate-user.sh 12 | 13 | This script allows you to enable an **existing** SeaTable user inside the database. 14 | Simply provide the user's contact email address as a parameter: 15 | 16 | === "Input" 17 | 18 | ```bash 19 | ./tools/activate-user.sh "user@email.com" 20 | ``` 21 | 22 | === "Output" 23 | 24 | ``` 25 | -------------- 26 | UPDATE ccnet_db.EmailUser SET is_active = 1 WHERE email = (SELECT user FROM dtable_db.profile_profile WHERE contact_email = 'user@email.com') 27 | -------------- 28 | 29 | Query OK, 1 row affected (0.002 sec) 30 | Rows matched: 1 Changed: 1 Warnings: 0 31 | 32 | Bye 33 | Success: Activated user user@email.com 34 | ``` 35 | 36 | ### deactivate-user.sh 37 | 38 | This script allows you to disable an existing SeaTable user inside the database. 39 | Simply provide the user's email address as a parameter: 40 | 41 | === "Input" 42 | 43 | ```bash 44 | ./tools/deactivate-user.sh "user@email.com" 45 | ``` 46 | 47 | === "Output" 48 | 49 | ``` 50 | -------------- 51 | UPDATE ccnet_db.EmailUser SET is_active = 0 WHERE email = (SELECT user FROM dtable_db.profile_profile WHERE contact_email = 'user@email.com') 52 | -------------- 53 | 54 | Query OK, 1 row affected (0.002 sec) 55 | Rows matched: 1 Changed: 1 Warnings: 0 56 | 57 | Bye 58 | Success: Deactivated user user@email.com 59 | ``` 60 | 61 | ### user-stats.sh 62 | 63 | This script will print your current license limit and query the database for the number of enabled users: 64 | 65 | === "Input" 66 | 67 | ```bash 68 | ./tools/user-stats.sh 69 | ``` 70 | 71 | === "Output" 72 | 73 | ``` 74 | User limit according to license file: 3 75 | 76 | Users in database: 77 | +-------+--------------+ 78 | | users | active_users | 79 | +-------+--------------+ 80 | | 2 | 2 | 81 | +-------+--------------+ 82 | ``` 83 | 84 | ## Database management 85 | 86 | ### db-shell.sh 87 | 88 | This script will give you an interactive shell inside the MariaDB container. You can use this to directly run SQL commands. 89 | 90 | === "Input" 91 | 92 | ```bash 93 | ./tools/db-shell.sh 94 | ``` 95 | 96 | === "Output" 97 | 98 | ``` 99 | Welcome to the MariaDB monitor. Commands end with ; or \g. 100 | Your MariaDB connection id is 73 101 | Server version: 11.4.3-MariaDB-ubu2404 mariadb.org binary distribution 102 | 103 | Copyright (c) 2000, 2018, Oracle, MariaDB Corporation Ab and others. 104 | 105 | Type 'help;' or '\h' for help. Type '\c' to clear the current input statement. 106 | 107 | MariaDB [(none)]> 108 | ``` 109 | 110 | ### dump-database.sh 111 | 112 | This script will dump all three databases (`ccnet_db`, `dtable_db` and `seahub_db`) to `/opt/seatable-backup` on the host. 113 | 114 | === "Input" 115 | 116 | ```bash 117 | ./tools/dump-database.sh 118 | ``` 119 | 120 | === "Output" 121 | 122 | ``` 123 | Success: Dumped databases into /opt/seatable-backup 124 | ``` 125 | 126 | === "Created Files" 127 | 128 | ``` 129 | total 228 130 | -rw-r--r-- 1 root root 12184 May 23 11:30 ccnet_db-2025-05-23-11-30-27.sql 131 | -rw-r--r-- 1 root root 177499 May 23 11:30 dtable_db-2025-05-23-11-30-27.sql 132 | -rw-r--r-- 1 root root 38402 May 23 11:30 seafile_db-2025-05-23-11-30-27.sql 133 | ``` 134 | 135 | -------------------------------------------------------------------------------- /docs/installation/cluster/managed-services.md: -------------------------------------------------------------------------------- 1 | --- 2 | search: 3 | exclude: true 4 | --- 5 | 6 | # Managed services 7 | 8 | ``` 9 | # components to be used; IMPORTANT: there should be no space between the files names ! 10 | COMPOSE_FILE='mariadb.yml,redis.yml,s3.yml' 11 | COMPOSE_PATH_SEPARATOR=',' 12 | 13 | # system settings 14 | TIME_ZONE='Europe/Berlin' 15 | 16 | # database 17 | SEATABLE_MYSQL_ROOT_PASSWORD='xxx' 18 | REDIS_PASSWORD='xxx' 19 | 20 | ``` 21 | 22 | ## S3 with minio 23 | 24 | ``` 25 | --- 26 | services: 27 | caddy: 28 | image: ${CADDY_IMAGE:-lucaslorentz/caddy-docker-proxy:2.8.11-alpine} 29 | restart: unless-stopped 30 | container_name: caddy 31 | ports: 32 | - 80:80 33 | - 443:443 34 | environment: 35 | - CADDY_INGRESS_NETWORKS=frontend-net 36 | volumes: 37 | - "/var/run/docker.sock:/var/run/docker.sock" 38 | - "/opt/caddy:/data/caddy" 39 | networks: 40 | - frontend-net 41 | healthcheck: 42 | test: ["CMD-SHELL", "curl --fail http://localhost:2019/metrics || exit 1"] 43 | start_period: 20s 44 | interval: 20s 45 | timeout: 5s 46 | retries: 3 47 | 48 | minio: 49 | container_name: minio 50 | image: minio/minio:RELEASE.2024-12-18T13-15-44Z 51 | networks: 52 | - frontend-net 53 | volumes: 54 | - '/opt/minio_data:/data' 55 | environment: 56 | - MINIO_ROOT_USER=minio 57 | - MINIO_ROOT_PASSWORD=s3_topsecret 58 | - MINIO_SERVER_URL=https://
`.
78 |
79 | Security header configuration in your `seatable-server.yml` might prevent this and you need your S3 url to the Content-Security-Policy.
80 |
81 | ```
82 | caddy.header.Content-Security-Policy:
83 | ...
84 | img-src 'self' data: blob: ...
23 | ```
24 | Select a color and the css code will be created...
25 | ```
26 |
27 |
28 | Use the copy-and-paste icon (:material-content-copy:) on the top right of the grey box to copy the complete css code to your clipboard.
29 |
30 | === "Version 5.2"
31 |
32 | Select a color and you will get the correspondent css code in the following grey box.
33 |
34 |
35 |
36 | ```
37 | Select a color and the css code will be created...
38 | ```
39 |
40 |
41 | Use the copy-and-paste icon (:material-content-copy:) on the top right of the grey box to copy the complete css code to your clipboard.
42 |
43 | === "Version 5.1"
44 |
45 | Select a color and you will get the correspondent css code in the following grey box.
46 |
47 |
48 |
49 | ```
50 | Select a color and the css code will be created...
51 | ```
52 |
53 |
54 | Use the copy-and-paste icon (:material-content-copy:) on the top right of the grey box to copy the complete css code to your clipboard.
55 |
56 | === "Version 5.0"
57 |
58 | Select a color and you will get the correspondent css code in the following grey box.
59 |
60 |
61 |
62 | ```
63 | Select a color and the css code will be created...
64 | ```
65 |
66 |
67 | Use the copy-and-paste icon (:material-content-copy:) on the top right of the grey box to copy the complete css code to your clipboard.
68 |
69 | === "Version 4.3"
70 |
71 | Select a color and you will get the correspondent css code in the following grey box.
72 |
73 |
74 |
75 | ```
76 | Select a color and the css code will be created...
77 | ```
78 |
79 |
80 | Use the copy-and-paste icon (:material-content-copy:) on the top right of the grey box to copy the complete css code to your clipboard.
81 |
82 | ## Configuration via the web interface
83 |
84 | Login to your SeaTable Server as system administrator and switch to the system admin area. Select the navigation point `Settings`. Team admins or normal users does not have the permission to access the system admin area.
85 |
86 | First you should set the checkbox for `ENABLE_BRANDING_CSS`. Then simply copy and paste (:material-content-copy:) the css code and paste it to the input box of `Custom CSS`. Submit by clicking on the green :material-check:.
87 |
88 | Reload your page of your browser and the color should be changed.
89 |
90 | ## Configuration via config file
91 |
92 | Open the configuration file `dtable_web_settings.py` and add this configuration line:
93 |
94 | ```bash
95 | BRANDING_CSS = 'custom/custom.css'
96 | ```
97 |
98 | Now copy the css code from this manual and save it to `/opt/seatable-server/seatable/seahub-data/custom/custom.css`. If the directory `custom` does not exist, you have to create it first.
99 |
100 | If your new color is not immediately visible after a page reload, you have to restart the SeaTable container (not the SeaTable service).
101 | The SeaTable container has to create a symlink to make the css file available to SeaTable.
102 |
--------------------------------------------------------------------------------
/docs/installation/advanced/python-pipeline-configuration.md:
--------------------------------------------------------------------------------
1 | ## Configuration
2 |
3 | The Python Pipeline can be configured through environment variables for further customization. The available parameters inside your `.env` file are:
4 |
5 | ### Resources
6 |
7 | | Parameter | Description | Default |
8 | | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------- |
9 | | `PYTHON_PROCESS_TIMEOUT` | The timeout for a single script (in seconds) | `60` |
10 | | `PYTHON_TRANSFER_DIRECTORY_PATH` | The directory on the host where python-starter creates a folder for each individual script job | `/tmp` |
11 | | `PYTHON_RUNNER_CONTAINER_CPUS` | The number of CPUs available to each script container | `1` |
12 | | `PYTHON_RUNNER_CONTAINER_MEMORY` | The amount of memory available to each script container | `1g` |
13 | | `PYTHON_RUNNER_READ_ONLY_FILESYSTEM` | Whether the root filesystem should be mounted as read-only (`true` or `false`) | `true` |
14 | | `PYTHON_RUNNER_TMPFS_MOUNT_SIZE_IN_BYTES` | Maximum size of the `tmpfs` mount (mounted at `/tmp` inside the container) for each script container (in bytes) | `104857600` (100MB) |
15 | | `PYTHON_RUNNER_DROPPED_CAPABILITIES` | Comma-separated list of capabilities that should be removed from the container. Please refer to the [Docker documentation](https://docs.docker.com/engine/containers/run/#runtime-privilege-and-linux-capabilities) for more details | `CAP_NET_RAW` |
16 | | `PYTHON_RUNNER_NO_NEW_PRIVILEGES` | Whether container processes should be prevented from gaining additional privileges | `true` |
17 |
18 | ### Logging
19 |
20 | | Parameter | Description | Default |
21 | | ---------------------------- | ------------------------------------------------------------------------------------------ | --------- |
22 | | `PYTHON_SCHEDULER_LOG_LEVEL` | The log level for the python-scheduler (`DEBUG`, `INFO`, `WARNING`, `ERROR` or `CRITICAL`) | `WARNING` |
23 | | `PYTHON_STARTER_LOG_LEVEL` | The log level for the python-starter (`DEBUG`, `INFO`, `WARNING`, `ERROR` or `CRITICAL`) | `WARNING` |
24 |
25 | ## Limiting Volume Size
26 |
27 | By default, any script container can use up all of the available storage resources on your disk.
28 |
29 | You can use the following instructions to set a limit for the directory that contains all volumes. These commands should be executed on your host.
30 |
31 | ```bash
32 | # Create an empty file
33 | touch python-pipeline-volume
34 |
35 | # Resize the file (e.g. 2GB)
36 | truncate -s 2G python-pipeline-volume
37 |
38 | # Create a new ext4 filesystem
39 | mke2fs -t ext4 -F python-pipeline-volume
40 |
41 | # Create a new directory which will serve as the data transfer directory
42 | mkdir /opt/python-pipeline-transfer
43 |
44 | # Mount the filesystem
45 | mount python-pipeline-volume /opt/python-pipeline-transfer
46 |
47 | # Validate your changes
48 | df -h /opt/python-pipeline-transfer
49 | ```
50 |
51 | Afterwards, you should update your `.env` file and restart the python-starter by running `docker compose up -d`:
52 |
53 | ```ini
54 | PYTHON_TRANSFER_DIRECTORY_PATH='/opt/python-pipeline-transfer'
55 | ```
56 |
--------------------------------------------------------------------------------