diff --git a/manual/config/env.md b/manual/config/env.md index 46a62b8a..08a06fcb 100644 --- a/manual/config/env.md +++ b/manual/config/env.md @@ -75,6 +75,8 @@ This part of configurations is only valid in `CACHE_PROVIDER=memcached`: - `S3_COMMIT_BUCKET`: S3 storage backend fs objects bucket - `S3_FS_BUCKET`: S3 storage backend block objects bucket - `S3_BLOCK_BUCKET`: S3 storage backend block objects bucket +- `S3_SS_BUCKET`: S3 storage bucket for SeaSearch data (valid when service enabled) +- `S3_MD_BUCKET`: S3 storage bucket for metadata-sever data (valid when service available) - `S3_KEY_ID`: S3 storage backend key ID - `S3_SECRET_KEY`: S3 storage backend secret key - `S3_USE_V4_SIGNATURE`: Use the v4 protocol of S3 if enabled, default is `true` @@ -85,17 +87,7 @@ This part of configurations is only valid in `CACHE_PROVIDER=memcached`: - `S3_SSE_C_KEY`: A string of 32 characters can be generated by openssl rand -base64 24. It can be any 32-character long random string. It's required to use V4 authentication protocol and https if you enable SSE-C. !!! success "Easier to configure S3 for Seafile and its components" - Since Seafile Pro 13.0, in order to facilitate users to deploy Seafile's related extension components and other services in the future, a section will be provided in `.env` to store the **S3 authorization Configurations**. You can locate it with the following title bar: - - ```sh - ################################### - # S3 authorization Configurations # - # (This configurations will # - # apply to all components) # - ################################### - ``` - - The S3 authorization configuration part (i.e., ***without buckets name***) in Seafile and some extension components (such as *SeaSearch*, *Metadata server*) configuration will be read from this configuration by default. + Since Seafile Pro 13.0, in order to facilitate users to deploy Seafile's related extension components and other services in the future, a section will be provided in `.env` to store the **S3 Configurations** for Seafile and some extension components (such as *SeaSearch*, *Metadata server*). You can locate it with the title bar **\#\#S3**. However, please note that Seafile only support configuring S3 in `.env` for **single storage backend mode** (i.e., when `USE_S3_STORAGE=true`), if you would like to use multiple backends, please set `USE_S3_STORAGE=false` in `.env` and refer [here](../setup/setup_with_multiple_storage_backends.md) for the details. diff --git a/manual/extension/metadata-server.md b/manual/extension/metadata-server.md index 39005ad9..f8169905 100644 --- a/manual/extension/metadata-server.md +++ b/manual/extension/metadata-server.md @@ -45,12 +45,11 @@ To facilitate your deployment, we still provide two different configuration solu #### Example `.env` for Seafile data is stored locally -In this case you don't need to add any additional configuration to your `.env`. You can also specify image version, maximum local cache size, etc., but you must make sure `MD_STORAGE_TYPE=file` +In this case you don't need to add any additional configuration to your `.env`. You can also specify image version, maximum local cache size, etc. ``` MD_IMAGE=seafileltd/seafile-md-server:latest MD_MAX_CACHE_SIZE=1GB -MD_STORAGE_TYPE=file ``` #### Example `.env` for Seafile data is stored in the storage backend (e.g., S3) @@ -58,28 +57,24 @@ MD_STORAGE_TYPE=file First you need to create a bucket for Metadata on your S3 storage backend provider. Then add or modify the following information to `.env`: !!! success "Easier to configure S3 for Seafile and its components" - Since Seafile Pro 13.0, in order to facilitate users to deploy Seafile's related extension components and other services in the future, a section will be provided in `.env` to store the **S3 authorization Configurations**. You can locate it with the following title bar: - - ```sh - ################################### - # S3 authorization Configurations # - # (This configurations will # - # apply to all components) # - ################################### - ``` - - The S3 authorization configuration part (i.e., ***without buckets name***) in Seafile and some extension components (such as *SeaSearch*, *Metadata server*) configuration will be read from this configuration by default. + Since Seafile Pro 13.0, in order to facilitate users to deploy Seafile's related extension components and other services in the future, a section will be provided in `.env` to store the **S3 Configurations** for Seafile and some extension components (such as *SeaSearch*, *Metadata server*). You can locate it with the title bar **\#\#S3**. - In other words, if you deploy SeaSearch and Seafile together, and if you have deployed Seafile Pro following [here](../setup/setup_pro_by_docker.md#downloading-and-modifying-env) (and using the latest `.env`), you only need to specify the following variables in `.env` to make it work: + In other words, if you deploy SeaSearch and Seafile together, and if you have deployed Seafile Pro following [here](../setup/setup_pro_by_docker.md#downloading-and-modifying-env) (and using the latest `.env`), you only need to specify the following variables in `.env` to make it work (that is, the `USE_S3_STORAGE` is set to `true`): ```sh + S3_COMMIT_BUCKET= + S3_FS_BUCKET= + S3_BLOCK_BUCKET= S3_MD_BUCKET= ``` ```sh MD_IMAGE=seafileltd/seafile-md-server:latest -MD_STORAGE_TYPE=s3 -S3_MD_BUCKET= +USE_S3_STORAGE=true +S3_COMMIT_BUCKET=... +S3_FS_BUCKET=... +S3_BLOCK_BUCKET=... +S3_MD_BUCKET=... ``` #### List of environment variables for Metadata server @@ -89,13 +84,15 @@ The following table is all the related environment variables with Metadata serve | --- | --- | --- | | `JWT_PRIVATE_KEY` | The JWT key used to connect with Seafile server | **Required** | | `MD_MAX_CACHE_SIZE` | The maximum cache size. | Optional, default `1GB` | -| `MD_STORAGE_TYPE` | The type of Seafile backend storage. Options: `file` (local storage), `s3`, `oss`. | Optional, default `file` and `s3` in deploying metadata server in the same machine with Seafile and standalone respective | | `REDIS_HOST` | Your *Redis* service host. | Optional, default `redis` | | `REDIS_PORT` | Your *Redis* service port. | Optional, default `6379` | | `REDIS_PASSWORD` | Your *Redis* access password. | Optional | -| `S3_MD_BUCKET` | Your S3 bucket name for the bucket storing metadata | Required when using S3 | +| `S3_MD_BUCKET` | Your S3 bucket name for the bucket storing metadata | Required when using S3 (`USE_S3_STORAGE` = `true`) | -In addition, there are some environment variables **related to S3 authorization**, please refer to the part with `S3_` prefix in this [table](../setup/setup_pro_by_docker.md#downloading-and-modifying-env). +In addition, there are some environment variables **related to S3 authorization**, please refer to the part with `S3_` prefix in this [table](../setup/setup_pro_by_docker.md#downloading-and-modifying-env) (**the buckets name for Seafile are also needed**). + +!!! warning "Metadata server supports *Redis* only" + To enable metadata feature, you have to use *Redis* for cache, as the `CACHE_PROVIDER` must be set to `redis` in your `.env` ### Modify `seahub_settings.py` diff --git a/manual/repo/docker/md-server.yml b/manual/repo/docker/md-server.yml index 1491f42f..a00b6673 100644 --- a/manual/repo/docker/md-server.yml +++ b/manual/repo/docker/md-server.yml @@ -17,21 +17,20 @@ services: - MD_PORT=${MD_PORT:-8084} - MD_LOG_LEVEL=${MD_LOG_LEVEL:-info} - MD_MAX_CACHE_SIZE=${MD_MAX_CACHE_SIZE:-1GB} - - MD_STORAGE_TYPE=${MD_STORAGE_TYPE:-file} - - MD_S3_BUCKET=${S3_MD_BUCKET:-} - - MD_S3_HOST=${S3_HOST:-} - - MD_S3_AWS_REGION=${S3_AWS_REGION:-} - - MD_S3_USE_HTTPS=${S3_USE_HTTPS:-true} - - MD_S3_PATH_STYLE_REQUEST=${S3_PATH_STYLE_REQUEST:-false} - - MD_S3_KEY_ID=${S3_KEY_ID:-} - - MD_S3_KEY=${S3_SECRET_KEY:-} - - MD_S3_USE_V4_SIGNATURE=${S3_USE_V4_SIGNATURE:-true} - - MD_S3_SSE_C_KEY=${S3_SSE_C_KEY:-} - - MD_OSS_HOST=${MD_OSS_HOST:-} - - MD_OSS_REGION=${MD_OSS_REGION:-} - - MD_OSS_BUCKET=${MD_OSS_BUCKET:-} - - MD_OSS_KEY_ID=${MD_OSS_KEY_ID:-} - - MD_OSS_KEY=${MD_OSS_KEY:-} + - USE_S3_STORAGE=${USE_S3_STORAGE:-false} + - S3_COMMIT_BUCKET=${S3_COMMIT_BUCKET:-} + - S3_FS_BUCKET=${S3_FS_BUCKET:-} + - S3_BLOCK_BUCKET=${S3_BLOCK_BUCKET:-} + - S3_MD_BUCKET=${S3_MD_BUCKET:-} + - S3_HOST=${S3_HOST:-} + - S3_AWS_REGION=${S3_AWS_REGION:-} + - S3_USE_HTTPS=${S3_USE_HTTPS:-true} + - S3_PATH_STYLE_REQUEST=${S3_PATH_STYLE_REQUEST:-false} + - S3_KEY_ID=${S3_KEY_ID:-} + - S3_SECRET_KEY=${S3_SECRET_KEY:-} + - S3_USE_V4_SIGNATURE=${S3_USE_V4_SIGNATURE:-true} + - S3_SSE_C_KEY=${S3_SSE_C_KEY:-} + - CACHE_PROVIDER=${CACHE_PROVIDER:-redis} - REDIS_HOST=${REDIS_HOST:-redis} - REDIS_PORT=${REDIS_PORT:-6379} - REDIS_PASSWORD=${REDIS_PASSWORD:-} diff --git a/manual/repo/docker/metadata-server/env b/manual/repo/docker/metadata-server/env index 440d8258..ad94d259 100644 --- a/manual/repo/docker/metadata-server/env +++ b/manual/repo/docker/metadata-server/env @@ -4,7 +4,6 @@ JWT_PRIVATE_KEY= MD_PORT=8084 # not recommond to modify MD_LOG_LEVEL=info MD_MAX_CACHE_SIZE=1GB -MD_STORAGE_TYPE=s3 MD_DATA=/opt/md-data # for MySQL @@ -16,6 +15,10 @@ SEAFILE_MYSQL_DB_SEAFILE_DB_NAME=seafile_db SEAFILE_LOG_TO_STDOUT=false # for s3 configurations +USE_S3_STORAGE=false +S3_COMMIT_BUCKET= +S3_FS_BUCKET= +S3_BLOCK_BUCKET= S3_MD_BUCKET= S3_HOST= S3_AWS_REGION= @@ -26,13 +29,6 @@ S3_KEY= S3_USE_V4_SIGNATURE=true S3_SSE_C_KEY= -# for oss configurations -MD_OSS_HOST= -MD_OSS_REGION= -MD_OSS_BUCKET= -MD_OSS_KEY_ID= -MD_OSS_KEY= - # for Redis REDIS_HOST= REDIS_PORT=6379 diff --git a/manual/repo/docker/metadata-server/md-server.yml b/manual/repo/docker/metadata-server/md-server.yml index 6f60d844..f6e4cd3d 100644 --- a/manual/repo/docker/metadata-server/md-server.yml +++ b/manual/repo/docker/metadata-server/md-server.yml @@ -17,21 +17,20 @@ services: - MD_PORT=${MD_PORT:-8084} - MD_LOG_LEVEL=${MD_LOG_LEVEL:-info} - MD_MAX_CACHE_SIZE=${MD_MAX_CACHE_SIZE:-1GB} - - MD_STORAGE_TYPE=${MD_STORAGE_TYPE:-file} - - MD_S3_HOST=${S3_HOST:-} - - MD_S3_AWS_REGION=${S3_AWS_REGION:-} - - MD_S3_USE_HTTPS=${S3_USE_HTTPS:-true} - - MD_S3_BUCKET=${S3_MD_BUCKET:-} - - MD_S3_PATH_STYLE_REQUEST=${S3_PATH_STYLE_REQUEST:-false} - - MD_S3_KEY_ID=${S3_KEY_ID:-} - - MD_S3_KEY=${S3_SECRET_KEY:-} - - MD_S3_USE_V4_SIGNATURE=${S3_USE_V4_SIGNATURE:-true} - - MD_S3_SSE_C_KEY=${S3_SSE_C_KEY:-} - - MD_OSS_HOST=${MD_OSS_HOST:-} - - MD_OSS_REGION=${MD_OSS_REGION:-} - - MD_OSS_BUCKET=${MD_OSS_BUCKET:-} - - MD_OSS_KEY_ID=${MD_OSS_KEY_ID:-} - - MD_OSS_KEY=${MD_OSS_KEY:-} + - USE_S3_STORAGE=${USE_S3_STORAGE:-false} + - S3_COMMIT_BUCKET=${S3_COMMIT_BUCKET:-} + - S3_FS_BUCKET=${S3_FS_BUCKET:-} + - S3_BLOCK_BUCKET=${S3_BLOCK_BUCKET:-} + - S3_MD_BUCKET=${S3_MD_BUCKET:-} + - S3_HOST=${S3_HOST:-} + - S3_AWS_REGION=${S3_AWS_REGION:-} + - S3_USE_HTTPS=${S3_USE_HTTPS:-true} + - S3_PATH_STYLE_REQUEST=${S3_PATH_STYLE_REQUEST:-false} + - S3_KEY_ID=${S3_KEY_ID:-} + - S3_SECRET_KEY=${S3_SECRET_KEY:-} + - S3_USE_V4_SIGNATURE=${S3_USE_V4_SIGNATURE:-true} + - S3_SSE_C_KEY=${S3_SSE_C_KEY:-} + - CACHE_PROVIDER=redis - REDIS_HOST=${REDIS_HOST:?Variable is not set or empty} - REDIS_PORT=${REDIS_PORT:-6379} - REDIS_PASSWORD=${REDIS_PASSWORD:-} diff --git a/manual/repo/docker/pro/env b/manual/repo/docker/pro/env index 84ddec56..7d2eefda 100644 --- a/manual/repo/docker/pro/env +++ b/manual/repo/docker/pro/env @@ -63,7 +63,16 @@ USE_S3_STORAGE=false S3_COMMIT_BUCKET= S3_FS_BUCKET= S3_BLOCK_BUCKET= - +S3_SS_BUCKET= # for seasearch +S3_MD_BUCKET= # for metadata-server +S3_KEY_ID= +S3_SECRET_KEY= +S3_USE_V4_SIGNATURE=true +S3_PATH_STYLE_REQUEST=false +S3_AWS_REGION=us-east-1 +S3_HOST= +S3_USE_HTTPS=true +S3_SSE_C_KEY= ###################################### # Initial variables # @@ -91,40 +100,13 @@ ENABLE_SEADOC=true ## SeaSearch -### Storage type -SS_STORAGE_TYPE=disk # options: disk (local disk), s3 - ### Local cache SS_MAX_OBJ_CACHE_SIZE=10GB -### S3 -S3_SS_BUCKET= - ### Log SS_LOG_TO_STDOUT=false SS_LOG_OUTPUT=true SS_LOG_LEVEL=info -## Metadata server -MD_STORAGE_TYPE=file # options: file (local disk), s3, oss - -### S3 -S3_MD_BUCKET= - ## Notification NOTIFICATION_SERVER_URL= - -################################### -# S3 authorization Configurations # -# (This configurations will # -# apply to all components) # -################################### - -S3_KEY_ID= -S3_SECRET_KEY= -S3_USE_V4_SIGNATURE=true -S3_PATH_STYLE_REQUEST=false -S3_AWS_REGION=us-east-1 -S3_HOST= -S3_USE_HTTPS=true -S3_SSE_C_KEY= diff --git a/manual/repo/docker/pro/seasearch.yml b/manual/repo/docker/pro/seasearch.yml index e1e1345f..fd18453b 100644 --- a/manual/repo/docker/pro/seasearch.yml +++ b/manual/repo/docker/pro/seasearch.yml @@ -7,17 +7,17 @@ services: environment: - SS_FIRST_ADMIN_USER=${INIT_SS_ADMIN_USER:-} - SS_FIRST_ADMIN_PASSWORD=${INIT_SS_ADMIN_PASSWORD:-} - - SS_STORAGE_TYPE=${SS_STORAGE_TYPE:-} - SS_MAX_OBJ_CACHE_SIZE=${SS_MAX_OBJ_CACHE_SIZE:-10GB} - - SS_S3_BUCKET=${S3_SS_BUCKET:-} - - SS_S3_ACCESS_ID=${S3_KEY_ID:-} - - SS_S3_USE_V4_SIGNATURE=${S3_USE_V4_SIGNATURE:-true} - - SS_S3_ACCESS_SECRET=${S3_SECRET_KEY:-} - - SS_S3_ENDPOINT=${S3_HOST:-} - - SS_S3_USE_HTTPS=${S3_USE_HTTPS:-true} - - SS_S3_PATH_STYLE_REQUEST=${S3_PATH_STYLE_REQUEST:-true} - - SS_S3_AWS_REGION=${S3_AWS_REGION:-us-east-1} - - SS_S3_SSE_C_KEY=${S3_SSE_C_KEY:-} + - USE_S3_STORAGE=${USE_S3_STORAGE:-false} + - S3_SS_BUCKET=${S3_SS_BUCKET:-} + - S3_KEY_ID=${S3_KEY_ID:-} + - S3_USE_V4_SIGNATURE=${S3_USE_V4_SIGNATURE:-true} + - S3_SECRET_KEY=${S3_SECRET_KEY:-} + - S3_HOST=${S3_HOST:-} + - S3_USE_HTTPS=${S3_USE_HTTPS:-true} + - S3_PATH_STYLE_REQUEST=${S3_PATH_STYLE_REQUEST:-true} + - S3_AWS_REGION=${S3_AWS_REGION:-us-east-1} + - S3_SSE_C_KEY=${S3_SSE_C_KEY:-} - SS_LOG_TO_STDOUT=${SS_LOG_TO_STDOUT:-false} - SS_LOG_DIR=${SS_LOG_DIR:-/opt/seasearch/data/log} - SS_LOG_LEVEL=${SS_LOG_LEVEL:-info} diff --git a/manual/repo/k8s/ce/seafile-env.yaml b/manual/repo/k8s/ce/seafile-env.yaml index c4a807ba..830acf96 100644 --- a/manual/repo/k8s/ce/seafile-env.yaml +++ b/manual/repo/k8s/ce/seafile-env.yaml @@ -7,8 +7,6 @@ data: TIME_ZONE: "UTC" SEAFILE_LOG_TO_STDOUT: "false" SITE_ROOT: "/" - ENABLE_SEADOC: "false" - SEADOC_SERVER_URL: "https://seafile.example.com/sdoc-server" # only valid in ENABLE_SEADOC = true SEAFILE_SERVER_HOSTNAME: "seafile.example.com" SEAFILE_SERVER_PROTOCOL: "http" @@ -35,6 +33,10 @@ data: # for notification NOTIFICATION_SERVER_URL: "" + # for seadoc + ENABLE_SEADOC: "false" + SEADOC_SERVER_URL: "" # only valid in ENABLE_SEADOC = true + # Init ## for Seafile admin INIT_SEAFILE_ADMIN_EMAIL: "" \ No newline at end of file diff --git a/manual/repo/k8s/cluster/seafile-env.yaml b/manual/repo/k8s/cluster/seafile-env.yaml index a2ae33d9..c7638ca5 100644 --- a/manual/repo/k8s/cluster/seafile-env.yaml +++ b/manual/repo/k8s/cluster/seafile-env.yaml @@ -7,8 +7,6 @@ data: TIME_ZONE: "UTC" SEAFILE_LOG_TO_STDOUT: "true" SITE_ROOT: "/" - ENABLE_SEADOC: "false" - SEADOC_SERVER_URL: "https://seafile.example.com/sdoc-server" # only valid in ENABLE_SEADOC = true SEAFILE_SERVER_HOSTNAME: "seafile.example.com" SEAFILE_SERVER_PROTOCOL: "http" @@ -40,6 +38,10 @@ data: # for notification NOTIFICATION_SERVER_URL: "" + # for seadoc + ENABLE_SEADOC: "false" + SEADOC_SERVER_URL: "" # only valid in ENABLE_SEADOC = true + # initialization (only valid in first-time deployment and CLUSTER_INIT_MODE = true) CLUSTER_INIT_MODE: "true" diff --git a/manual/repo/k8s/pro/seafile-env.yaml b/manual/repo/k8s/pro/seafile-env.yaml index c54d7c29..c2951562 100644 --- a/manual/repo/k8s/pro/seafile-env.yaml +++ b/manual/repo/k8s/pro/seafile-env.yaml @@ -7,8 +7,6 @@ data: TIME_ZONE: "UTC" SEAFILE_LOG_TO_STDOUT: "false" SITE_ROOT: "/" - ENABLE_SEADOC: "false" - SEADOC_SERVER_URL: "https://seafile.example.com/sdoc-server" # only valid in ENABLE_SEADOC = true SEAFILE_SERVER_HOSTNAME: "seafile.example.com" SEAFILE_SERVER_PROTOCOL: "http" @@ -47,6 +45,10 @@ data: # for notification NOTIFICATION_SERVER_URL: "" + # for seadoc + ENABLE_SEADOC: "false" + SEADOC_SERVER_URL: "" # only valid in ENABLE_SEADOC = true + # Init ## for Seafile admin INIT_SEAFILE_ADMIN_EMAIL: "" diff --git a/manual/setup/helm_chart_cluster.md b/manual/setup/helm_chart_cluster.md index bfa9e1fd..76053321 100644 --- a/manual/setup/helm_chart_cluster.md +++ b/manual/setup/helm_chart_cluster.md @@ -260,28 +260,28 @@ After installation, you need to start the k8s control plane service on each node seafile: ... extraVolumes: - backend: - - name: seafileLicense - volumeInfo: - secret: - secretName: seafile-license - items: - - key: seafile-license.txt - path: seafile-license.txt - subPath: seafile-license.txt - mountPath: /shared/seafile/seafile-license.txt - readOnly: true - frontend: - - name: seafileLicense - volumeInfo: - secret: - secretName: seafile-license - items: - - key: seafile-license.txt - path: seafile-license.txt - subPath: seafile-license.txt - mountPath: /shared/seafile/seafile-license.txt - readOnly: true + backend: + - name: seafileLicense + volumeInfo: + secret: + secretName: seafile-license + items: + - key: seafile-license.txt + path: seafile-license.txt + subPath: seafile-license.txt + mountPath: /shared/seafile/seafile-license.txt + readOnly: true + frontend: + - name: seafileLicense + volumeInfo: + secret: + secretName: seafile-license + items: + - key: seafile-license.txt + path: seafile-license.txt + subPath: seafile-license.txt + mountPath: /shared/seafile/seafile-license.txt + readOnly: true ``` Finally you can upgrade your chart by: diff --git a/manual/setup/helm_chart_single_node.md b/manual/setup/helm_chart_single_node.md index c947f49f..056ba4cc 100644 --- a/manual/setup/helm_chart_single_node.md +++ b/manual/setup/helm_chart_single_node.md @@ -142,13 +142,13 @@ kubectl delete pods -n seafile $(kubectl get pods -n seafile -o jsonpath='{.item seafile: ... extraVolumes: - - name: seafileLicense - volumeInfo: - secret: - secretName: seafile-license - items: - - key: seafile-license.txt - path: seafile-license.txt + - name: seafileLicense + volumeInfo: + secret: + secretName: seafile-license + items: + - key: seafile-license.txt + path: seafile-license.txt subPath: seafile-license.txt mountPath: /shared/seafile/seafile-license.txt readOnly: true diff --git a/manual/setup/setup_pro_by_docker.md b/manual/setup/setup_pro_by_docker.md index 268a427e..ed140043 100644 --- a/manual/setup/setup_pro_by_docker.md +++ b/manual/setup/setup_pro_by_docker.md @@ -88,17 +88,7 @@ The following fields merit particular attention: | `NOTIFICATION_SERVER_URL` | The [notification server](../extension/notification-server.md) url, leave blank to disable it | (none) | !!! success "Easier to configure S3 for Seafile and its components" - Since Seafile Pro 13.0, in order to facilitate users to deploy Seafile's related extension components and other services in the future, a section will be provided in `.env` to store the **S3 authorization Configurations**. You can locate it with the following title bar: - - ```sh - ################################### - # S3 authorization Configurations # - # (This configurations will # - # apply to all components) # - ################################### - ``` - - The S3 authorization configuration part (i.e., ***without buckets name***) in Seafile and some extension components (such as *SeaSearch*, *Metadata server*) configuration will be read from this configuration by default. + Since Seafile Pro 13.0, in order to facilitate users to deploy Seafile's related extension components and other services in the future, a section will be provided in `.env` to store the **S3 Configurations** for Seafile and some extension components (such as *SeaSearch*, *Metadata server*). You can locate it with the title bar **\#\#S3**. However, please note that Seafile only support configuring S3 in `.env` for **single storage backend mode** (i.e., when `USE_S3_STORAGE=true`), if you would like to use multiple backends, please set `USE_S3_STORAGE=false` in `.env` and refer [here](../setup/setup_with_multiple_storage_backends.md) for the details. diff --git a/manual/setup/setup_with_s3.md b/manual/setup/setup_with_s3.md index af13698f..0112f33d 100644 --- a/manual/setup/setup_with_s3.md +++ b/manual/setup/setup_with_s3.md @@ -18,7 +18,7 @@ !!! tip "New feature from 13.0 pro edition" - If your will deploy Seafile server in Docker, you can specify your S3 configurations in `S3 authorization Configurations` title bar in `.env` to deploy with S3 together. This operation will generate the same configuration file as this manual. + If your will deploy Seafile server in Docker, you can specify your S3 configurations in `S3` title bar in `.env` to deploy with S3 together. This operation will generate the same configuration file as this manual. However, please note that Seafile only support configuring S3 in `.env` for **single storage backend mode** (i.e., when `USE_S3_STORAGE=true`), if you would like to use multiple backends, please set `USE_S3_STORAGE=false` in `.env` and refer [here](../setup/setup_with_multiple_storage_backends.md) for the details. diff --git a/manual/setup/use_seasearch.md b/manual/setup/use_seasearch.md index b01c489e..6fbdee81 100644 --- a/manual/setup/use_seasearch.md +++ b/manual/setup/use_seasearch.md @@ -41,21 +41,12 @@ INIT_SS_ADMIN_PASSWORD= ``` !!! success "Easier to configure S3 for Seafile and its components" - Since Seafile Pro 13.0, in order to facilitate users to deploy Seafile's related extension components and other services in the future, a section will be provided in `.env` to store the **S3 authorization Configurations**. You can locate it with the following title bar: - - ```sh - ################################### - # S3 authorization Configurations # - # (This configurations will # - # apply to all components) # - ################################### - ``` - - The S3 authorization configuration part (i.e., ***without buckets name***) in Seafile and some extension components (such as *SeaSearch*, *Metadata server*) configuration will be read from this configuration by default. + Since Seafile Pro 13.0, in order to facilitate users to deploy Seafile's related extension components and other services in the future, a section will be provided in `.env` to store the **S3 Configurations** for Seafile and some extension components (such as *SeaSearch*, *Metadata server*). You can locate it with the title bar **\#\#S3**. - In other words, if you deploy SeaSearch and Seafile together, and if you have deployed Seafile Pro following [here](../setup/setup_pro_by_docker.md#downloading-and-modifying-env) (and using the latest `.env`), you only need to specify the following variables in `.env` to make it work: + In other words, if you deploy SeaSearch and Seafile together, and if you have deployed Seafile Pro following [here](../setup/setup_pro_by_docker.md#downloading-and-modifying-env) (and using the latest `.env`), you only need to specify the following variables in `.env` to make it work (that is, the `USE_S3_STORAGE` is set to `true`): ```sh + USE_S3_STORAGE=true S3_SS_BUCKET= ```