Skip to content
Birch

Search is only available in production builds. Try building and previewing the site to test it out locally.

Associating with an Organization

Before the appliance can synchronize with the cloud or appear in the web interface, it needs to be associated with an organization. This process links the physical device to your Birch account.

Prerequisites

Section titled “Prerequisites”
  • Access to the admin panel (http://<appliance-ip>:3030)
  • A Birch user account with access to at least one organization
  • The appliance must have internet access (for authentication)

Association process

Section titled “Association process”

  1. Open the admin panel and locate the Organization section at the top of the page.

  2. Click “Sign In” — This opens the authentication flow. An internet connection is required for this step.

  3. Complete authentication — Sign in with your Birch credentials. You’ll be redirected back to the admin panel after successful login.

  4. Select an organization — If your account belongs to multiple organizations, you’ll be prompted to choose one. If you only belong to one organization, it will be selected automatically.

  5. Confirm association — Once complete, you’ll see the organization name and a generated appliance ID displayed in the Organization section.

What happens during association

Section titled “What happens during association”

When you associate an appliance:

  • A unique appliance ID is generated for this device within the organization
  • The appliance records which cloud environment to connect to
  • Configuration is saved locally on the appliance

Verifying the association

Section titled “Verifying the association”

After association, you can verify by:

  • Admin panel — The Organization section shows the organization name and appliance ID.
  • Web interface — Sign in to Birch and check the Dashboard. Your appliance should appear as an online node (once services are running).

Troubleshooting

Section titled “Troubleshooting”

Sign-in button doesn’t respond

Section titled “Sign-in button doesn’t respond”
  • Verify the appliance has internet access. The authentication flow requires connectivity to the cloud.

Organization doesn’t appear after sign-in

Section titled “Organization doesn’t appear after sign-in”
  • Ensure your user account has been added to at least one organization.

Association appears to succeed but appliance doesn’t show online

Section titled “Association appears to succeed but appliance doesn’t show online”