v2 Upgrade Guide

Overview

traefik-forward-auth v2 was released in April 2019, as all v1 examples did not specify a specific image tag, much work was done to ensure backwards compatibility.

v2 introduced the following major changes and features:

• Refactor and improvement of codebase
• Improved consistency and simplicity of configuration (use of jessevdk/go-flags for configuration parsing)
• Support for multiple configuration files
• Support for selective authentication via rules (details under rules option here)
• Improved and simplified tests (and use of stretchr/testify)

The format for CLI and file options are still dash separated (e.g. 'cookie-name'), environment variables are still uppercase, underscore separated (e.g. 'COOKIE_NAME').

Changes

Option Changes

A number of configuration options were changed, you will now receive a warning if you're using a "legacy" config option, these are outlined below:

Legacy Usage	v2 Usage	Description
cookie-domins=one.com,two.org	cookie-domain=one.com cookie-domain=two.org	Plural CSL to multiple singular
cookie-secure=false	CLI: --insecure-cookie File: insecure_cookie=1	Change to explicit bool flag
domain=one.com,two.org	domain=one.com domain=two.org	CSL to multiple
whitelist=one.com,two.org	whitelist=one.com whitelist=two.org	CSL to multiple

*CSL = Comma Separated List

File Format Changes

v2 now uses a more standard ini format, strings can be quoted or unquoted, spaces can be put around the =, e.g.

cookie-name=_oauth_cookie
csrf-cookie-name = "_csrf_oauth_cookie"