Skip to main content

Installation

Install and configure Traefik Hub.

Before You Begin​

It is recommended that you have a basic understanding of Kubernetes. You should have access to a working Kubernetes cluster, either on a cloud provider or on your own infrastructure.

Please make sure that you have the following:

To install Traefik Hub, go to the Traefik Hub Dashboard.

When working on a new setup, the welcome page will invite you to Create my first Traefik Hub Gateway as shown below.

https://hub.traefik.io
Traefik Hub dashboard welcome screenTraefik Hub dashboard welcome screen

This screen allows you to set the Traefik Hub Gateway name.

https://hub.traefik.io
New gateway creation form in Traefik HubNew gateway creation form in Traefik Hub

Copy and paste the instructions provided and run them on your cluster. This will install Traefik Hub Gateway.

Save the token provided for future reference. If you lose it, you can rotate the token to get a new one. See Rotating Your License Token to generate a replacement.

Select Configuration Done. Traefik Hub will then detect your newly installed agent.

Rotating Your License Token​

Independently of license renewal, every gateway's license token has a lifetime of 1 year by default (the exact value can be configured per workspace, reach out to the sales team if you need a different interval) and must be rotated before it expires. The existing 30-day grace period only applies to the workspace-level license — once a token expires, the gateway stops working immediately, regardless of your license's status.

You can rotate a token from the Traefik Hub Online Dashboard, on the gateway's Settings page, reachable from both online and offline gateway detail pages. Rotating issues a new token and schedules the existing token(s) for removal, giving you a short window to roll out the new token before the old one stops working. This is also how you recover access if you lose your gateway's token: rotate to issue a new one, then update your existing deployment instead of reinstalling.

  1. Open the gateway's License tokens settings: In the Traefik Hub Online Dashboard, open your gateway and go to Settings. The License tokens table lists each token with its creation date and the time remaining before it expires. Select Rotate.
  2. Confirm the rotation: Rotation cannot be undone. Existing tokens stop working and are deleted within 5 days. To confirm, type I am sure in the input field and select Confirm.
  3. Copy the new token: The new token is shown only once. Copy it immediately and store it securely, as it cannot be retrieved later. Select Ok, got it when you are done.
  4. Roll out the new token: The License tokens table now lists the new token alongside the previous one, marked with the time left before it stops working.
    • For offline gateways, update your gateway configuration with the new token (see License Management in Offline Mode).
    • For online gateways, update the token wherever it's configured (Helm value or --hub.token flag) and restart the gateway to pick it up.

Update your gateways with the new token before the old one stops working, to avoid any interruption.

Custom Configuration

To adjust the default configuration, refer to the values files of the Chart.

info

Even if you can scale the number of replicas, it is not possible to deploy many different Traefik Hub Gateways on the same cluster.

Did You Know ?

The Traefik Helm Chart is open source. Contributors are welcome!