Connect GitHub
Install the Acrosite GitHub App, choose the repository and branch Acrosite writes to, and finish GitHub setup for a project.
Acrosite publishes content by committing files to your website's GitHub repository. It connects through the Acrosite GitHub App, so access stays scoped to the repositories you choose and you never paste a personal access token. This guide connects a project to its repository.
Who this is for
Workspace Owners, Admins, and Developers. Installing the GitHub App requires permission to install an app on the repository's account or organization.
Before you start
- You have created a project. See Create your first project.
- You have a GitHub repository that already builds and deploys your site.
- You can install a GitHub App on that repository's owner account.
- You know the branch Acrosite should commit to, such as
main.
Install the Acrosite GitHub App
From your project, open GitHub Setup in the sidebar, then choose Connect GitHub. Acrosite sends you to GitHub to install its App.
- Open your project and select GitHub Setup in the sidebar.
- Select Connect GitHub.
- On GitHub, choose the account or organization that owns the repository.
- Select only the repositories Acrosite should access, then approve the installation.
Choose the repository and branch
After the App is installed, return to Acrosite and finish setup on the project's GitHub page:
- Choose the Repository for this project from the list of repositories you granted access to.
- Choose the Target Branch Acrosite will commit to. Most teams use their production branch, such as
main. Protected branches are labelled so you can avoid them. - Select Save GitHub Setup.
When setup is saved, the project's GitHub status reads Connected.
acrosite/content/posts for Posts, acrosite/content/pages for Pages, a folder per Custom Content Type, and public/images for media. These paths are set for you and are not edited in the dashboard. Make sure your site reads content from these locations, or maps them during your build.What happens next
With GitHub connected, configure how your site redeploys after a publish — see Configure a deployment trigger. After both are set up, you can create and publish content.
Troubleshooting
- My repository is not in the list. The GitHub App was not granted access to it. Open your GitHub installation settings and add the repository, then refresh the repository list in Acrosite.
- The App is not installed. Re-run Connect GitHub and complete the install on the repository's owner account.
- My branch is protected. Protected branches may block direct commits. Point Acrosite at a branch it can write to, or adjust the branch protection rules.
- Setup still shows pending. Confirm you selected both a repository and a branch and chose Save GitHub Setup. For publish-time errors, see Troubleshoot publishing failures.