Get started
Create your free workspace
Sign in, then create a Groundhog workspace or join one from an invitation before you create a tunnel.
Sign in to Groundhog
#Open the sign-in page, choose an available account provider, and finish its sign-in to return to Groundhog. Your service may offer Microsoft, Google, Apple, GitHub or another provider. You do not create a separate Groundhog password.
Last used marks the provider you last successfully signed in with on this browser. It does not sign you in automatically or prevent you choosing another provider.
Keep using the same provider and account for your workspace. Signing in through another provider creates a separate account, even when its email address matches. Ask an owner for an invitation if you want that account to join your existing workspace.
New to Groundhog? Sign in with any provider. If your account has no workspace yet and signup is enabled, the next page offers a free workspace; if you already belong to one, you go straight to it. If sign-in is not completed, choose Try signing in again or contact Groundhog support about account access.
Visitors who open your tunnel’s public address do not need a Groundhog account.
Your browser session expires after inactivity and also has a fixed maximum lifetime, even while you use the dashboard. If it expires, choose Sign in again to continue. Your workspace membership stays with your account, and your tunnel clients keep running. Live request feeds stop receiving new rows until you sign in again.
After a service security update, Groundhog may ask you to sign in again. Your workspace membership stays with your account. If the service uses Google, signing in with an external email address does not by itself prove that you belong to the email domain’s organisation.
Create a workspace
#A workspace holds your team’s tunnels and decides who can manage them. You need to belong to one before you can create a tunnel. On your first visit, the page after sign-in offers a free workspace:
- In Workspace name, enter a name you will recognise, 1 to 100 characters long, for example My development workspace.
- In Workspace address, enter a short address for the dashboard, for example my-dev-team. Use 3 to 40 lowercase letters, digits or hyphens, starting with a letter and ending with a letter or digit.
- Open and read the Terms of Use, then select I agree to the Terms of Use if you agree.
- Choose Create free workspace. You become its owner and land on its Tunnels page.
The workspace address appears in dashboard links only. A tunnel’s public address uses the tunnel name, so you never enter the workspace address in Aspire or the CLI.
Join a workspace from an invitation
#- Open the invitation link a workspace owner sent you.
- Sign in if Groundhog asks you to.
- Check the workspace name, then choose Join.
Opening the link alone does not join the workspace, and each link works once. If it has expired or was already used, ask the owner for a new one.
If Groundhog says Too many attempts or Link lookup address capacity is full, wait for the delay in the Retry-After response header and try the same link again. Avoid repeatedly refreshing or opening more tabs. This temporary refusal does not consume your invitation.
If you can’t create a workspace
#- The workspace address is invalid: correct the address before submitting. Use lowercase letters, digits or hyphens; start with a letter and end with a letter or digit.
- The workspace address is taken: choose another address.
- You already created one: each account can create one free workspace. Join others by invitation.
- There is no option to create one: self-service registration is turned off. Ask a workspace owner for an invitation, or contact Groundhog support.
Sign out of Groundhog
#Open your account menu and choose Sign out. Groundhog ends this browser session and shows You’re signed out. Your other browser sessions and account provider remain signed in.
Choose Sign in again when you want to return, then choose your provider. Microsoft, Google and GitHub offer account selection. Last used remains visible after sign-out. If sign-out fails, the dashboard stays open and shows an error so you can try again.
Create your first tunnel
#Once you see Tunnels, follow Create a tunnel and save its key. Keep the dashboard open while you set up Aspire or the CLI.