Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,17 +46,17 @@ 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`).

We also build binary files for usage without docker starting with releases after 2.2.0 You can find these as assets of the specific GitHub release.

### 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

Expand All @@ -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
Expand All @@ -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

Expand All @@ -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

Expand All @@ -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

Expand Down Expand Up @@ -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`.
Expand All @@ -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

Expand All @@ -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)
2 changes: 1 addition & 1 deletion cmd/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module github.com/logica0419/traefik-forward-auth
module github.com/ictsc/traefik-forward-auth

go 1.23.7

Expand Down
2 changes: 1 addition & 1 deletion internal/auth.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions internal/auth_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"
)
Expand Down
2 changes: 1 addition & 1 deletion internal/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"
)

Expand Down
2 changes: 1 addition & 1 deletion internal/provider/mock/providers.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion internal/server.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"
)
Expand Down