remove session related docs (#21)

pull/22/head
zxhlyh 2023-10-08 14:21:15 +08:00 committed by GitHub
parent 69efe791dd
commit d290a34650
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 31 additions and 29 deletions

View File

@ -157,26 +157,27 @@ This Redis configuration is used for caching and for pub/sub during conversation
* REDIS_PASSWORD: Redis password, default is empty. It is strongly recommended to set a password.
* REDIS_USE_SSL: Whether to use SSL protocol for connection, default is false
#### Session Configuration
#### ~~Session Configuration~~
>⚠️ This configuration is no longer valid since v0.3.24.
Only used by the API service for interface identity verification.
~~Only used by the API service for interface identity verification.~~
* SESSION_TYPE:
* ~~SESSION_TYPE:~~
Session component type
~~Session component type~~
* redis (default)
* ~~redis (default)~~
If you choose this, you need to set the environment variables starting with SESSION_REDIS_ below.
* sqlalchemy
~~If you choose this, you need to set the environment variables starting with SESSION_REDIS_ below.~~
* ~~sqlalchemy~~
If you choose this, the current database connection will be used and the sessions table will be used to read and write session records.
* SESSION_REDIS_HOST: Redis host
* SESSION_REDIS_PORT: Redis port, default is 6379
* SESSION_REDIS_DB: Redis Database, default is 0. Please use a different Database from Redis and Celery Broker.
* SESSION_REDIS_USERNAME: Redis username, default is empty
* SESSION_REDIS_PASSWORD: Redis password, default is empty. It is strongly recommended to set a password.
* SESSION_REDIS_USE_SSL: Whether to use SSL protocol for connection, default is false
~~If you choose this, the current database connection will be used and the sessions table will be used to read and write session records.~~
* ~~SESSION_REDIS_HOST: Redis host~~
* ~~SESSION_REDIS_PORT: Redis port, default is 6379~~
* ~~SESSION_REDIS_DB: Redis Database, default is 0. Please use a different Database from Redis and Celery Broker.~~
* ~~SESSION_REDIS_USERNAME: Redis username, default is empty~~
* ~~SESSION_REDIS_PASSWORD: Redis password, default is empty. It is strongly recommended to set a password.~~
* ~~SESSION_REDIS_USE_SSL: Whether to use SSL protocol for connection, default is false~~
#### Celery Configuration
@ -208,7 +209,7 @@ For detailed configuration, please refer to: [Cross-domain/identity related guid
#### ~~Cookie Policy Configuration~~
⚠️ This configuration is no longer valid since v0.3.24.
>⚠️ This configuration is no longer valid since v0.3.24.
~~Used to set the browser policy for session cookies used for identity verification.~~

View File

@ -147,23 +147,24 @@ Flask 调试模式,开启可在接口输出 trace 信息,方便调试。
* REDIS\_PASSWORDRedis 密码,默认为空,强烈建议设置密码。
* REDIS\_USE\_SSL是否使用 SSL 协议进行连接,默认 false
#### Session 配置
#### ~~Session 配置~~
>⚠️ 该配置从 0.3.24 版本起已废弃。
仅 API 服务使用,用于验证接口身份。
~~仅 API 服务使用,用于验证接口身份。~~
* SESSION\_TYPE Session 组件类型
* redis默认
* ~~SESSION\_TYPE Session 组件类型~~
* ~~redis默认~~
选择此项,则需要设置下方 SESSION\_REDIS\_ 开头的环境变量。
* sqlalchemy
~~选择此项,则需要设置下方 SESSION\_REDIS\_ 开头的环境变量。~~
* ~~sqlalchemy~~
选择此项,则使用当前数据库连接,并使用 sessions 表进行读写 session 记录。
* SESSION\_REDIS\_HOSTRedis host
* SESSION\_REDIS\_PORTRedis port默认 6379
* SESSION\_REDIS\_DBRedis Database默认为 0请和 Redis、Celery Broker 分开用不同 Database。
* SESSION\_REDIS\_USERNAMERedis 用户名,默认为空
* SESSION\_REDIS\_PASSWORDRedis 密码,默认为空,强烈建议设置密码。
* SESSION\_REDIS\_USE\_SSL是否使用 SSL 协议进行连接,默认 false
~~选择此项,则使用当前数据库连接,并使用 sessions 表进行读写 session 记录。~~
* ~~SESSION\_REDIS\_HOSTRedis host~~
* ~~SESSION\_REDIS\_PORTRedis port默认 6379~~
* ~~SESSION\_REDIS\_DBRedis Database默认为 0请和 Redis、Celery Broker 分开用不同 Database。~~
* ~~SESSION\_REDIS\_USERNAMERedis 用户名,默认为空~~
* ~~SESSION\_REDIS\_PASSWORDRedis 密码,默认为空,强烈建议设置密码。~~
* ~~SESSION\_REDIS\_USE\_SSL是否使用 SSL 协议进行连接,默认 false~~
#### Celery 配置
@ -194,7 +195,7 @@ Flask 调试模式,开启可在接口输出 trace 信息,方便调试。
详细配置可参考:[跨域/身份相关指南](https://avytux375gg.feishu.cn/wiki/HyX3wdF1YiejX3k3U2CcTcmQnjg)
#### ~~Cookie 策略配置~~
⚠️ 该配置从 0.3.24 版本起已废弃。
>⚠️ 该配置从 0.3.24 版本起已废弃。
~~用于设置身份校验的 Session Cookie 浏览器策略。~~