harmonize how to restart seatable inside the docker container

christophdb · christophdb · commit 09ed2fb097d3 · 2025-06-14T20:31:18.000+02:00
diff --git a/docs/configuration/authentication/saml.md b/docs/configuration/authentication/saml.md
@@ -123,12 +123,7 @@ SAML_CERTS_DIR = '/shared/certs'
 
 ### Testing
 
-A restart of the SeaTable service to activate the configuration settings.
-
-```
-# docker exec -it seatable bash
-# seatable.sh restart
-```
+Now [restart SeaTable](../../maintenance/restart-seatable.md) to activate the configuration settings.
 
 Navigate to the login page of your SeaTable Server and click on "Single Sign-On" and try to log in. If the configuration is correct, you'll be redirected the IdP's login. Enter the credentials of a user that was assigned to the application created above.
 
diff --git a/docs/configuration/dtable-api-gateway-conf.md b/docs/configuration/dtable-api-gateway-conf.md
@@ -20,7 +20,9 @@ In the default values below, a value in the form `$XYZ` refers to an environment
 
 The following options are grouped by their sections.
 
-Please note that 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.
+## 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
 
diff --git a/docs/configuration/dtable-events-conf.md b/docs/configuration/dtable-events-conf.md
@@ -38,6 +38,8 @@ The following options are grouped by their sections.
 By default, `dtable-events.conf` will be empty after the first startup of SeaTable:
 
 ```python
+[CLEAN DB]
+enabled = true
 ```
 
 ## Available configuration options
diff --git a/docs/configuration/dtable-web-settings.md b/docs/configuration/dtable-web-settings.md
@@ -1,10 +1,6 @@
 # dtable web settings
 
-You need to restart SeaTable so that your changes take effect. Just execute the following command at your command line.
-
-```bash
-docker exec -i seatable-server /templates/seatable.sh restart
-```
+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`.
 
diff --git a/docs/customization/overview.md b/docs/customization/overview.md
@@ -22,8 +22,4 @@ Keep this in mind, but the articles will explain precisely where you should do t
 ## How to restart SeaTable?
 
 Changes in the configuration files, require a restart of the SeaTable container or the SeaTable service.
-SeaTable service can be restarted with this command:
-
-```
-docker exec -i seatable-server /templates/seatable.sh restart
-```
+Read [here, how to restart SeaTable or the complete container](../maintenance/restart-seatable.md).
diff --git a/docs/customization/page-templates.md b/docs/customization/page-templates.md
@@ -182,11 +182,7 @@ $(function() {
 
 ### 4. Restart seatable service
 
-Only one command is missing to restart SeaTable and to activate your new login page.
-
-```
-docker exec -i seatable-server /templates/seatable.sh restart
-```
+Now [restart SeaTable](../maintenance/restart-seatable.md) to activate your new login page.
 
 ## Customize CSS
 
diff --git a/docs/installation/advanced/database-standalone.md b/docs/installation/advanced/database-standalone.md
@@ -6,19 +6,28 @@ status: wip
 
 Managed Database is an often used managed service. SeaTable can easily be configured to use a separate database. We recommend to initialize SeaTable with the default mariadb container. Then dump the database, load the dump to a separate database, update the `.env` file and restart SeaTable. Due to this assumption, this manual is the same for a new SeaTable Server or a service where you want to migrate the database.
 
-## Stop Database container and SeaTable
+## Stop SeaTable
 
 ```bash
-docker stop mariadb
-docker exec -it seatable-server seatable.sh stop
+docker stop seatable-server
 ```
 
+Now you can be sure, that no more records are written or modified in the database.
+
 ## Dump and restore to another database
 
 Please refer to [Backup and Recovery](../../maintenance/backup-recovery.md#mariadb-database) for instructions regarding the backup process for the MariaDB database.
 
 You can use the `mariadb` CLI to import the contents of the dumped databases into the managed databases.
 
+## Stop Mariadb
+
+After the dump, stop also the database container:
+
+```bash
+docker stop mariadb
+```
+
 ## Don't start mariadb container
 
 Create a copy of `seatable-server.yml` and rename it to `custom-seatable-server.yml`.
@@ -47,11 +56,7 @@ MARIADB_PASSWORD=
 
 ## Restart SeaTable
 
-After that you can restart SeaTable service.
-
-```bash
-docker restart seatable-server
-```
+After that you can [restart SeaTable](../../maintenance/restart-seatable.md).
 
 ## Troubleshooting
 
diff --git a/docs/installation/advanced/s3-migration.md b/docs/installation/advanced/s3-migration.md
@@ -42,11 +42,10 @@ docker exec -it seatable-server bash
 cd /templates
 ./migrate-seafile-data.sh
 ./migrate-storage-data.sh
-
-# after the migration has finished, you can restart SeaTable
-seatable.sh restart
 ```
 
+After the migration has finished, you can [restart SeaTable](../../maintenance/restart-seatable.md)
+
 ### Avatars
 
 <!-- md:version 4.4 -->
diff --git a/docs/installation/advanced/s3.md b/docs/installation/advanced/s3.md
@@ -35,10 +35,7 @@ Bases and avatars require one bucket, to store the content of picture and files
 
 !!! failure "Restart required"
 
-    Don't forget to restart SeaTable service after these configuration changes. Easiest with this command:
-    ```
-    docker exec -it seatable-server seatable.sh restart
-    ```
+    Don't forget to [restart SeaTable service](../../maintenance/restart-seatable.md) after these configuration changes. 
 
 !!! tip "Option: use_v4_signature"
 
diff --git a/docs/installation/cluster/dtable-db-standalone.md b/docs/installation/cluster/dtable-db-standalone.md
@@ -34,10 +34,6 @@ INNER_DTABLE_DB_URL = 'http://192.168.0.3'  # LAN dtable-db server's url
 ```sh
 docker compose up -d
 
-docker exec -it seatable bash
-
-seatable.sh
-
 ```
 
 When you see following in the output log, it means success:
@@ -63,9 +59,7 @@ Modify dtable-server configuration file `/Your SeaTable data volume/seatable/con
 
 ```sh
 docker compose up -d
-
 docker exec -it seatable bash
-
 seatable.sh
 
 ```
@@ -201,10 +195,7 @@ DTABLE_EVENTS_TASK_MODE=all
 
 ```sh
 docker compose up -d
-
-docker exec -it seatable bash
-
-seatable.sh
+docker exec seatable-server /opt/seatable/scripts/seatable.sh
 
 ```
 
diff --git a/docs/installation/cluster/dtable-events-background-node.md b/docs/installation/cluster/dtable-events-background-node.md
@@ -94,11 +94,7 @@ DTABLE_EVENTS_TASK_MODE=background
 
 ```sh
 docker compose up -d
-
-docker exec -it seatable bash
-
-seatable.sh
-
+docker exec seatable-server /opt/seatable/scripts/seatable.sh
 ```
 
 When you see following in the output log, it means success:
@@ -133,10 +129,7 @@ DTABLE_EVENTS_TASK_MODE=foreground
 ### Restart dtable-web nodes
 
 ```sh
-docker exec -it seatable bash
-
-seatable.sh
-
+docker exec seatable-server /opt/seatable/scripts/seatable.sh
 ```
 
 When you see following in the output log, it means success:
diff --git a/docs/installation/components/python-pipeline.md b/docs/installation/components/python-pipeline.md
@@ -56,8 +56,8 @@ Now it is time to start the Python Pipeline.
 
 ```bash
 cd /opt/seatable-compose && \
-docker compose up -d && \
-docker exec -i seatable-server /templates/seatable.sh restart
+docker stop seatable-server && \
+docker compose up -d
 ```
 
 #### Check the functionality Python Pipeline
diff --git a/docs/installation/faq.md b/docs/installation/faq.md
@@ -37,10 +37,11 @@ status: wip
     {"version":"4.3.8","edition":"enterprise edition"}
     ```
 
-    If you don't see this, SeaTable Service is definately not running. Try to start the service from the docker container and check the logs for more details.
-    Here are the two commands...
+    If you don't see this, SeaTable Service is definately not running. Try to [restart the service](../maintenance/restart-seatable.md) and check the logs for more details.
 
-    - `docker exec -it seatable-server seatable.sh`
+    Here are the two commands for more logs
+
+    - `cd /opt/seatable-compose && docker compose logs -f`
     - `tail -f /opt/seatable-server/seatable/logs/*.log`
 
     Probably you have a wrong configuration value in `dtable_web_settings.py`.
diff --git a/docs/maintenance/base-export.md b/docs/maintenance/base-export.md
@@ -1,3 +1,7 @@
+---
+status: wip
+---
+
 # Exporting a Base from the Command Line
 
 SeaTable allows you to export a base using the command line, bypassing typical limitations from the web interface.
diff --git a/docs/maintenance/password-reset.md b/docs/maintenance/password-reset.md
@@ -12,4 +12,11 @@ In a private server, the default settings doesn't support users to reset their p
 
 #### Forgot Admin Account or Password?
 
-You may create a new admin account by running `seatable.sh superuser` script under the scripts directory. After logging in the new admin account, you can reset the original admin account's password.
+You may create a new admin account from the command line. Use these commands and follow the instructions on the screen.
+
+```bash
+docker exec -it seatable-server bash
+seatable.sh superuser
+```
+
+After logging in the new admin account, you can reset the original admin account's password.
diff --git a/docs/maintenance/restart-seatable.md b/docs/maintenance/restart-seatable.md
@@ -0,0 +1,43 @@
+---
+status: new
+---
+
+# Restarting the SeaTable service
+
+Changes in the configuration files, require a restart of the SeaTable service.
+
+## Method 1: Restart from outside the container
+
+To restart the SeaTable service directly from your host command line, use:
+
+```bash
+docker exec seatable-server /opt/seatable/scripts/seatable.sh
+```
+
+This command runs the SeaTable startup script inside the container, managing all necessary service processes. You must specify the full path to `seatable.sh` because the Docker exec command does not use the container’s `PATH` environment variable by default.
+
+## Method 2: Restart from inside the container
+
+Alternatively, you can open an interactive shell inside the container and run the script manually:
+
+```bash
+docker exec -it seatable-server bash
+seatable.sh
+exit
+```
+
+When using an interactive shell, you do not need to specify the full path to `seatable.sh` because the container’s `PATH` is available. After restarting the service, type `exit` to leave the container shell.
+
+# Restarting the docker container
+
+Alternatively, you can restart the complete SeaTable Docker container. This is useful if you need to ensure all processes and services inside the container are refreshed.
+
+You need to vavigate to your SeaTable compose directory (commonly `/opt/seatable-compose`), then run:
+
+```bash
+/opt/seatable-compose
+docker stop seatable-server
+docker compose up -d
+```
+
+This will stop the SeaTable container and then restart it in detached mode. All related services defined in your `docker-compose.yml` will also be managed according to your configuration.
diff --git a/docs/upgrade/upgrade-manual.md b/docs/upgrade/upgrade-manual.md
@@ -137,7 +137,6 @@ This part of the manual is only for older version, meaning if you are updating t
 
     Now you can start the SeaTable service. Execute the following command in the host server:
 
-    ```
+    ```bash
     docker exec -d seatable /shared/seatable/scripts/seatable.sh start
-
     ```
