Skip to content

Support Google cloud SQL Mysql SSL #1104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Support Google cloud SQL Mysql SSL #1104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1c8e6a7
Support Google cloud SQL Mysql SSL
up9cloud Aug 10, 2025
7148409
fix typo
up9cloud Aug 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions docs/docs/en/guide/env.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,9 @@ ATK_TRUSTED_DOMAINS_0="https://a.com"
<div class="env-table">
<!-- env-variables -->

## 通用配置
## General

| 环境变量 | 默认值 | 描述 | 路径 |
| Env | Default | Desc | Path |
| --- | --- | --- | --- |
| **ATK_APP_KEY** | `""` | App Key (for generation of JWT) | app_key (App Key) |
| **ATK_DEBUG** | `false` | Debug mode | debug (Debug mode) |
Expand All @@ -84,7 +84,7 @@ ATK_TRUSTED_DOMAINS_0="https://a.com"

## Multi-Push

| 环境变量 | 默认值 | 描述 | 路径 |
| Env | Default | Desc | Path |
| --- | --- | --- | --- |
| **ATK_ADMIN_NOTIFY_BARK_ENABLED** | `false` | 启用 | admin_notify.bark.enabled (Multi-Push > Bark > Enabled) |
| **ATK_ADMIN_NOTIFY_BARK_SERVER** | `"http://day.app/xxxxxxx/"` | Server | admin_notify.bark.server (Multi-Push > Bark > Server) |
Expand Down Expand Up @@ -116,7 +116,7 @@ ATK_TRUSTED_DOMAINS_0="https://a.com"

## Social Login

| 环境变量 | 默认值 | 描述 | 路径 |
| Env | Default | Desc | Path |
| --- | --- | --- | --- |
| **ATK_AUTH_ANONYMOUS** | `false` | Allow anonymous commenting (Allow skipping verification, only fill in an anonymous nickname and email) | auth.anonymous (Social Login > Allow anonymous commenting) |
| **ATK_AUTH_APPLE_CLIENT_ID** | `""` | ClientId | auth.apple.client_id (Social Login > Apple > ClientId) |
Expand Down Expand Up @@ -179,7 +179,7 @@ ATK_TRUSTED_DOMAINS_0="https://a.com"

## Cache

| 环境变量 | 默认值 | 描述 | 路径 |
| Env | Default | Desc | Path |
| --- | --- | --- | --- |
| **ATK_CACHE_ENABLED** | `false` | Enable cache | cache.enabled (Cache > Enable cache) |
| **ATK_CACHE_EXPIRES** | `30` | Cache expiration time (in minutes) | cache.expires (Cache > Cache expiration time) |
Expand All @@ -194,7 +194,7 @@ ATK_TRUSTED_DOMAINS_0="https://a.com"

## Captcha

| 环境变量 | 默认值 | 描述 | 路径 |
| Env | Default | Desc | Path |
| --- | --- | --- | --- |
| **ATK_CAPTCHA_ACTION_LIMIT** | `3` | Action limit (the number of actions required to activate captcha) | captcha.action_limit (Captcha > Action limit) |
| **ATK_CAPTCHA_ACTION_RESET** | `60` | Reset Timeout (timeout to reset action counter. unit: s, set to -1 to disable) | captcha.action_reset (Captcha > Reset Timeout) |
Expand All @@ -213,7 +213,7 @@ ATK_TRUSTED_DOMAINS_0="https://a.com"

## Database

| 环境变量 | 默认值 | 描述 | 路径 |
| Env | Default | Desc | Path |
| --- | --- | --- | --- |
| **ATK_DB_CHARSET** | `"utf8mb4"` | Database charset | db.charset (Database > Database charset) |
| **ATK_DB_FILE** | `"./data/artalk.db"` | Database file (only for SQLite) | db.file (Database > Database file) |
Expand All @@ -230,7 +230,7 @@ ATK_TRUSTED_DOMAINS_0="https://a.com"

## Email

| 环境变量 | 默认值 | 描述 | 路径 |
| Env | Default | Desc | Path |
| --- | --- | --- | --- |
| **ATK_EMAIL_ALI_DM_ACCESS_KEY_ID** | `""` | AccessKeyId | email.ali_dm.access_key_id (Email > Aliyun mail push > AccessKeyId) |
| **ATK_EMAIL_ALI_DM_ACCESS_KEY_SECRET** | `""` | AccessKeySecret | email.ali_dm.access_key_secret (Email > Aliyun mail push > AccessKeySecret) |
Expand All @@ -249,7 +249,7 @@ ATK_TRUSTED_DOMAINS_0="https://a.com"

## UI Settings

| 环境变量 | 默认值 | 描述 | 路径 |
| Env | Default | Desc | Path |
| --- | --- | --- | --- |
| **ATK_FRONTEND_DARKMODE** | `"inherit"` | Dark mode (可选：`["inherit", "auto"]`) | frontend.darkMode (UI Settings > Dark mode) |
| **ATK_FRONTEND_EDITORTRAVEL** | `true` | Movable comment box | frontend.editorTravel (UI Settings > Movable comment box) |
Expand Down Expand Up @@ -281,15 +281,15 @@ ATK_TRUSTED_DOMAINS_0="https://a.com"

## Web server

| 环境变量 | 默认值 | 描述 | 路径 |
| Env | Default | Desc | Path |
| --- | --- | --- | --- |
| **ATK_HTTP_BODY_LIMIT** | `100` | Body size limit (unit: MB) | http.body_limit (Web server > Body size limit) |
| **ATK_HTTP_PROXY_HEADER** | `""` | Proxy Header (fill `X-Forwarded-For` to get user real IP if behind a trusted reverse proxy or CDN) | http.proxy_header (Web server > Proxy Header) |


## Upload

| 环境变量 | 默认值 | 描述 | 路径 |
| Env | Default | Desc | Path |
| --- | --- | --- | --- |
| **ATK_IMG_UPLOAD_ENABLED** | `true` | Enable image upload | img_upload.enabled (Upload > Enable image upload) |
| **ATK_IMG_UPLOAD_MAX_SIZE** | `5` | Image size limit (unit: MB) | img_upload.max_size (Upload > Image size limit) |
Expand All @@ -302,15 +302,15 @@ ATK_TRUSTED_DOMAINS_0="https://a.com"

## Logging

| 环境变量 | 默认值 | 描述 | 路径 |
| Env | Default | Desc | Path |
| --- | --- | --- | --- |
| **ATK_LOG_ENABLED** | `true` | Enable logging | log.enabled (Logging > Enable logging) |
| **ATK_LOG_FILENAME** | `"./data/artalk.log"` | Log file path | log.filename (Logging > Log file path) |


## Moderator

| 环境变量 | 默认值 | 描述 | 路径 |
| Env | Default | Desc | Path |
| --- | --- | --- | --- |
| **ATK_MODERATOR_AKISMET_KEY** | `""` | Akismet Key (Akismet anti-spam service, https://akismet.com) | moderator.akismet_key (Moderator > Akismet Key) |
| **ATK_MODERATOR_ALIYUN_ACCESS_KEY_ID** | `""` | AccessKeyId | moderator.aliyun.access_key_id (Moderator > Aliyun Content Security > AccessKeyId) |
Expand All @@ -332,7 +332,7 @@ ATK_TRUSTED_DOMAINS_0="https://a.com"

## SSL

| 环境变量 | 默认值 | 描述 | 路径 |
| Env | Default | Desc | Path |
| --- | --- | --- | --- |
| **ATK_SSL_CERT_PATH** | `""` | Certificate file path (e.g. "/etc/letsencrypt/live/example.com/fullchain.pem") | ssl.cert_path (SSL > Certificate file path) |
| **ATK_SSL_ENABLED** | `false` | Enable SSL | ssl.enabled (SSL > Enable SSL) |
Expand Down
Loading