Auth
Published 31 October 2023
Auth
auth initiates an online license acquisition flow.
For an overview of ways to license Flyway see Flyway Licensing
If auth is run on a machine that is connected to the internet with an accessible browser, Flyway will launch a web browser prompting the user to log in with their Redgate account
username and password.
authneeds to be able to launch a web browser and so doesn't work on WSL or when interacting with Flyway over SSH. For these cases it is recommended to use a non-interactive mechanism to license Flyway.- If you need an offline licensing mechanism please look at License Permits
Flags:
| Parameter | Edition | Description |
|---|---|---|
-IAgreeToTheEula |
Community | (Mandatory) By using this option you consent to the Redgate EULA |
-logout |
Community | Logs a user out of their authorized session of Flyway |
-startTeamsTrial |
Community | Starts a Teams trial |
-startEnterpriseTrial |
Community | Starts an Enterprise trial |
Logout
auth -logout can be run to log out of an authorized session of Flyway. This will delete the license permit and refresh token stored on disk in the
Redgate app data folder. Assuming no other methods of authorization are in use (such as a permit environment variable, a legacy license key environment variable, or a PAT token), the user will be
logged out of their session and Flyway will run as Community Edition. If a valid permit environment variable, legacy license key environment variable, or PAT token is set, Flyway will still
honor these as authorizations and logout will not remove them.
App Data Folder Locations
Flyway stores permits in a central location rather than it's installation location.
Windows
You can find the Flyway CLI directory here: %APPDATA%\Redgate\Flyway CLI.
MacOS & Linux
You can find the Flyway CLI directory here: ~/.config/Redgate/Flyway CLI.
