From 8c670ab92e900bcc532ee31d1cf66807fe78a3c2 Mon Sep 17 00:00:00 2001 From: yusing Date: Sun, 12 Oct 2025 14:25:55 +0800 Subject: [PATCH] chore: update README.md and config.example.yml for new changes --- README.md | 1 + README_CHT.md | 5 +++-- config.example.yml | 11 ++++++++++- 3 files changed, 14 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9cfde4c2..1bc699c3 100755 --- a/README.md +++ b/README.md @@ -59,6 +59,7 @@ Have questions? Ask [ChatGPT](https://chatgpt.com/g/g-6825390374b481919ad482f2e4 - Country **(Maxmind account required)** - Timezone **(Maxmind account required)** - **Access logging** + - Periodic notification of access summaries for number of allowed and blocked connections - **Advanced Automation** - Automatic SSL certificate management with Let's Encrypt ([using DNS-01 Challenge](https://docs.godoxy.dev/DNS-01-Providers)) - Auto-configuration for Docker containers diff --git a/README_CHT.md b/README_CHT.md index e7193abc..0936e9c4 100644 --- a/README_CHT.md +++ b/README_CHT.md @@ -58,6 +58,7 @@ - 國家 **(需要 Maxmind 帳戶)** - 時區 **(需要 Maxmind 帳戶)** - **存取日誌記錄** + - 定時發送摘要 (允許和拒絕的連線次數) - **自動化** - 使用 Let's Encrypt 自動管理 SSL 憑證 ([使用 DNS-01 驗證](https://docs.godoxy.dev/DNS-01-Providers)) - Docker 容器自動配置 @@ -150,13 +151,13 @@ 更新: ```bash -bash -c "$(curl -fsSL https://github.com/yusing/godoxy/raw/refs/heads/main/scripts/install-agent.sh)" -- update +sudo /bin/bash -c "$(curl -fsSL https://github.com/yusing/godoxy/raw/refs/heads/main/scripts/install-agent.sh)" -- update ``` 卸載: ```bash -bash -c "$(curl -fsSL https://github.com/yusing/godoxy/raw/refs/heads/main/scripts/install-agent.sh)" -- uninstall +sudo /bin/bash -c "$(curl -fsSL https://github.com/yusing/godoxy/raw/refs/heads/main/scripts/install-agent.sh)" -- uninstall ``` ## 截圖 diff --git a/config.example.yml b/config.example.yml index 87e7c63c..8800fe79 100644 --- a/config.example.yml +++ b/config.example.yml @@ -35,10 +35,14 @@ # - country:US # - timezone:Asia/Shanghai # log: # warning: logging ACL can be slow based on the number of incoming connections and configured rules -# buffer_size: 65536 # (default: 64KB) # path: /app/logs/acl.log # (default: none) # stdout: false # (default: false) # keep: 30 days # (default: 30 days) +# log_allowed: false # (default: false) +# notify: +# interval: 1m # (default: 1m) +# to: [gotify, discord] # names under providers.notification +# include_allowed: false # (default: false) entrypoint: # Proxy Protocol: https://www.haproxy.com/blog/use-the-proxy-protocol-to-preserve-a-clients-ip-address @@ -113,6 +117,11 @@ providers: # provider: webhook # url: https://discord.com/api/webhooks/... # template: discord # this means use payload template from internal/notif/templates/discord.json + # - name: pushover + # provider: webhook + # url: https://api.pushover.net/1/messages.json + # mime_type: application/x-www-form-urlencoded + # payload: '{"token": "your-app-token", "user": "your-user-key", "title": $title, "message": $message}' # Proxmox providers (for idlesleep support for proxmox LXCs) #