Getting Started

Welcome to Breakwater! This guide will help you access the container images your organization has licensed.

Logging In

New users join through an invitation. Your vendor (or an admin at your organization) sends an email with a link; open it, then either set a password or choose Accept with Google or Accept with GitHub, and you're signed in. Your Google or GitHub account doesn't have to use the invited email address. Invitations expire after 7 days, so ask for a new one if yours has lapsed.

To sign in later:

  1. Visit the customer portal
  2. Enter your email address and password, or choose Continue with Google or Continue with GitHub
  3. If you belong to multiple organizations, select the one you want to access

The first time you use Google or GitHub with an account that has a password, Breakwater asks for that password (and your two-factor code, if you use one) to link them. You can also connect or disconnect Google and GitHub under Sign-in methods on your account page. If you use two-factor authentication, Breakwater still asks for your code after a Google or GitHub sign-in.

Setting Up Pull Access

Docker needs a pull token to download your licensed images. If your organization has no active pull tokens, Breakwater takes you to a setup page right after you log in (or select an organization):

  1. Name the token, for example the cluster or pipeline that will use it
  2. Click create
  3. Copy the username and secret. The secret is shown only once. The page also shows the docker login and docker pull commands for your active licenses

If you'd rather do this later, click Skip for now. You won't be sent back to setup during that login session, and the Your software page shows a banner with a link to the Tokens page for as long as there are no active tokens.

Your Software

After logging in, you land on Your software: one card for each product your organization is licensed for. Each card shows:

  • The latest version, with an Install button that opens its install page (see below). Release candidates are skipped unless they're the only versions there are.
  • New release, when there's a release you haven't opened yet. The sidebar shows how many products have one. This is per person: a colleague opening a release doesn't clear it for you.
  • What's new, which opens the newest release you haven't seen at its notes, and All versions.
  • What you're running, when your vendor's plan includes instance reporting and your installs report in.
  • When your license ends, and a link to the license details.

A product whose vendor publishes images without releases shows Get the images instead, which opens the license's registry and pull instructions. A license that hasn't started yet shows when it starts, and one that has ended says so; neither offers downloads.

Installing a Release

A release's install page shows, in order:

  1. What's new: the release notes, including anything to do before upgrading. Read them first.
  2. Install: the vendor's install guide, with the registry and version already filled in. Login commands use YOUR_TOKEN_USERNAME; replace it with one of your pull tokens' usernames.
  3. Files, such as a Compose file and an env template. Download all gets them in one .tar.gz.
  4. Images: a docker pull command for each image, pinned to the exact digest that was released. Most installs don't need these; the Compose file pulls the same images.
  5. For organizations whose vendor offers it, Install without internet access (see Air-Gapped Installs).

A release's files never change after it's published, so downloading them again later gets exactly the same thing.

Managing Pull Tokens

Open Tokens in the sidebar to see your organization's pull tokens. Any member of your organization can create and revoke them. Each token shows its name, username, who created it (you see the email for tokens created in the customer portal, "Vendor" for tokens your vendor made, and "Breakwater" for tokens a Breakwater admin made), when it was last used, and its status (Active, Expired, Revoked, or Disabled).

Pull tokens belong to your organization, not to the person who created them. Anyone at your organization can use a token's username and secret, and the token keeps working if its creator leaves.

Creating a Token

  1. Go to Tokens
  2. Enter a name and create the token
  3. Copy the username and secret from the page that appears

The secret is shown only once and can't be retrieved later. If you lose it, create a new token and revoke the old one. An organization can have up to 25 active tokens, and each person can create up to 20 tokens an hour.

Revoking a Token

Click Revoke next to a token and confirm. Docker clients using it stop working right away, and a revoked token can't be re-enabled. You can revoke a token in any state except one that's already revoked, so a disabled token you know has leaked can still be revoked permanently.

If the person who created a token loses access to your organization, the token keeps working. It is marked "Creator no longer has access" so you can decide whether to revoke it. When an admin removes a person from your team, they can choose to revoke that person's tokens at the same time.

Accessing Docker Credentials

For active licenses, open License details from the product's card to see:

  • Registry hostname
  • Instructions for logging in with one of your pull tokens and pulling the images for that license

The page also lists the license's releases. The login command uses a YOUR_TOKEN_USERNAME placeholder; replace it with the username of one of your tokens. Docker asks for the secret when you log in. If you have no active tokens, the page links to the Tokens page so you can create one.

Next Steps

  • Pulling Images - Learn how to pull container images with your credentials
Last updated November 19, 2026