Getting started with Oxygen
Oxygen is a hosting platform that enables you to deploy and preview your Hydrogen storefront without configuring or maintaining infrastructure.
In this tutorial, you'll learn how to add the Hydrogen sales channel to a Shopify store.
RequirementsAnchor link to section titled "Requirements"
Step 1: Add the Hydrogen sales channelAnchor link to section titled "Step 1: Add the Hydrogen sales channel"
The Hydrogen sales channel enables the store that you're working on to use Oxygen for managing Hydrogen storefronts.
The Hydrogen sales channel doesn't replace or change the online store channel of the store that you're working on, or your live storefront.
You can install the Hydrogen sales channel with the following procedure, or you can install it from the Shopify App Store.
From your Shopify admin, beside Sales channels, click >.
Click All recommended sales channels.
Step 2: Install the Shopify GitHub appAnchor link to section titled "Step 2: Install the Shopify GitHub app"
The Shopify GitHub app enables you to connect a GitHub account to your Shopify admin. This connection enables you to make and track changes to Hydrogen storefront code, and enables you to collaborate with other developers to share progress.
Select the GitHub account that will use the Hydrogen storefront GitHub repository.
If the GitHub account that you want to use isn't in the list, then click Add account to add the GitHub account.
If you're prompted to authorize and install the Shopify GitHub app, then accept the prompt.
Select whether you want to install the app on your personal account or in an organization.
If the repository belongs to an organization where you don't have rights to install an app, then you might need to request that your administrator approve the installation before proceeding.
Continue to Create a GitHub repository.
Step 3: Create a GitHub repositoryAnchor link to section titled "Step 3: Create a GitHub repository"
If you've already created a GitHub repository with Hydrogen storefront code, then skip to Connect the Hydrogen sales channel to a GitHub repository.
When you create a new GitHub repository from the Shopify admin, Shopify adds the Hydrogen starter template code, injects Oxygen deployment secrets, and adds the Oxygen deployment workflow.
- From your Shopify admin, under Sales channels, click Hydrogen.
- In the Hydrogen storefronts interface, click Create storefront.
- Under Account, select an account that will own the Hydrogen Git repository.
- Under Repository, type the name for the new Hydrogen Git repository.
- Optional: Check Create as a public repository.
- Click Create.
Troubleshooting your GitHub connectionAnchor link to section titled "Troubleshooting your GitHub connection"
In rare circumstances, when you have SSO enabled on your organization, the connection to your GitHub account might fail but show a successful connection. To rebuild the connection, you can revoke the Shopify GitHub app's access to your account through your GitHub settings, and then ensure that you're logged in and have an active SAML session before completing the setup process again.