fix(oidc): simplify LoginHandler to always redirect to IdP

chore(docker): update .gitignore to exclude all .env files and modify dev.compose.yml to include env_file for development
feat(auth): add GET endpoint for logout and update documentation
2026-01-15 16:13:32 +01:00 · 2025-09-14 14:33:28 +08:00 · 2025-09-14 13:47:02 +08:00 · 2025-09-14 13:07:24 +08:00 · 2025-09-14 11:19:37 +08:00 · 2025-09-14 01:30:37 +08:00
18 changed files with 58 additions and 45 deletions
--- a/.gitignore
+++ b/.gitignore
@@ -29,6 +29,7 @@ todo.md
 .aider*
 mtrace.json
 .env
+*.env
 .cursorrules
 .cursor/
 .windsurfrules
--- a/README.md
+++ b/README.md
@@ -21,8 +21,6 @@ A lightweight, simple, and performant reverse proxy with WebUI.

 Have questions? Ask [ChatGPT](https://chatgpt.com/g/g-6825390374b481919ad482f2e48936a1-godoxy-assistant)! (Thanks to [@ismesid](https://github.com/arevindh))

-**New WebUI and is now available in nightly tag [(Demo)](https://nightly.demo.godoxy.dev), feedbacks are welcomed!**
-
 </div>

 ## Table of content
@@ -41,6 +39,7 @@ Have questions? Ask [ChatGPT](https://chatgpt.com/g/g-6825390374b481919ad482f2e4
 - [Manual Setup](#manual-setup)
  - [Folder structrue](#folder-structrue)
 - [Build it yourself](#build-it-yourself)
+- [Star History](#star-history)

 ## Running demo

@@ -140,22 +139,12 @@ Configure Wildcard DNS Record(s) to point to machine running `GoDoxy`, e.g.
 <div align="center">
  <table>
    <tr>
-      <td align="center"><img src="screenshots/uptime.png" alt="Uptime Monitor" width="250"/></td>
-      <td align="center"><img src="screenshots/docker-logs.jpg" alt="Docker Logs" width="250"/></td>
-      <td align="center"><img src="screenshots/docker.jpg" alt="Server Overview" width="250"/></td>
+      <td align="center"><img src="screenshots/routes.jpg" alt="Routes" width="350"/></td>
+      <td align="center"><img src="screenshots/servers.jpg" alt="Servers" width="350"/></td>
    </tr>
    <tr>
-      <td align="center"><b>Uptime Monitor</b></td>
-      <td align="center"><b>Docker Logs</b></td>
-      <td align="center"><b>Server Overview</b></td>
-    </tr>
-        <tr>
-      <td align="center"><img src="screenshots/system-monitor.jpg" alt="System Monitor" width="250"/></td>
-      <td align="center"><img src="screenshots/system-info-graphs.jpg" alt="Graphs" width="250"/></td>
-    </tr>
-    <tr>
-      <td align="center"><b>System Monitor</b></td>
-      <td align="center"><b>Graphs</b></td>
+      <td align="center"><b>Routes</b></td>
+      <td align="center"><b>Servers</b></td>
    </tr>
  </table>
 </div>
@@ -207,4 +196,8 @@ Configure Wildcard DNS Record(s) to point to machine running `GoDoxy`, e.g.

 5. build binary with `make build`

+## Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=yusing/godoxy&type=Date)](https://www.star-history.com/#yusing/godoxy&Date)
+
 [🔼Back to top](#table-of-content)
--- a/README_CHT.md
+++ b/README_CHT.md
@@ -38,6 +38,7 @@
  - [閒置休眠](#閒置休眠)
  - [監控](#監控)
 - [自行編譯](#自行編譯)
+- [Star History](#star-history)

 ## 運行示例

@@ -84,8 +85,6 @@
 - **高效能**
  - 以 **[Go](https://go.dev)** 語言編寫

-[🔼 回到頂部](#目錄)
-
 ## 前置需求

 設置 DNS 記錄指向運行 `GoDoxy` 的機器，例如：
@@ -110,8 +109,6 @@

 3. 現在可以在 WebUI `https://godoxy.yourdomain.com` 進行額外配置

-[🔼 回到頂部](#目錄)
-
 ### 手動安裝

 1. 建立 `config` 目錄，然後將 `config.example.yml` 下載到 `config/config.yml`
@@ -153,29 +150,17 @@

 ![閒置休眠](screenshots/idlesleeper.webp)

-[🔼 回到頂部](#目錄)
-
 ### 監控

 <div align="center">
  <table>
    <tr>
-      <td align="center"><img src="screenshots/uptime.png" alt="Uptime Monitor" width="250"/></td>
-      <td align="center"><img src="screenshots/docker-logs.jpg" alt="Docker Logs" width="250"/></td>
-      <td align="center"><img src="screenshots/docker.jpg" alt="Server Overview" width="250"/></td>
+      <td align="center"><img src="screenshots/routes.jpg" alt="Routes" width="350"/></td>
+      <td align="center"><img src="screenshots/servers.jpg" alt="Servers" width="350"/></td>
    </tr>
    <tr>
-      <td align="center"><b>運行時間監控</b></td>
-      <td align="center"><b>Docker 日誌</b></td>
-      <td align="center"><b>伺服器概覽</b></td>
-    </tr>
-        <tr>
-      <td align="center"><img src="screenshots/system-monitor.jpg" alt="System Monitor" width="250"/></td>
-      <td align="center"><img src="screenshots/system-info-graphs.jpg" alt="Graphs" width="250"/></td>
-    </tr>
-    <tr>
-      <td align="center"><b>系統監控</b></td>
-      <td align="center"><b>圖表</b></td>
+      <td align="center"><b>路由</b></td>
+      <td align="center"><b>伺服器</b></td>
    </tr>
  </table>
 </div>
@@ -192,4 +177,8 @@

 5. 使用 `make build` 編譯二進制檔案

+## Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=yusing/godoxy&type=Date)](https://www.star-history.com/#yusing/godoxy&Date)
+
 [🔼 回到頂部](#目錄)
--- a/dev.compose.yml
+++ b/dev.compose.yml
@@ -8,6 +8,7 @@ services:
        - TARGET=godoxy
    container_name: godoxy-proxy-dev
    restart: unless-stopped
+    env_file: dev.env
    environment:
      TZ: Asia/Hong_Kong
      API_ADDR: :8999
@@ -30,8 +31,7 @@ services:
      - ./dev-data/error_pages:/app/error_pages:ro
      - ./dev-data/data:/app/data
      - ./dev-data/logs:/app/logs
-    depends_on:
-      - tinyauth
+      - ~/certs/myCA.pem:/etc/ssl/certs/ca.crt:ro
  tinyauth:
    image: ghcr.io/steveiliop56/tinyauth:v3
    container_name: tinyauth
--- a/internal/api/handler.go
+++ b/internal/api/handler.go
@@ -56,6 +56,7 @@ func NewHandler() *gin.Engine {
 			v1Auth.GET("/callback", authApi.Callback)
 			v1Auth.POST("/callback", authApi.Callback)
 			v1Auth.POST("/logout", authApi.Logout)
+			v1Auth.GET("/logout", authApi.Logout)
 		}
 	}

--- a/internal/api/v1/auth/logout.go
+++ b/internal/api/v1/auth/logout.go
@@ -13,6 +13,7 @@ import (
 // @Produce		plain
 // @Success		302	{string} string	"Redirects to home page"
 // @Router			/auth/logout [post]
+// @Router			/auth/logout [get]
 func Logout(c *gin.Context) {
 	auth.GetDefaultAuth().LogoutHandler(c.Writer, c.Request)
 }
--- a/internal/api/v1/docs/swagger.json
+++ b/internal/api/v1/docs/swagger.json
@@ -285,6 +285,26 @@
      }
    },
    "/auth/logout": {
+      "get": {
+        "description": "Logs out the user by invalidating the token",
+        "produces": [
+          "text/plain"
+        ],
+        "tags": [
+          "auth"
+        ],
+        "summary": "Logout",
+        "responses": {
+          "302": {
+            "description": "Redirects to home page",
+            "schema": {
+              "type": "string"
+            }
+          }
+        },
+        "x-id": "logout",
+        "operationId": "logout"
+      },
      "post": {
        "description": "Logs out the user by invalidating the token",
        "produces": [
--- a/internal/api/v1/docs/swagger.yaml
+++ b/internal/api/v1/docs/swagger.yaml
@@ -1613,6 +1613,19 @@ paths:
      - auth
      x-id: login
  /auth/logout:
+    get:
+      description: Logs out the user by invalidating the token
+      produces:
+      - text/plain
+      responses:
+        "302":
+          description: Redirects to home page
+          schema:
+            type: string
+      summary: Logout
+      tags:
+      - auth
+      x-id: logout
    post:
      description: Logs out the user by invalidating the token
      produces:
--- a/internal/auth/oidc.go
+++ b/internal/auth/oidc.go
@@ -247,12 +247,7 @@ func (auth *OIDCProvider) LoginHandler(w http.ResponseWriter, r *http.Request) {
 	SetTokenCookie(w, r, auth.getAppScopedCookieName(CookieOauthState), state, 300*time.Second)
 	// redirect user to Idp
 	url := auth.oauthConfig.AuthCodeURL(state, optRedirectPostAuth(r))
-	if IsFrontend(r) {
-		w.Header().Set("X-Redirect-To", url)
-		w.WriteHeader(http.StatusForbidden)
-	} else {
-		http.Redirect(w, r, url, http.StatusFound)
-	}
+	http.Redirect(w, r, url, http.StatusFound)
 }

 func parseClaims(idToken *oidc.IDToken) (*IDTokenClaims, error) {
--- a/internal/auth/userpass.go
+++ b/internal/auth/userpass.go
@@ -125,7 +125,7 @@ func (auth *UserPassAuth) PostAuthCallbackHandler(w http.ResponseWriter, r *http
 		return
 	}
 	SetTokenCookie(w, r, auth.TokenCookieName(), token, auth.tokenTTL)
-	http.Redirect(w, r, "/", http.StatusFound)
+	w.WriteHeader(http.StatusOK)
 }

 func (auth *UserPassAuth) LoginHandler(w http.ResponseWriter, r *http.Request) {
--- a/screenshots/docker-logs.jpg
+++ b/screenshots/docker-logs.jpg
--- a/screenshots/docker.jpg
+++ b/screenshots/docker.jpg
--- a/screenshots/routes.jpg
+++ b/screenshots/routes.jpg
--- a/screenshots/servers.jpg
+++ b/screenshots/servers.jpg
--- a/screenshots/system-info-graphs.jpg
+++ b/screenshots/system-info-graphs.jpg
--- a/screenshots/system-monitor.jpg
+++ b/screenshots/system-monitor.jpg
--- a/screenshots/uptime.png
+++ b/screenshots/uptime.png
--- a/screenshots/webui.jpg
+++ b/screenshots/webui.jpg
Author	SHA1	Message	Date
yusing	f889f5c08d	fix(oidc): simplify LoginHandler to always redirect to IdP	2025-09-14 14:33:28 +08:00
yusing	932c20f32d	chore(docker): update .gitignore to exclude all .env files and modify dev.compose.yml to include env_file for development	2025-09-14 13:47:02 +08:00
yusing	2a08c55e39	feat(auth): add GET endpoint for logout and update documentation	2025-09-14 13:07:24 +08:00
yusing	93e1d17090	fix(auth): revert userpass PostAuthCallback to respond http 200	2025-09-14 11:19:37 +08:00
yusing	d72d403e2c	docs(README): update README files to include new Star History section and replace outdated screenshots - Added "Star History" section with a chart link. - Replaced outdated screenshots with new "Routes" and "Servers" images. - Removed references to deleted screenshots for better clarity.	2025-09-14 01:30:37 +08:00
yusing	b5d70a0592	docs(README): remove WebUI announcement from README	2025-09-14 01:15:36 +08:00