配置
学习如何配置 FreeAuth 接口服务。
.env 文件位于 FreeAuth 后台接口服务项目的根目录下（freeauth-admin），您可以对以下配置进行覆写。如该文件不存在，需要手动进行创建。 例如：
.env
# 覆写当前应用ID
FREEAUTH_APP_ID=freeauth_app_id| 配置名 | 配置类型 | 默认值 | 配置描述 |
|---|---|---|---|
debug | boolean | false | 是否启用调试模式 |
testing | boolean | false | 是否启用测试模式，在运行单元测试时应启用此模式 |
freeauth_app_id | string | 当前的应用 ID，FreeAuth 在 setup 过程中会自动创建默认应用 ID，并覆写到配置文件中 | |
| EdgeDB 配置 | |||
edgedb_instance | string | EdgeDB 数据库实例名称，仅用于本地开发环境 | |
edgedb_database | string | edgedb | EdgeDB 数据库名称 |
edgedb_dsn | string | EdgeDB 数据库连接字符串，参阅 DSN 规范 | |
| 身份认证配置 | |||
jwt_algorithm | string | HS256 | JWT 签名算法，常见的几种签名算法有：HS256、RS256 和 ES256，参阅 RFC 7518 - JSON Web 算法规范 |
jwt_token_ttl | integer | 1440 | JWT 令牌有效时间，单位为分钟 |
jwt_secret_key | string | secret_key | 用于签名和验证 JWT 的密钥 |
jwt_cookie_key | string | access_token | 存储 JWT 令牌的 cookie 名称 |
jwt_cookie_secure | boolean | true | 设置为 True 时，只有通过 HTTPS 才可以使用 |
verify_code_ttl | integer | 10 | 验证码（通过短信、邮件发送）有效时间，单位为分钟 |
verify_code_cool_down | integer | 60 | 重新获取验证码的倒计时时间，以秒为单位 |
| 邮件配置 | |||
mail_from_name | string | FreeAuth | 邮件发件人的名字 |
mail_from | string | 邮件发件人的地址 | |
mail_username | string | 邮件账户的用户名 | |
mail_password | string | 邮件账户的密码 | |
mail_port | integer | 25 | 邮箱服务的端口 |
mail_server | string | localhost | 邮箱的服务器地址 |
mail_starttls | boolean | false | 在不安全连接中，是否启用邮件的传输安全性（TLS 和 SSL）加密 |
mail_ssl_tls | boolean | false | 是否启用邮件的传输安全性（TLS 和 SSL）加密 |
| 短信配置 | |||
sms_provider | string | 短信提供商的名称，可以是 tencent-cloud（腾讯云） 或者 aliyun（阿里云）。 | |
sms_secret_id | string | 短信提供商的接口调用凭证，用于标识 API 调用者身份，可以简单类比为用户名。 | |
sms_secret_key | string | 短信提供商的接口调用凭证，用于验证 API 调用者的身份，可以简单类比为密码。 须严格保管安全凭证，避免泄露 | |
sms_sign_name | string | 短信签名内容 | |
sms_region | string | 仅短信提供商为 tencent-cloud 时需配置该参数，用于标识腾讯云短信服务所在地域，参阅 可用地域列表. | |
sms_app_id | string | 仅短信提供商为 tencent-cloud 时需配置该参数，在腾讯云短信控制台添加应用后生成的实际 SdkAppId | |
sms_auth_code_tpl_id | string | 用于发送验证码的短信模板 ID |