5.5 KiB

Raw Blame History

本地部署相关

1. 本地部署初始化后，密码错误如何重置？

若使用 docker compose 方式部署，可执行以下命令进行重置

docker exec -it docker-api-1 flask reset-password

输入账户 email 以及两次新密码即可。

2. 本地部署日志中报 File not found 错误，如何解决？

ERROR:root:Unknown Error in completion
Traceback (most recent call last):
  File "/www/wwwroot/dify/dify/api/libs/rsa.py", line 45, in decrypt
    private_key = storage.load(filepath)
  File "/www/wwwroot/dify/dify/api/extensions/ext_storage.py", line 65, in load
    raise FileNotFoundError("File not found")
FileNotFoundError: File not found

该错误可能是由于更换了部署方式，或者 api/storage/privkeys 删除导致，这个文件是用来加密大模型密钥的，因此丢失后不可逆。可以使用如下命令进行重置加密公私钥：

Docker compose 部署

docker exec -it docker-api-1 flask reset-encrypt-key-pair

源代码启动

进入 api 目录
```
flask reset-encrypt-key-pair
```
按照提示进行重置。

3. 安装时后无法登录，登录成功，但后续接口均提示 401？

这可能是由于切换了域名/网址，导致前端和服务端跨域。跨域和身份会涉及到两方面的配置：

CORS 跨域配置
1. CONSOLE_CORS_ALLOW_ORIGINS
  
  控制台 CORS 跨域策略，默认为 *，即所有域名均可访问。
2. WEB_API_CORS_ALLOW_ORIGINS
  
  WebAPP CORS 跨域策略，默认为 *，即所有域名均可访问。
COOKIE 策略配置

Cookie 策略分为三个配置 HttpOnly、SameSite 和 Secure。
1. HttpOnly：默认为 true，正常不需要修改，用于防止 XSS 攻击，即 JS 无法获取 Cookie 内容，只能在 Http 请求中带上。
2. SameSite：分为三档，Strict、Lax 和 None，而由于 Dify 需要在 Github、Google 外部域名授权回调时能够从 Cookie 获取身份信息，因此只能在 Lax 和 None 之间选择，其中 None 完全可以跨域访问。
3. Secure：该参数限制是否服务端接口必须在 https 时下才可将 Cookie 存到本地，该参数在跨域时必须为 true（本地 localhost / 127.0.0.1 不同端口除外），否则浏览器不予通过。

推荐配置

根据上述配置说明，我们推荐这三种场景下的配置：

本地调试（默认策略）

开发模式同域策略。支持 HTTP/HTTPS 协议，但需要保证前端页面和接口同域。

WEB_API_CORS_ALLOW_ORIGINS: '*'
CONSOLE_CORS_ALLOW_ORIGINS: '*'
COOKIE_HTTPONLY: 'true'
COOKIE_SAMESITE: 'Lax'
COOKIE_SECURE: 'false'

跨域策略（请勿应在生产）

服务端与 web 客户端跨域，服务端必须为 https。由于 SameSite=None 必须配合 Secure=true，因此服务端必须为 https 协议才能实现跨域访问，可以用在服务端在远程并且提供 https 协议支持，或者本地单独启动服务端和前端项目（localhost，但不同端口，实测可用，虽然提示 warning）。
```
WEB_API_CORS_ALLOW_ORIGINS: 'https://your-domain-for-web-app'
CONSOLE_CORS_ALLOW_ORIGINS: 'https://your-domain-for-console'
COOKIE_HTTPONLY: 'true'
COOKIE_SAMESITE: 'None'
COOKIE_SECURE: 'true'
```
生产策略

严格模式。由于部分第三方集成需要支持回调并带着 cookie 信息，因此不能使用最高的 Strict 策略，因此需要严格限制 CORS 域名，以及设置 cookie 策略为 SameSite=Lax, Secure=true。
```
WEB_API_CORS_ALLOW_ORIGINS: 'https://your-domain-for-web-app'
CONSOLE_CORS_ALLOW_ORIGINS: 'https://your-domain-for-console'
COOKIE_HTTPONLY: 'true'
COOKIE_SAMESITE: 'Lax'
COOKIE_SECURE: 'true'
```

不可用场景

在前后端跨域，且服务端为 http 协议时，无任何 Cookie 策略可以支持该场景，请调整后端为 HTTPS 协议或者设置为同域。

4. 启动后页面一直在 loading，查看请求提示 CORS 错误？

这可能是由于切换了域名/网址，导致前端和服务端跨域，请将 docker-compose.yml 中所有的以下配置项改为新的域名：

CONSOLE_API_URL: 控制台 API 的后端 URL。 CONSOLE_WEB_URL: 控制台网页的前端 URL。 SERVICE_API_URL: 服务 API 的 URL。 APP_API_URL: WebApp API 的后端 URL。 APP_WEB_URL: WebApp 的 URL。

更多信息，请查看：环境变量

5. 部署后如何升级版本？

如果你是通过镜像启动，请重新拉取最新镜像完成升级。如果你是通过源码启动，请拉取最新代码，然后启动，完成升级。

6. 使用 Notion 导入时如何配置环境变量

问： Notion 的集成配置地址是什么？

答： https://www.notion.so/my-integrations

问：需要配置哪些环境变量？

答：进行私有化部署时，请设置以下配置：

NOTION_INTEGRATION_TYPE ：该值应配置为（public/internal）。由于 Notion 的 Oauth 重定向地址仅支持 https，如果在本地部署，请使用 Notion 的内部集成。
NOTION_CLIENT_SECRET ： Notion OAuth 客户端密钥（用于公共集成类型）。
NOTION_CLIENT_ID ： OAuth 客户端ID（用于公共集成类型）。
NOTION_INTERNAL_SECRET ： Notion 内部集成密钥，如果 NOTION_INTEGRATION_TYPE 的值为 internal，则需要配置此变量。

5.5 KiB Raw Blame History Unescape Escape