Merge pull request #340 from haiwen/update-12.0-101224

opt: structures, sentences and variables
haiwen · Oct 12, 2024 · 18fb6d3 · 18fb6d3
2 parents d0b6eea + f1b27f1
commit 18fb6d3
Show file tree

Hide file tree

Showing 16 changed files with 38 additions and 38 deletions.
diff --git a/manual/docker/deploy_seafile_with_docker.md b/manual/docker/deploy_seafile_with_docker.md
@@ -32,9 +32,9 @@ nano .env
 
 The following fields merit particular attention:
 
-- `SEAFILE_VOLUMES`: The volume directory of Seafile data
-- `SEAFILE_MYSQL_VOLUMES`: The volume directory of MySQL data
-- `SEAFILE_CADDY_VOLUMES`: The volume directory of Caddy data
+- `SEAFILE_VOLUME`: The volume directory of Seafile data, default is `/opt/seafile-data`
+- `SEAFILE_MYSQL_VOLUME`: The volume directory of MySQL data, default is `/opt/seafile-mysql/db`
+- `SEAFILE_CADDY_VOLUME`: The volume directory of Caddy data used to store certificates obtained from Let's Encrypt's, default is `/opt/seafile-caddy`
 - `SEAFILE_MYSQL_ROOT_PASSWORD`: The user `root` password of MySQL
 - `SEAFILE_MYSQL_DB_PASSWORD`: The user `seafile` password of MySQL
 - `JWT`: JWT_PRIVATE_KEY, A random string with a length of no less than 32 characters, generate example: `pwgen -s 40 1`

diff --git a/manual/docker/docker-compose/ce/12.0/caddy.yml b/manual/docker/docker-compose/ce/12.0/caddy.yml
@@ -11,7 +11,7 @@ services:
       - CADDY_INGRESS_NETWORKS=seafile-net
     volumes:
       - /var/run/docker.sock:/var/run/docker.sock
-      - ${SEAFILE_CADDY_VOLUMES:-/opt/seafile-caddy}:/data/caddy
+      - ${SEAFILE_CADDY_VOLUME:-/opt/seafile-caddy}:/data/caddy
     networks:
       - seafile-net
     healthcheck:

diff --git a/manual/docker/docker-compose/ce/12.0/env b/manual/docker/docker-compose/ce/12.0/env
@@ -7,9 +7,9 @@ SEAFILE_DB_IMAGE=mariadb:10.11
 SEAFILE_MEMCACHED_IMAGE=memcached:1.6.29
 SEAFILE_CADDY_IMAGE=lucaslorentz/caddy-docker-proxy:2.9
 
-SEAFILE_VOLUMES=/opt/seafile-data
-SEAFILE_MYSQL_VOLUMES=/opt/seafile-mysql/db
-SEAFILE_CADDY_VOLUMES=/opt/seafile-caddy
+SEAFILE_VOLUME=/opt/seafile-data
+SEAFILE_MYSQL_VOLUME=/opt/seafile-mysql/db
+SEAFILE_CADDY_VOLUME=/opt/seafile-caddy
 
 SEAFILE_MYSQL_DB_HOST=db
 SEAFILE_MYSQL_ROOT_PASSWORD=ROOT_PASSWORD
@@ -28,7 +28,7 @@ SEAFILE_ADMIN_PASSWORD=asecret
 
 
 SEADOC_IMAGE=seafileltd/sdoc-server:1.0-latest
-SEADOC_VOLUMES=/opt/seadoc-data
+SEADOC_VOLUME=/opt/seadoc-data
 
 ENABLE_SEADOC=false
 SEADOC_SERVER_URL=http://example.seafile.com/sdoc-server
diff --git a/manual/docker/docker-compose/ce/12.0/seadoc.yml b/manual/docker/docker-compose/ce/12.0/seadoc.yml
@@ -4,7 +4,7 @@ services:
     image: ${SEADOC_IMAGE:-seafileltd/sdoc-server:1.0-latest}
     container_name: seadoc
     volumes:
-      - ${SEADOC_VOLUMES:-/opt/seadoc-data/}:/shared
+      - ${SEADOC_VOLUME:-/opt/seadoc-data/}:/shared
     # ports:
     #   - "80:80"
     environment:

diff --git a/manual/docker/docker-compose/ce/12.0/seafile-server.yml b/manual/docker/docker-compose/ce/12.0/seafile-server.yml
@@ -7,7 +7,7 @@ services:
       - MYSQL_LOG_CONSOLE=true
       - MARIADB_AUTO_UPGRADE=1
     volumes:
-      - "${SEAFILE_MYSQL_VOLUMES:-/opt/seafile-mysql/db}:/var/lib/mysql"
+      - "${SEAFILE_MYSQL_VOLUME:-/opt/seafile-mysql/db}:/var/lib/mysql"
     networks:
       - seafile-net
 
@@ -24,7 +24,7 @@ services:
     # ports:
     #   - "80:80"
     volumes:
-      - ${SEAFILE_VOLUMES:-/opt/seafile-data}:/shared
+      - ${SEAFILE_VOLUME:-/opt/seafile-data}:/shared
     environment:
       - DB_HOST=${SEAFILE_MYSQL_DB_HOST:-db}
       - DB_PORT=${SEAFILE_MYSQL_DB_PORT:-3306}

diff --git a/manual/docker/docker-compose/pro/12.0/caddy.yml b/manual/docker/docker-compose/pro/12.0/caddy.yml
@@ -11,7 +11,7 @@ services:
       - CADDY_INGRESS_NETWORKS=seafile-net
     volumes:
       - /var/run/docker.sock:/var/run/docker.sock
-      - ${SEAFILE_CADDY_VOLUMES:-/opt/seafile-caddy}:/data/caddy
+      - ${SEAFILE_CADDY_VOLUME:-/opt/seafile-caddy}:/data/caddy
     networks:
       - seafile-net
     healthcheck:

diff --git a/manual/docker/docker-compose/pro/12.0/env b/manual/docker/docker-compose/pro/12.0/env
@@ -8,10 +8,10 @@ SEAFILE_MEMCACHED_IMAGE=memcached:1.6.29
 SEAFILE_ELASTICSEARCH_IMAGE=elasticsearch:8.15.0
 SEAFILE_CADDY_IMAGE=lucaslorentz/caddy-docker-proxy:2.9
 
-SEAFILE_VOLUMES=/opt/seafile-data
-SEAFILE_MYSQL_VOLUMES=/opt/seafile-mysql/db
-SEAFILE_ELASTICSEARCH_VOLUMES=/opt/seafile-elasticsearch/data
-SEAFILE_CADDY_VOLUMES=/opt/seafile-caddy
+SEAFILE_VOLUME=/opt/seafile-data
+SEAFILE_MYSQL_VOLUME=/opt/seafile-mysql/db
+SEAFILE_ELASTICSEARCH_VOLUME=/opt/seafile-elasticsearch/data
+SEAFILE_CADDY_VOLUME=/opt/seafile-caddy
 
 SEAFILE_MYSQL_DB_HOST=db
 SEAFILE_MYSQL_ROOT_PASSWORD=ROOT_PASSWORD
@@ -30,7 +30,7 @@ SEAFILE_ADMIN_PASSWORD=asecret
 
 
 SEADOC_IMAGE=seafileltd/sdoc-server:1.0-latest
-SEADOC_VOLUMES=/opt/seadoc-data
+SEADOC_VOLUME=/opt/seadoc-data
 
 ENABLE_SEADOC=false
 SEADOC_SERVER_URL=http://example.seafile.com/sdoc-server
diff --git a/manual/docker/docker-compose/pro/12.0/seadoc.yml b/manual/docker/docker-compose/pro/12.0/seadoc.yml
@@ -4,7 +4,7 @@ services:
     image: ${SEADOC_IMAGE:-seafileltd/sdoc-server:1.0-latest}
     container_name: seadoc
     volumes:
-      - ${SEADOC_VOLUMES:-/opt/seadoc-data/}:/shared
+      - ${SEADOC_VOLUME:-/opt/seadoc-data/}:/shared
     # ports:
     #   - "80:80"
     environment:

diff --git a/manual/docker/docker-compose/pro/12.0/seafile-server.yml b/manual/docker/docker-compose/pro/12.0/seafile-server.yml
@@ -7,7 +7,7 @@ services:
       - MYSQL_LOG_CONSOLE=true
       - MARIADB_AUTO_UPGRADE=1
     volumes:
-      - "${SEAFILE_MYSQL_VOLUMES:-/opt/seafile-mysql/db}:/var/lib/mysql"
+      - "${SEAFILE_MYSQL_VOLUME:-/opt/seafile-mysql/db}:/var/lib/mysql"
     networks:
       - seafile-net
 
@@ -32,7 +32,7 @@ services:
         hard: -1
     mem_limit: 4g
     volumes:
-      - "${SEAFILE_MYSQL_VOLUMES:-/opt/seafile-elasticsearch/data}:/usr/share/elasticsearch/data"
+      - "${SEAFILE_MYSQL_VOLUME:-/opt/seafile-elasticsearch/data}:/usr/share/elasticsearch/data"
     networks:
       - seafile-net
 
@@ -42,7 +42,7 @@ services:
     # ports:
     #   - "80:80"
     volumes:
-      - ${SEAFILE_VOLUMES:-/opt/seafile-data}:/shared
+      - ${SEAFILE_VOLUME:-/opt/seafile-data}:/shared
     environment:
       - DB_HOST=${SEAFILE_MYSQL_DB_HOST:-db}
       - DB_PORT=${SEAFILE_MYSQL_DB_PORT:-3306}

diff --git a/manual/docker/docker-compose/seadoc/1.0/standalone/env b/manual/docker/docker-compose/seadoc/1.0/standalone/env
@@ -4,7 +4,7 @@ COMPOSE_PATH_SEPARATOR=','
 
 SEADOC_IMAGE=seafileltd/sdoc-server:1.0-latest
 
-SEADOC_VOLUMES=/opt/seadoc-data
+SEADOC_VOLUME=/opt/seadoc-data
 
 SEAFILE_MYSQL_DB_HOST=192.168.0.2
 SEAFILE_MYSQL_DB_USER=seafile

diff --git a/manual/docker/docker-compose/seadoc/1.0/standalone/seadoc.yml b/manual/docker/docker-compose/seadoc/1.0/standalone/seadoc.yml
@@ -4,7 +4,7 @@ services:
     image: ${SEADOC_IMAGE:-seafileltd/sdoc-server:1.0-latest}
     container_name: seadoc
     volumes:
-      - ${SEADOC_VOLUMES:-/opt/seadoc-data/}:/shared
+      - ${SEADOC_VOLUME:-/opt/seadoc-data/}:/shared
     ports:
       - "80:80"
     environment:

diff --git a/manual/docker/pro-edition/deploy_seafile_pro_with_docker.md b/manual/docker/pro-edition/deploy_seafile_pro_with_docker.md
@@ -66,10 +66,10 @@ nano .env
 
 The following fields merit particular attention:
 
-- `SEAFILE_VOLUMES`: The volume directory of Seafile data
-- `SEAFILE_MYSQL_VOLUMES`: The volume directory of MySQL data
-- `SEAFILE_CADDY_VOLUMES`: The volume directory of Caddy data
-- `SEAFILE_ELASTICSEARCH_VOLUMES`: The volume directory of Elasticsearch data
+- `SEAFILE_VOLUME`: The volume directory of Seafile data, default is `/opt/seafile-data`
+- `SEAFILE_MYSQL_VOLUME`: The volume directory of MySQL data, default is `/opt/seafile-mysql/db`
+- `SEAFILE_CADDY_VOLUME`: The volume directory of Caddy data used to store certificates obtained from Let's Encrypt's, default is `/opt/seafile-caddy`
+- `SEAFILE_ELASTICSEARCH_VOLUME`: The volume directory of Elasticsearch data
 - `SEAFILE_MYSQL_ROOT_PASSWORD`: The `root` password of MySQL
 - `SEAFILE_MYSQL_DB_PASSWORD`: The user `seafile` password of MySQL
 - `JWT`: JWT_PRIVATE_KEY, A random string with a length of no less than 32 characters, generate example: `pwgen -s 40 1`

diff --git a/manual/docker/seafile_docker_structures.md → manual/docker/seafile_docker_overview.md b/manual/docker/seafile_docker_structures.md → manual/docker/seafile_docker_overview.md
@@ -1,11 +1,11 @@
-# Seafile Docker Structures
+# Seafile Docker overview
 
-Seafile Docker consists of the following two components:
+Seafile Docker consists of the following components:
 
 - Seafile server: Seafile core services, see [Seafile Components](../overview/components.md) for the details.
 - Sdoc server: SeaDoc server, provide a lightweight online collaborative document editor, see [SeaDoc](../extra_setup/setup_seadoc.md#architecture) for the details.
 - Database: Stores data related to Seafile and SeaDoc.
 - Memcached: Cache server.
-- Caddy: Caddy server enables user to access the seafile service (i.e., Seafile server and Sdoc server) externally and handles `SSL` configuration
+- Caddy: Caddy server enables user to access the Seafile service (i.e., Seafile server and Sdoc server) externally and handles `SSL` configuration
 
 ![Seafile Docker Structure](../images/seafile-12.0-docker-structure.png)
diff --git a/manual/upgrade/upgrade_docker.md b/manual/upgrade/upgrade_docker.md
@@ -119,10 +119,10 @@ wget https://manual.seafile.com/docker/docker-compose/pro/12.0/caddy.yml
 
 The following fields merit particular attention:
 
-* The volume directory of Seafile data (SEAFILE_VOLUMES, same as the seafile volumes in the old docker-compose.yml)
-* The volume directory of MySQL data (SEAFILE_MYSQL_VOLUMES, same as the mysql volumes in the old docker-compose.yml)
-* The volume directory of Elasticsearch data (SEAFILE_ELASTICSEARCH_VOLUMES, pro edition only, same as the elasticsearch volumes in the old docker-compose.yml)
-* The volume directory of Caddy data (SEAFILE_CADDY_VOLUMES)
+* The volume directory of Seafile data (SEAFILE_VOLUME, same as the seafile volumes in the old docker-compose.yml)
+* The volume directory of MySQL data (SEAFILE_MYSQL_VOLUME, same as the mysql volumes in the old docker-compose.yml)
+* The volume directory of Elasticsearch data (SEAFILE_ELASTICSEARCH_VOLUME, pro edition only, same as the elasticsearch volumes in the old docker-compose.yml)
+* The volume directory of Caddy data (SEAFILE_CADDY_VOLUME)
 * The user of MySQL (SEAFILE_MYSQL_DB_USER, `database` - `user` can be found in `conf/seafile.conf`)
 * The password of MySQL (SEAFILE_MYSQL_DB_PASSWORD, `database` - `password` can be found in `conf/seafile.conf`)
 * jwt (JWT_PRIVATE_KEY, A random string with a length of no less than 32 characters, generate example: `pwgen -s 40 1`)
@@ -199,15 +199,15 @@ wget https://manual.seafile.com/docker/docker-compose/pro/12.0/seadoc.yml
 ```env
 COMPOSE_FILE='seafile-server.yml,caddy.yml,seadoc.yml'
 
-SEADOC_VOLUMES=/opt/seadoc-data
+SEADOC_VOLUME=/opt/seadoc-data
 ENABLE_SEADOC=true
 SEADOC_SERVER_URL=http://example.seafile.com/sdoc-server
 ```
 
 The following fields merit particular attention:
 
 * Add `seadoc.yml` to the `COMPOSE_FILE` field.
-* The volume directory of SeaDoc data (SEADOC_VOLUMES)
+* The volume directory of SeaDoc data (SEADOC_VOLUME)
 * Enable SeaDoc (ENABLE_SEADOC)
 * SeaDoc service url (SEADOC_SERVER_URL, hostname + `/sdoc-server`)
 

diff --git a/manual/upgrade/upgrade_notes_for_12.0.x.md b/manual/upgrade/upgrade_notes_for_12.0.x.md
@@ -96,7 +96,7 @@ The following fields merit particular attention:
 * Seafile MySQL host (SEAFILE_MYSQL_DB_HOST)
 * Seafile MySQL user (SEAFILE_MYSQL_DB_USER)
 * Seafile MySQL password (SEAFILE_MYSQL_DB_PASSWD)
-* The volume directory of SeaDoc data (SEADOC_VOLUMES)
+* The volume directory of SeaDoc data (SEADOC_VOLUME)
 * SeaDoc service URL (SDOC_SERVER_HOSTNAME)
 * Seafile service URL (SEAHUB_SERVICE_URL)
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -77,7 +77,7 @@ nav:
       - Setup Seafile cluster with NFS: deploy_pro/setup_seafile_cluster_with_nfs.md
     - License: deploy_pro/seafile_professional_sdition_software_license_agreement.md
   - Seafile Setup with Docker:
-    - Seafile Docker Structures: docker/seafile_docker_structures.md
+    - Seafile Docker Overview: docker/seafile_docker_overview.md
     - Seafile Community Installation: docker/deploy_seafile_with_docker.md
     - Seafile Professional Installation: docker/pro-edition/deploy_seafile_pro_with_docker.md
     - Seafile Docker Cluster Deployment: docker/cluster/deploy_seafile_cluster_with_docker.md