diff --git a/README.md b/README.md index 3d77bd61..14f28087 100644 --- a/README.md +++ b/README.md @@ -46,9 +46,9 @@ A minimal forward authentication service that provides OAuth/SSO login and authe ## Releases -We recommend using the `2` tag on docker hub (`logica0419/traefik-forward-auth:2`). +We recommend using the `2` tag on docker hub (`ictsc/traefik-forward-auth:2`). -You can also use the latest incremental releases found on [docker hub](https://hub.docker.com/r/logica0419/traefik-forward-auth/tags) and [github](https://github.com/logica0419/traefik-forward-auth/releases). +You can also use the latest incremental releases found on [docker hub](https://hub.docker.com/r/ictsc/traefik-forward-auth/tags) and [github](https://github.com/ictsc/traefik-forward-auth/releases). ARM releases are also available on docker hub, just append `-arm` or `-arm64` to your desired released (e.g. `2-arm` or `2.1-arm64`). @@ -56,7 +56,7 @@ We also build binary files for usage without docker starting with releases after ### Upgrade Guide -v2 was released in June 2019, whilst this is fully backwards compatible, a number of configuration options were modified, please see the [upgrade guide](https://github.com/logica0419/traefik-forward-auth/wiki/v2-Upgrade-Guide) to prevent warnings on startup and ensure you are using the current configuration. +v2 was released in June 2019, whilst this is fully backwards compatible, a number of configuration options were modified, please see the [upgrade guide](https://github.com/ictsc/traefik-forward-auth/wiki/v2-Upgrade-Guide) to prevent warnings on startup and ensure you are using the current configuration. ## Usage @@ -79,7 +79,7 @@ services: - /var/run/docker.sock:/var/run/docker.sock traefik-forward-auth: - image: logica0419/traefik-forward-auth:2 + image: ictsc/traefik-forward-auth:2 environment: - PROVIDERS_GOOGLE_CLIENT_ID=your-client-id - PROVIDERS_GOOGLE_CLIENT_SECRET=your-client-secret @@ -99,13 +99,13 @@ services: ### Advanced -Please see the examples directory for a more complete [docker-compose.yml](https://github.com/logica0419/traefik-forward-auth/blob/master/examples/traefik-v2/swarm/docker-compose.yml) or [kubernetes/simple-separate-pod](https://github.com/logica0419/traefik-forward-auth/blob/master/examples/traefik-v2/kubernetes/simple-separate-pod/). +Please see the examples directory for a more complete [docker-compose.yml](https://github.com/ictsc/traefik-forward-auth/blob/master/examples/traefik-v2/swarm/docker-compose.yml) or [kubernetes/simple-separate-pod](https://github.com/ictsc/traefik-forward-auth/blob/master/examples/traefik-v2/kubernetes/simple-separate-pod/). -Also in the examples directory is [docker-compose-auth-host.yml](https://github.com/logica0419/traefik-forward-auth/blob/master/examples/traefik-v2/swarm/docker-compose-auth-host.yml) and [kubernetes/advanced-separate-pod](https://github.com/logica0419/traefik-forward-auth/blob/master/examples/traefik-v2/kubernetes/advanced-separate-pod/) which shows how to configure a central auth host, along with some other options. +Also in the examples directory is [docker-compose-auth-host.yml](https://github.com/ictsc/traefik-forward-auth/blob/master/examples/traefik-v2/swarm/docker-compose-auth-host.yml) and [kubernetes/advanced-separate-pod](https://github.com/ictsc/traefik-forward-auth/blob/master/examples/traefik-v2/kubernetes/advanced-separate-pod/) which shows how to configure a central auth host, along with some other options. ### Provider Setup -Below are some general notes on provider setup, specific instructions and examples for a number of providers can be found on the [Provider Setup](https://github.com/logica0419/traefik-forward-auth/wiki/Provider-Setup) wiki page. +Below are some general notes on provider setup, specific instructions and examples for a number of providers can be found on the [Provider Setup](https://github.com/ictsc/traefik-forward-auth/wiki/Provider-Setup) wiki page. #### Google @@ -123,7 +123,7 @@ Any provider that supports OpenID Connect 1.0 can be configured via the OIDC con You must set the `providers.oidc.issuer-url`, `providers.oidc.client-id` and `providers.oidc.client-secret` config options. -Please see the [Provider Setup](https://github.com/logica0419/traefik-forward-auth/wiki/Provider-Setup) wiki page for examples. +Please see the [Provider Setup](https://github.com/ictsc/traefik-forward-auth/wiki/Provider-Setup) wiki page for examples. #### Generic OAuth2 @@ -142,7 +142,7 @@ You can also set: - `providers.generic-oauth.scope`- Any scopes that should be included in the request (default: profile, email) - `providers.generic-oauth.token-style` - How token is presented when querying the User URL. Can be `header` or `query`, defaults to `header`. With `header` the token is provided in an Authorization header, with query the token is provided in the `access_token` query string value. -Please see the [Provider Setup](https://github.com/logica0419/traefik-forward-auth/wiki/Provider-Setup) wiki page for examples. +Please see the [Provider Setup](https://github.com/ictsc/traefik-forward-auth/wiki/Provider-Setup) wiki page for examples. ## Configuration @@ -484,7 +484,7 @@ As the hostname in the `redirect_uri` is dynamically generated based on the orig #### Auth Host Mode -This is an optional mode of operation that is useful when dealing with a large number of subdomains, it is activated by using the `auth-host` config option (see [this example docker-compose.yml](https://github.com/logica0419/traefik-forward-auth/blob/master/examples/traefik-v2/swarm/docker-compose-auth-host.yml) or [this kubernetes example](https://github.com/logica0419/traefik-forward-auth/tree/master/examples/traefik-v2/kubernetes/advanced-separate-pod)). +This is an optional mode of operation that is useful when dealing with a large number of subdomains, it is activated by using the `auth-host` config option (see [this example docker-compose.yml](https://github.com/ictsc/traefik-forward-auth/blob/master/examples/traefik-v2/swarm/docker-compose-auth-host.yml) or [this kubernetes example](https://github.com/ictsc/traefik-forward-auth/tree/master/examples/traefik-v2/kubernetes/advanced-separate-pod)). For example, if you have a few applications: `app1.test.com`, `app2.test.com`, `appN.test.com`, adding every domain to Google's console can become laborious. To utilise an auth host, permit domain level cookies by setting the cookie domain to `test.com` then set the `auth-host` to: `auth.test.com`. @@ -505,7 +505,7 @@ Two criteria must be met for an `auth-host` to be used: 1. Request matches given `cookie-domain` 2. `auth-host` is also subdomain of same `cookie-domain` -Please note: For Auth Host mode to work, you must ensure that requests to your auth-host are routed to the traefik-forward-auth container, as demonstrated with the service labels in the [docker-compose-auth.yml](https://github.com/logica0419/traefik-forward-auth/blob/master/examples/traefik-v2/swarm/docker-compose-auth-host.yml) example and the [ingressroute resource](https://github.com/logica0419/traefik-forward-auth/blob/master/examples/traefik-v2/kubernetes/advanced-separate-pod/traefik-forward-auth/ingress.yaml) in a kubernetes example. +Please note: For Auth Host mode to work, you must ensure that requests to your auth-host are routed to the traefik-forward-auth container, as demonstrated with the service labels in the [docker-compose-auth.yml](https://github.com/ictsc/traefik-forward-auth/blob/master/examples/traefik-v2/swarm/docker-compose-auth-host.yml) example and the [ingressroute resource](https://github.com/ictsc/traefik-forward-auth/blob/master/examples/traefik-v2/kubernetes/advanced-separate-pod/traefik-forward-auth/ingress.yaml) in a kubernetes example. ### Logging Out @@ -521,4 +521,4 @@ Note: This only clears the auth cookie from the users browser and as this servic ## License -[MIT](https://github.com/logica0419/traefik-forward-auth/blob/master/LICENSE.md) +[MIT](https://github.com/ictsc/traefik-forward-auth/blob/master/LICENSE.md) diff --git a/cmd/main.go b/cmd/main.go index 91c3564c..7fc796bb 100644 --- a/cmd/main.go +++ b/cmd/main.go @@ -4,7 +4,7 @@ import ( "fmt" "net/http" - internal "github.com/logica0419/traefik-forward-auth/internal" + internal "github.com/ictsc/traefik-forward-auth/internal" ) // Main diff --git a/go.mod b/go.mod index 300f83f8..d8e2a350 100644 --- a/go.mod +++ b/go.mod @@ -1,4 +1,4 @@ -module github.com/logica0419/traefik-forward-auth +module github.com/ictsc/traefik-forward-auth go 1.23.7 diff --git a/internal/auth.go b/internal/auth.go index 3a39e008..221372c9 100644 --- a/internal/auth.go +++ b/internal/auth.go @@ -12,7 +12,7 @@ import ( "strings" "time" - "github.com/logica0419/traefik-forward-auth/internal/provider" + "github.com/ictsc/traefik-forward-auth/internal/provider" ) // Request Validation diff --git a/internal/auth_test.go b/internal/auth_test.go index 4efb5ad2..5b7130c9 100644 --- a/internal/auth_test.go +++ b/internal/auth_test.go @@ -9,8 +9,8 @@ import ( "testing" "time" - "github.com/logica0419/traefik-forward-auth/internal/provider" - "github.com/logica0419/traefik-forward-auth/internal/provider/mock" + "github.com/ictsc/traefik-forward-auth/internal/provider" + "github.com/ictsc/traefik-forward-auth/internal/provider/mock" "github.com/stretchr/testify/assert" "go.uber.org/mock/gomock" ) diff --git a/internal/config.go b/internal/config.go index c831cb2d..7d26c217 100644 --- a/internal/config.go +++ b/internal/config.go @@ -12,7 +12,7 @@ import ( "strings" "time" - "github.com/logica0419/traefik-forward-auth/internal/provider" + "github.com/ictsc/traefik-forward-auth/internal/provider" "github.com/thomseddon/go-flags" ) diff --git a/internal/provider/mock/providers.go b/internal/provider/mock/providers.go index b5565827..efb78354 100644 --- a/internal/provider/mock/providers.go +++ b/internal/provider/mock/providers.go @@ -12,7 +12,7 @@ package mock import ( reflect "reflect" - provider "github.com/logica0419/traefik-forward-auth/internal/provider" + provider "github.com/ictsc/traefik-forward-auth/internal/provider" gomock "go.uber.org/mock/gomock" ) diff --git a/internal/server.go b/internal/server.go index f38ff0fd..7d09b7ca 100644 --- a/internal/server.go +++ b/internal/server.go @@ -4,7 +4,7 @@ import ( "net/http" "net/url" - "github.com/logica0419/traefik-forward-auth/internal/provider" + "github.com/ictsc/traefik-forward-auth/internal/provider" "github.com/sirupsen/logrus" muxhttp "github.com/traefik/traefik/v3/pkg/muxer/http" )