starred/godoxy
1
0
Fork 0
mirror of https://github.com/yusing/godoxy.git synced 2026-01-11 21:10:30 +01:00
Code Issues 18 Packages Projects Releases 10 Wiki Activity

chore: update README.md and config.example.yml for new changes

Browse Source
This commit is contained in:
yusing
2025-10-12 14:25:55 +08:00
parent d11ddb7c91
commit 8c670ab92e
3 changed files with 14 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@@ -59,6 +59,7 @@ Have questions? Ask [ChatGPT](https://chatgpt.com/g/g-6825390374b481919ad482f2e4
- Country **(Maxmind account required)** - Country **(Maxmind account required)**
- Timezone **(Maxmind account required)** - Timezone **(Maxmind account required)**
- **Access logging** - **Access logging**
- Periodic notification of access summaries for number of allowed and blocked connections
- **Advanced Automation** - **Advanced Automation**
- Automatic SSL certificate management with Let's Encrypt ([using DNS-01 Challenge](https://docs.godoxy.dev/DNS-01-Providers)) - Automatic SSL certificate management with Let's Encrypt ([using DNS-01 Challenge](https://docs.godoxy.dev/DNS-01-Providers))
- Auto-configuration for Docker containers - Auto-configuration for Docker containers

5
README_CHT.md
View File

@@ -58,6 +58,7 @@
- 國家 **(需要 Maxmind 帳戶)** - 國家 **(需要 Maxmind 帳戶)**
- 時區 **(需要 Maxmind 帳戶)** - 時區 **(需要 Maxmind 帳戶)**
- **存取日誌記錄** - **存取日誌記錄**
- 定時發送摘要 (允許和拒絕的連線次數)
- **自動化** - **自動化**
- 使用 Let's Encrypt 自動管理 SSL 憑證 ([使用 DNS-01 驗證](https://docs.godoxy.dev/DNS-01-Providers)) - 使用 Let's Encrypt 自動管理 SSL 憑證 ([使用 DNS-01 驗證](https://docs.godoxy.dev/DNS-01-Providers))
- Docker 容器自動配置 - Docker 容器自動配置
@@ -150,13 +151,13 @@
更新： 更新：
```bash ```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
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
``` ```
## 截圖 ## 截圖

11
config.example.yml
View File

@@ -35,10 +35,14 @@
# - country:US # - country:US
# - timezone:Asia/Shanghai # - timezone:Asia/Shanghai
# log: # warning: logging ACL can be slow based on the number of incoming connections and configured rules # 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) # path: /app/logs/acl.log # (default: none)
# stdout: false # (default: false) # stdout: false # (default: false)
# keep: 30 days # (default: 30 days) # 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: entrypoint:
# Proxy Protocol: https://www.haproxy.com/blog/use-the-proxy-protocol-to-preserve-a-clients-ip-address # Proxy Protocol: https://www.haproxy.com/blog/use-the-proxy-protocol-to-preserve-a-clients-ip-address
@@ -113,6 +117,11 @@ providers:
# provider: webhook # provider: webhook
# url: https://discord.com/api/webhooks/... # url: https://discord.com/api/webhooks/...
# template: discord # this means use payload template from internal/notif/templates/discord.json # 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) # Proxmox providers (for idlesleep support for proxmox LXCs)
# #