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.

important

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

Offline Mode is enabled through the Traefik Hub Online Dashboard during gateway creation. When you toggle the Offline Mode option, the platform automatically updates your license token with the necessary offline claim.

Step-by-Step Process

1. Navigate to Traefik Hub Online Dashboard: In the Traefik Hub Online Dashboard, go to the Gateways section and select "Create new gateway".

2. Configure Gateway Settings: Fill in your gateway name and other details.

https://hub.traefik.io/dashboard/gateways/new

3. Enable Offline Mode: Toggle the "Offline gateway" switch in the gateway creation form. This action automatically updates your license token to include the offline claim.

https://hub.traefik.io/dashboard/gateways/new

4. Copy Updated Token: Once offline mode is enabled, copy the updated token that now includes the offline configuration.

5. Deploy with Token: Use the updated token when deploying your gateway:

CLI

traefik-hub --hub.token=<your-updated-token> --hub.offline=true

Helm Values

hub:
  token: "<your-updated-token>"
  offline: true

Gateway Status Confirmation

Once deployed, your gateway will appear in the dashboard with an "Offline gateway" status, confirming that it's operating without connectivity to the online dashboard.

Online Dashboard Gateway List

https://hub.traefik.io/gateways

Offline Gateway Details

https://hub.traefik.io/gateways/1234567890

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. The token is automatically updated by the Traefik Hub Dashboard when you enable offline mode, ensuring it contains the necessary offline claim. 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.

important

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 with offline claim	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. The automated token management through the Traefik Hub Dashboard ensures that your gateway receives the proper offline claims without manual token configuration.