mirror of
https://github.com/yusing/godoxy.git
synced 2025-05-19 20:32:35 +02:00
fix main.go and update next release doc
This commit is contained in:
yusing
parent
0d518166ee
commit
c16a0444ca
2 changed files with 6 additions and 177 deletions
|
|
@ -128,8 +128,7 @@ func main() {
|
|||
}
|
||||
|
||||
cfg.Start(&config.StartServersOptions{
|
||||
Proxy: true,
|
||||
Metrics: true,
|
||||
Proxy: true,
|
||||
})
|
||||
if err := auth.Initialize(); err != nil {
|
||||
logging.Fatal().Err(err).Msg("failed to initialize authentication")
|
||||
|
|
|
|||
180
next-release.md
180
next-release.md
|
|
@ -1,176 +1,6 @@
|
|||
GoDoxy v0.9.0 expected changes
|
||||
GoDoxy v0.9.1 expected changes
|
||||
|
||||
- **new** Brand new rewritten WebUI
|
||||
- View logs directly from WebUI
|
||||
- Edit dashboard app config (e.g. icon, name, category, etc.)
|
||||
- Toggle show / hide apps
|
||||
- Health bubbles, latency, etc. rich info on dashboard items
|
||||
- UI config editor
|
||||
|
||||
|
||||
|
||||
- **new** Support selfh.st icons: `@selfhst/<reference>.<format>` _(e.g. `@selfhst/adguard-home.webp`)_
|
||||
- also uses the display name on https://selfh.st/icons/ as default for our dashboard!
|
||||
- **new** GoDoxy server side favicon retreiving and caching
|
||||
- deliver smooth dashboard experience by caching favicons
|
||||
- correct icon can show without setting `homepage.icon` by parsing it from app's root path "/", selecting `link[rel=icon]` from HTML as default icon
|
||||
|
||||
- **Thanks [polds](https://github.com/polds)**
|
||||
Optionally allow a user to specify a “warm-up” endpoint to start the container, returning a 403 if the endpoint isn’t hit and the container has been stopped.
|
||||
|
||||
This can help prevent bots from starting random containers, or allow health check systems to run some probes. Or potentially lock the start endpoints behind a different authentication mechanism, etc.
|
||||
|
||||
Sample service showing this:
|
||||
|
||||
```yaml
|
||||
hello-world:
|
||||
image: nginxdemos/hello
|
||||
container_name: hello-world
|
||||
restart: "no"
|
||||
ports:
|
||||
- "9100:80"
|
||||
labels:
|
||||
proxy.aliases: hello-world
|
||||
proxy.#1.port: 9100
|
||||
proxy.idle_timeout: 45s
|
||||
proxy.wake_timeout: 30s
|
||||
proxy.stop_method: stop
|
||||
proxy.stop_timeout: 10s
|
||||
proxy.stop_signal: SIGTERM
|
||||
proxy.start_endpoint: "/start"
|
||||
```
|
||||
|
||||
Hitting `/` on this service when the container is down:
|
||||
|
||||
```curl
|
||||
$ curl -sv -X GET -H "Host: hello-world.godoxy.local" http://localhost/
|
||||
* Host localhost:80 was resolved.
|
||||
* IPv6: ::1
|
||||
* IPv4: 127.0.0.1
|
||||
* Trying [::1]:80...
|
||||
* Connected to localhost (::1) port 80
|
||||
> GET / HTTP/1.1
|
||||
> Host: hello-world.godoxy.local
|
||||
> User-Agent: curl/8.7.1
|
||||
> Accept: */*
|
||||
>
|
||||
* Request completely sent off
|
||||
< HTTP/1.1 403 Forbidden
|
||||
< Content-Type: text/plain; charset=utf-8
|
||||
< X-Content-Type-Options: nosniff
|
||||
< Date: Wed, 08 Jan 2025 02:04:51 GMT
|
||||
< Content-Length: 71
|
||||
<
|
||||
Forbidden: Container can only be started via configured start endpoint
|
||||
* Connection #0 to host localhost left intact
|
||||
```
|
||||
|
||||
Hitting `/start` when the container is down:
|
||||
|
||||
```curl
|
||||
curl -sv -X GET -H "Host: hello-world.godoxy.local" -H "X-Goproxy-Check-Redirect: skip" http://localhost/start
|
||||
* Host localhost:80 was resolved.
|
||||
* IPv6: ::1
|
||||
* IPv4: 127.0.0.1
|
||||
* Trying [::1]:80...
|
||||
* Connected to localhost (::1) port 80
|
||||
> GET /start HTTP/1.1
|
||||
> Host: hello-world.godoxy.local
|
||||
> User-Agent: curl/8.7.1
|
||||
> Accept: */*
|
||||
> X-Goproxy-Check-Redirect: skip
|
||||
>
|
||||
* Request completely sent off
|
||||
< HTTP/1.1 200 OK
|
||||
< Date: Wed, 08 Jan 2025 02:13:39 GMT
|
||||
< Content-Length: 0
|
||||
<
|
||||
* Connection #0 to host localhost left intact
|
||||
```
|
||||
|
||||
- **Thanks [polds](https://github.com/polds)**
|
||||
Support WebUI authentication via OIDC by setting these environment variables:
|
||||
- `GODOXY_OIDC_ISSUER_URL` e.g.:
|
||||
- Pocket ID: `https://pocker-id.yourdomain.com`
|
||||
- Authentik: `https://authentik.yourdomain.com/application/o/<application_slug>/` **The ending slash is required**
|
||||
- `GODOXY_OIDC_LOGOUT_URL` _(if your issuer supports it, e.g.)_
|
||||
- Authentik: `https://authentik.yourdomain.com/application/o/<application_slug>/end-session`
|
||||
- `GODOXY_OIDC_CLIENT_ID`
|
||||
- `GODOXY_OIDC_CLIENT_SECRET`
|
||||
- `GODOXY_OIDC_REDIRECT_URL`
|
||||
- `GODOXY_OIDC_SCOPES` _(optional)_
|
||||
- `GODOXY_OIDC_ALLOWED_USERS`
|
||||
- `GODOXY_OIDC_ALLOWED_GROUPS` _(optional)_
|
||||
|
||||
- Use OpenID Connect to authenticate GoDoxy's WebUI and all your services (SSO)
|
||||
|
||||
```yaml
|
||||
# default
|
||||
labels:
|
||||
proxy.app.middlewares.oidc:
|
||||
|
||||
# with overridden allowed users
|
||||
labels:
|
||||
proxy.app.middlewares.oidc.allowed_users: user1, user2
|
||||
|
||||
# with overridden allowed groups
|
||||
labels:
|
||||
proxy.app.middlewares.oidc.allowed_groups: group1, group2
|
||||
|
||||
# with both overridden (can use inline YAML string for less typing)
|
||||
labels:
|
||||
proxy.app.middlewares.oidc: |
|
||||
allowed_users: [user1, user2]
|
||||
allowed_groups: [group1, group2]
|
||||
```
|
||||
|
||||
- Caddyfile like rules (experimental)
|
||||
|
||||
```yaml
|
||||
proxy.goaccess.rules: |
|
||||
- name: default
|
||||
do: |
|
||||
rewrite / /index.html
|
||||
serve /var/www/goaccess
|
||||
- name: ws
|
||||
on: |
|
||||
header Connection Upgrade
|
||||
header Upgrade websocket
|
||||
do: bypass # do nothing, pass to reverse proxy
|
||||
|
||||
proxy.app.rules: |
|
||||
- name: default
|
||||
do: bypass # do nothing, pass to reverse proxy
|
||||
- name: block POST and PUT
|
||||
on: method POST | method PUT
|
||||
do: error 403 Forbidden
|
||||
```
|
||||
- config reload will now cause a server full restart (i.e. proxy, api, prometheus, etc), eliminating some incorrect behaviors
|
||||
- drop support of inline yaml string list without hyphen `-` prefix, e.g.
|
||||
```yaml
|
||||
# old
|
||||
proxy.app.middlewares.request.hide_headers: |
|
||||
X-Header1
|
||||
X-Header2
|
||||
|
||||
# new
|
||||
proxy.app.middlewares.request.hide_headers: |
|
||||
- X-Header1
|
||||
- X-Header2
|
||||
```
|
||||
- autocert now supports hot-reload
|
||||
- middleware compose now supports cross-referencing, e.g.
|
||||
```yaml
|
||||
foo:
|
||||
- use: RedirectHTTP
|
||||
bar: # in the same file or different file
|
||||
- use: foo@file
|
||||
```
|
||||
- changed default `ResponseHeaderTimeout` to `60s`
|
||||
- allow customizing `ResponseHeaderTimeout` for each app, e.g.
|
||||
```yaml
|
||||
proxy.<app>.response_header_timeout: 3m
|
||||
```
|
||||
- Fixes
|
||||
- bug: cert renewal failure no longer causes renew schdueler to stuck forever
|
||||
- bug: access log writes to closed file after config reload
|
||||
- Support Ntfy notifications
|
||||
- Prometheus metrics server now inside API server under `/v1/metrics`
|
||||
- `GODOXY_PROMETHEUS_ADDR` removed
|
||||
- `GODOXY_PROMETHEUS_ENABLED` added, default `false`
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue