diff --git a/en/learn-more/faq/install-faq.mdx b/en/learn-more/faq/install-faq.mdx index e7ea3a04..124646b4 100644 --- a/en/learn-more/faq/install-faq.mdx +++ b/en/learn-more/faq/install-faq.mdx @@ -243,11 +243,16 @@ Remember the IP addresses. Then open the directory where you store the Dify sour These IP addresses are _**examples**_, you must execute the command to get your own IP addresses, do not fill them in directly. You might need to reconfigure the IP addresses when restarting the relevant containers. -### 21. How to modify the API service port number? +### 21. How to enable Content Security Policy? + +Find the `CSP_WHITELIST` parameter in the `.env` configuration file and enter the domain names that you can allow, such as all URLs and API request addresses related to product use. +This behavior helps reduce potential XSS attacks. For more information on CSP recommendations, see [Content Security Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP). + +### 22. How to modify the API service port number? The API service port is consistent with the one used by the Dify platform. You can reassign the running port by modifying the `nginx` configuration in the `docker-compose.yaml` file. -### 22. How to Migrate from Local to Cloud Storage? +### 23. How to Migrate from Local to Cloud Storage? To migrate files from local storage to cloud storage (e.g., Alibaba Cloud OSS), you'll need to transfer data from the 'upload_files' and 'privkeys' folders. Follow these steps: @@ -276,3 +281,96 @@ To migrate files from local storage to cloud storage (e.g., Alibaba Cloud OSS), docker exec -it docker-api-1 flask upload-private-key-file-to-cloud-storage docker exec -it docker-api-1 flask upload-local-files-to-cloud-storage ``` + +### 24. How to delete old logs and unused files to reduce storage usage? + +Dify does **not** automatically delete old logs in database or unused files on storage. Instead, several commands are provided for instance administrators to **manually** delete old logs and unused files. + +**Deleting old logs** + +You can delete old logs by specifying the number of days using the `clear-free-plan-tenant-expired-logs` command. For example, to delete logs older than 30 days, run the following command: + +1. Gather the tenant ID + + ```bash + $ docker exec -it docker-api-1 bash -c "echo 'db.session.query(Tenant).all(); quit()' | flask shell" + ... + >>> [] + ``` + + - In this example, the tenant ID is `618b5d66-a1f5-4b6b-8d12-f171182a1cb2`. + +2. Delete old logs by specifying the tenant ID and number of days + + ```bash + $ docker exec -it docker-api-1 flask clear-free-plan-tenant-expired-logs --days 30 --batch 100 --tenant_ids 618b5d66-a1f5-4b6b-8d12-f171182a1cb2 + ... + Starting clear free plan tenant expired logs. + Clearing free plan tenant expired logs + Total tenant count: 1 + [2025-04-27 05:28:22.027032] Processed 2555 messages for tenant 618b5d66-a1f5-4b6b-8d12-f171182a1cb2 + [2025-04-27 05:28:22.085901] Processed 2190 conversations for tenant 618b5d66-a1f5-4b6b-8d12-f171182a1cb2 + [2025-04-27 05:28:22.112561] Processed 5110 workflow node executions for tenant 618b5d66-a1f5-4b6b-8d12-f171182a1cb2 + ``` + + - Use the `--tenant_ids` option to specify the tenant ID. + - Logs older than the number of days specified by the `--days` option will be deleted. + +**Deleting unused files** + +You can delete unused files using the `clear-orphaned-file-records` command and the `remove-orphaned-files-on-storage` command. + + + Since not all patterns have been fully tested, please note that these command may delete unintended file records or files. + Please make sure to back up your database and storage before proceeding. + It is also recommended to run this during the maintenance window, as this may cause high load on your instance. + + + + In the current implementation, deleting unused files is only supported when the storage type is OpenDAL (when the environment variable `STORAGE_TYPE` is set to `opendal`). + If you are using a storage type other than OpenDAL, you will need to manually delete unused files or [help implement the `scan` method for the storage interface](https://github.com/langgenius/dify/blob/main/api/extensions/storage/base_storage.py). + + +1. Delete unused file records from the database + + ```bash + $ docker exec -it docker-api-1 flask clear-orphaned-file-records + ... + !!! USE WITH CAUTION !!! + Since not all patterns have been fully tested, please note that this command may delete unintended file records. + This cannot be undone. Please make sure to back up your database before proceeding. + It is also recommended to run this during the maintenance window, as this may cause high load on your instance. + Do you want to proceed? [y/N]: y + ... + Found 365 orphaned file records. + - orphaned file id: 8a0387e6-dde7-411c-bac2-6e6d8af6ae31 + - orphaned file id: 9177f9df-7360-4434-b65f-10fdec7d38af + ... + Do you want to proceed to delete all 365 orphaned file records? [y/N]: y + - Deleting orphaned file records in table upload_files + - Deleting orphaned file records in table tool_files + Removed 365 orphaned file records. + ``` + +2. Delete files from storage that do not exist in the database + + ```bash + $ docker exec -it docker-api-1 flask remove-orphaned-files-on-storage + ... + !!! USE WITH CAUTION !!! + Currently, this command will work only for opendal based storage (STORAGE_TYPE=opendal). + Since not all patterns have been fully tested, please note that this command may delete unintended files. + This cannot be undone. Please make sure to back up your storage before proceeding. + It is also recommended to run this during the maintenance window, as this may cause high load on your instance. + Do you want to proceed? [y/N]: y + ... + Found 365 orphaned files. + - orphaned file: upload_files/618b5d66-a1f5-4b6b-8d12-f171182a1cb2/3a1d5e19-426a-4c10-91eb-cfb9b786f2dc.png + - orphaned file: upload_files/618b5d66-a1f5-4b6b-8d12-f171182a1cb2/795986eb-d213-4cc5-8c34-c121be43ab5e.png + ... + Do you want to proceed to remove all 365 orphaned files? [y/N]: y + - Removing orphaned file: upload_files/618b5d66-a1f5-4b6b-8d12-f171182a1cb2/3a1d5e19-426a-4c10-91eb-cfb9b786f2dc.png + - Removing orphaned file: upload_files/618b5d66-a1f5-4b6b-8d12-f171182a1cb2/795986eb-d213-4cc5-8c34-c121be43ab5e.png + ... + Removed 365 orphaned files without errors. + ``` diff --git a/ja-jp/learn-more/faq/install-faq.mdx b/ja-jp/learn-more/faq/install-faq.mdx index b2506fc8..45403597 100644 --- a/ja-jp/learn-more/faq/install-faq.mdx +++ b/ja-jp/learn-more/faq/install-faq.mdx @@ -275,4 +275,97 @@ API サービスのポートは、Dify プラットフォームで使用され ```bash docker exec -it docker-api-1 flask upload-private-key-file-to-cloud-storage docker exec -it docker-api-1 flask upload-local-files-to-cloud-storage - ``` \ No newline at end of file + ``` + +### 24. 古いログや未使用のファイルを削除し、ストレージの使用量を削減する方法 + +Dify はデータベース上の古いログやストレージ上の未使用のファイルの自動的な削除は **行いません**。代わりに、インスタンスの管理者が古いログや未使用のファイルを **手動で** 削除できるように、いくつかのコマンドが用意されています。 + +**古いログを削除する** + +`clear-free-plan-tenant-expired-logs` コマンドで、日数を指定して古いログを削除できます。たとえば、30日以上前のログを削除するには、次のコマンドを実行します。 + +1. テナント ID を確認する + + ```bash + $ docker exec -it docker-api-1 bash -c "echo 'db.session.query(Tenant).all(); quit()' | flask shell" + ... + >>> [] + ``` + + - この例では、テナント ID が `618b5d66-a1f5-4b6b-8d12-f171182a1cb2` であることがわかります。 + +2. テナント ID と日数を指定して、古いログを削除する + + ```bash + $ docker exec -it docker-api-1 flask clear-free-plan-tenant-expired-logs --days 30 --batch 100 --tenant_ids 618b5d66-a1f5-4b6b-8d12-f171182a1cb2 + ... + Starting clear free plan tenant expired logs. + Clearing free plan tenant expired logs + Total tenant count: 1 + [2025-04-27 05:28:22.027032] Processed 2555 messages for tenant 618b5d66-a1f5-4b6b-8d12-f171182a1cb2 + [2025-04-27 05:28:22.085901] Processed 2190 conversations for tenant 618b5d66-a1f5-4b6b-8d12-f171182a1cb2 + [2025-04-27 05:28:22.112561] Processed 5110 workflow node executions for tenant 618b5d66-a1f5-4b6b-8d12-f171182a1cb2 + ``` + + - `--tenant_ids` オプションでテナント ID を指定します。 + - `--days` オプションで指定した日数より古いログが削除されます。 + +**未使用のファイルを削除する** + +`clear-orphaned-file-records` コマンドと `remove-orphaned-files-on-storage` コマンドを使用して、未使用のファイルを削除できます。 + + + 全てのパタンが完全にテストされているわけではないため、このコマンドは意図しないファイルレコードやファイルを削除する可能性があります。 + 続行する前に、データベースとストレージのバックアップがあることを確認してください。 + また、この操作がインスタンスの高負荷につながる可能性があるため、メンテナンスウィンドウ中に実行することをおすすめします。 + + + + 現在の実装では、未使用のファイルの削除はストレージタイプが OpenDAL の場合（環境変数 `STORAGE_TYPE` が `opendal` の場合）のみサポートされています。 + OpenDAL 以外のストレージタイプを使用している場合は、未使用のファイルを手動で削除するか、[ストレージインタフェイスへの `scan` メソッドの実装にご協力ください](https://github.com/langgenius/dify/blob/main/api/extensions/storage/base_storage.py)。 + + +1. データベースから未使用のファイルのレコードを削除する + + ```bash + $ docker exec -it docker-api-1 flask clear-orphaned-file-records + ... + !!! USE WITH CAUTION !!! + Since not all patterns have been fully tested, please note that this command may delete unintended file records. + This cannot be undone. Please make sure to back up your database before proceeding. + It is also recommended to run this during the maintenance window, as this may cause high load on your instance. + Do you want to proceed? [y/N]: y + ... + Found 365 orphaned file records. + - orphaned file id: 8a0387e6-dde7-411c-bac2-6e6d8af6ae31 + - orphaned file id: 9177f9df-7360-4434-b65f-10fdec7d38af + ... + Do you want to proceed to delete all 365 orphaned file records? [y/N]: y + - Deleting orphaned file records in table upload_files + - Deleting orphaned file records in table tool_files + Removed 365 orphaned file records. + ``` + +2. ストレージからデータベースに存在しないファイルを削除する + + ```bash + $ docker exec -it docker-api-1 flask remove-orphaned-files-on-storage + ... + !!! USE WITH CAUTION !!! + Currently, this command will work only for opendal based storage (STORAGE_TYPE=opendal). + Since not all patterns have been fully tested, please note that this command may delete unintended files. + This cannot be undone. Please make sure to back up your storage before proceeding. + It is also recommended to run this during the maintenance window, as this may cause high load on your instance. + Do you want to proceed? [y/N]: y + ... + Found 365 orphaned files. + - orphaned file: upload_files/618b5d66-a1f5-4b6b-8d12-f171182a1cb2/3a1d5e19-426a-4c10-91eb-cfb9b786f2dc.png + - orphaned file: upload_files/618b5d66-a1f5-4b6b-8d12-f171182a1cb2/795986eb-d213-4cc5-8c34-c121be43ab5e.png + ... + Do you want to proceed to remove all 365 orphaned files? [y/N]: y + - Removing orphaned file: upload_files/618b5d66-a1f5-4b6b-8d12-f171182a1cb2/3a1d5e19-426a-4c10-91eb-cfb9b786f2dc.png + - Removing orphaned file: upload_files/618b5d66-a1f5-4b6b-8d12-f171182a1cb2/795986eb-d213-4cc5-8c34-c121be43ab5e.png + ... + Removed 365 orphaned files without errors. + ``` diff --git a/zh-hans/learn-more/faq/install-faq.mdx b/zh-hans/learn-more/faq/install-faq.mdx index 116e80a0..7acfc0db 100644 --- a/zh-hans/learn-more/faq/install-faq.mdx +++ b/zh-hans/learn-more/faq/install-faq.mdx @@ -221,7 +221,7 @@ http_access deny all 目前还不支持将你自己创建的应用设置为模板。现有的模板是由Dify官方为云版本用户参考提供的。如果你正在使用云版本，你可以将应用添加到你的工作空间或者在修改后定制它们以创建你自己的应用。如果你正在使用社区版本并且需要为你的团队创建更多的应用模板，你可以咨询我们的商务团队以获得付费技术支持：[business@dify.ai](mailto:business@dify.ai) -### 20.502 Bad Gateway +### 20. 502 Bad Gateway 这是因为Nginx将服务转发到了错误的位置导致的，首先确保容器正在运行，然后以Root权限运行以下命令： @@ -278,3 +278,96 @@ API 服务与 Dify 平台使用的端口号相一致。你可以通过修改 `do docker exec -it docker-api-1 flask upload-private-key-file-to-cloud-storage docker exec -it docker-api-1 flask upload-local-files-to-cloud-storage ``` + +### 24. 如何删除旧日志和未使用的文件以减少存储使用量？ + +Dify **不会** 自动删除数据库中的旧日志或存储中的未使用文件。相反，为了让实例管理员能够 **手动** 删除旧日志和未使用的文件，提供了几个命令。 + +**删除旧日志** + +你可以使用 `clear-free-plan-tenant-expired-logs` 命令指定天数来删除旧日志。例如，要删除超过30天的日志，请运行以下命令： + +1. 获取租户ID + + ```bash + $ docker exec -it docker-api-1 bash -c "echo 'db.session.query(Tenant).all(); quit()' | flask shell" + ... + >>> [] + ``` + + - 在此示例中，租户ID为 `618b5d66-a1f5-4b6b-8d12-f171182a1cb2`。 + +2. 通过指定租户ID和天数删除旧日志 + + ```bash + $ docker exec -it docker-api-1 flask clear-free-plan-tenant-expired-logs --days 30 --batch 100 --tenant_ids 618b5d66-a1f5-4b6b-8d12-f171182a1cb2 + ... + Starting clear free plan tenant expired logs. + Clearing free plan tenant expired logs + Total tenant count: 1 + [2025-04-27 05:28:22.027032] Processed 2555 messages for tenant 618b5d66-a1f5-4b6b-8d12-f171182a1cb2 + [2025-04-27 05:28:22.085901] Processed 2190 conversations for tenant 618b5d66-a1f5-4b6b-8d12-f171182a1cb2 + [2025-04-27 05:28:22.112561] Processed 5110 workflow node executions for tenant 618b5d66-a1f5-4b6b-8d12-f171182a1cb2 + ``` + + - 使用 `--tenant_ids` 选项指定租户ID。 + - 将删除比 `--days` 选项指定的天数更旧的日志。 + +**删除未使用的文件** + +你可以使用 `clear-orphaned-file-records` 命令和 `remove-orphaned-files-on-storage` 命令删除未使用的文件。 + + + 由于并非所有模式都经过完全测试，请注意这些命令可能会删除意外的文件记录或文件。 + 在继续之前，请确保备份数据库和存储。 + 还建议在维护窗口期间运行此操作，因为这可能会导致实例负载过高。 + + + + 在当前实现中，仅当存储类型为OpenDAL（当环境变量 `STORAGE_TYPE` 设置为 `opendal`）时，才支持删除未使用的文件。 + 如果你使用的存储类型不是OpenDAL，则需要手动删除未使用的文件，或者[帮助为存储接口实现 `scan` 方法](https://github.com/langgenius/dify/blob/main/api/extensions/storage/base_storage.py)。 + + +1. 从数据库中删除未使用的文件记录 + + ```bash + $ docker exec -it docker-api-1 flask clear-orphaned-file-records + ... + !!! USE WITH CAUTION !!! + Since not all patterns have been fully tested, please note that this command may delete unintended file records. + This cannot be undone. Please make sure to back up your database before proceeding. + It is also recommended to run this during the maintenance window, as this may cause high load on your instance. + Do you want to proceed? [y/N]: y + ... + Found 365 orphaned file records. + - orphaned file id: 8a0387e6-dde7-411c-bac2-6e6d8af6ae31 + - orphaned file id: 9177f9df-7360-4434-b65f-10fdec7d38af + ... + Do you want to proceed to delete all 365 orphaned file records? [y/N]: y + - Deleting orphaned file records in table upload_files + - Deleting orphaned file records in table tool_files + Removed 365 orphaned file records. + ``` + +2. 删除数据库中不存在的存储文件 + + ```bash + $ docker exec -it docker-api-1 flask remove-orphaned-files-on-storage + ... + !!! USE WITH CAUTION !!! + Currently, this command will work only for opendal based storage (STORAGE_TYPE=opendal). + Since not all patterns have been fully tested, please note that this command may delete unintended files. + This cannot be undone. Please make sure to back up your storage before proceeding. + It is also recommended to run this during the maintenance window, as this may cause high load on your instance. + Do you want to proceed? [y/N]: y + ... + Found 365 orphaned files. + - orphaned file: upload_files/618b5d66-a1f5-4b6b-8d12-f171182a1cb2/3a1d5e19-426a-4c10-91eb-cfb9b786f2dc.png + - orphaned file: upload_files/618b5d66-a1f5-4b6b-8d12-f171182a1cb2/795986eb-d213-4cc5-8c34-c121be43ab5e.png + ... + Do you want to proceed to remove all 365 orphaned files? [y/N]: y + - Removing orphaned file: upload_files/618b5d66-a1f5-4b6b-8d12-f171182a1cb2/3a1d5e19-426a-4c10-91eb-cfb9b786f2dc.png + - Removing orphaned file: upload_files/618b5d66-a1f5-4b6b-8d12-f171182a1cb2/795986eb-d213-4cc5-8c34-c121be43ab5e.png + ... + Removed 365 orphaned files without errors. + ```