Offline Mode
Traefik Hub API Gateway's Offline Mode allows you to deploy and operate gateways without requiring connectivity to the Traefik Hub Online Dashboard. This is particularly useful for air-gapped environments, regulated industries, or scenarios where external communication is restricted.
Offline Mode can only be enabled when creating a new gateway. You cannot switch an existing gateway to offline mode.
Prerequisites
- License Requirement: Offline Mode is a licensed feature. Access to this feature must be granted by the Traefik Labs sales team.
- License Token: Your license token must include the offline claim to enable this feature.
Enabling Offline Mode
To activate Offline Mode, start the Traefik Hub Gateway with the --hub.offline flag:
- CLI
- Helm Values
traefik-hub --hub.token=<your-token> --hub.offline
hub:
offline: true
In the Traefik Hub Online Dashboard, you can also toggle the Offline Mode from the gateway's creation form:
Enabling Offline Mode disables the gateway's communication with the online dashboard, preventing ping and version check calls.
Supported Platforms
Offline Mode is supported on the following platforms:
- Docker/Swarm
- Kubernetes
- Linux
- Nomad
License Management in Offline Mode
In Offline Mode, license validation relies solely on the local license token. It's crucial to keep this token up-to-date to prevent service interruptions.
License Token Validity
When using Offline Mode, the gateway relies entirely on the license token provided at deployment time. This token includes all necessary claims for the gateway to operate without contacting the online dashboard.
Ensure your license token is valid throughout the lifetime of your gateway.
When the license token is expired, the gateway will enter a 30-day grace period, after which it will stop functioning.
Behavior Summary
| Scenario | Behavior |
|---|---|
| Valid license token | Gateway operates normally without connectivity to the online dashboard. |
| Expired license token | Gateway enters a 30-day grace period with operational logs indicating expiration. |
| Post-grace period expiration | Gateway stops functioning until a valid license token is provided. |
Conclusion
Offline Mode provides a secure and reliable way to deploy and operate Traefik Hub API Gateways in environments with limited external connectivity. By following the instructions outlined in this guide, you can ensure that your gateway stays operational even when not connected to the Traefik Hub Online Dashboard.