Create Author Profile

To get started creating content, create an Author profile at https://katacoda.com/create. You can select if Katacoda should automatically create a GitHub repository, or if you prefer to do it manually.

If you select manual, follow the steps below on how to configure the webhook manually.

GitHub

Configuring Git Webhook Manually

These steps explain how to manually create a GitHub Repository and connect it to Katacoda.

The first stage is to create a repository, the second is configure the Webhook so Katacoda can automatically update your profile when you push commits to Master.

Configuring GitLab, Bitbucket and other services should be similar.

Step 1 - Create GitHub Repository

Create a new public or private GitHub Repository for your Katacoda scenarios.

An example of an active repository is https://github.com/BenHall/katacoda-scenarios

Step 2 - Enter Your Git Repository URL

Configure Katacoda with the location of your GitHub Repository on your Profile Settings page.

This enables Katacoda to connect to your account and allow incoming Webhooks from GitHub.

Step 3 - Create GitHub Webhook

A GitHub Webhook sends Katacoda a message when commits are pushed to the master/main branch. This allows Katacoda to automatically update your scenarios when changes are made.

In your GitHub Repository settings, add a new GitHub Webhook.

Step 4 - Update GitHub Webhook

Configure the Webhook with the following configuration. The Payload URL is:

https://editor.katacoda.com/scenarios/updated

Webhook Secrets ensure that only notifications from sources with the correct secret are allowed. Webhooks are defined in the settings of your repository on your hosted service.

The result should look like this:

Save/Update the Webhook within GitHub.

Step 5 - Done

The GitHub Repository and Katacoda have been configured. When changes are made to the repository, they will automatically appear on your profile page.

Optional - Private Repository

Private GitHub repositories are supported. To enable access follow the Private GitHub Repository guide.

GitLab

GitLab is supported. Documentation coming soon.

Bitbucket

Bitbucket is supported. Documentation coming soon.

Other Git Providers

All Git Repositories are supported, however the Webhook functionality may not function as expected depending on the API format used by the Git repository provider.