If you are connecting to GitHub Enterprise, or online sign-in does not work for you, use a token to authenticate.

To get a token from GitHub, open the token page:

1. Go to GitHub
2. Click on your profile, then on "Settings"
3. Go to the "Developer settings" tab
4. Click on "Personal access tokens", then "Tokens (classic)"
5. Click on Generate new token
6. Set expiration to "No expiration" to ensure that the token works indefinitely. You specify another value if needed.
7. Select the required token permissions (see below)

Required token permissions:

• repo - we use it to read pull requests in public and private repositories. GitHub does not have a more granular permission request at the moment
• read:org - read information about team membership
• write:repo_hook - the app can add webhooks to get faster notifications about changes in the repo and reduce load on the GitHub service.
• notifications - read notifications
• read:user - read information about the user and their teams.

There are several collaboration features that require internet access and that interact with a secure CatLight cloud service over an encrypted channel:

• Shared dashboards. When you share a dashboard in the app, the dashboard settings are saved in a CatLight cloud service, so that other users on your team can use it. Dashboard settings include the names and ids of the builds, projects and work item queries, as well as priority rules that you have configured in dashboard settings.
• Build and release investigations. When the user clicks on "start investigation" in the app, CatLight will store and forward build or release metadata (name and id) to other users on the team using the CatLight cloud service.
• Notifications about active pull request reviews. When the user clicks on "start review" in the app, CatLight will forward pull request metadata (name and id) to other users on the team using CatLight cloud service.
• Accelerated notifications. If you install an optional CatLight plugin on your CI/CD server and enable accelerated notifications, the CatLight plugin will configure webhooks in your CI/CD server that send metadata about changed builds, releases, pull requests, and work items to the CatLight cloud service. The metadata transferred in the webhook payload depends on the CI/CD server you use, and you can inspect it in your server documentation. CatLight service will extract the names and ids of changed objects and forward this information to CatLight apps on the team, to notify them about the change. It does not store the original webhook payload and discards it after processing.

• TFS 2022+, 2020, 2019, 2017, 2015, 2013. Azure DevOps Server. Work item monitoring is available only for TFS 2015+
• Azure DevOps / VSTS
• Jenkins 1.644 (released in early 2016) and newer. Jenkins 2.x is also supported
• TeamCity 8 and newer
• Travis CI (open source and pro). For enterprise - vote on this idea.
• Appveyor (open source, pro and premium)
• GitLab
• GitHub Enterprise and public GitHub
• Jira (on-prem and cloud version)

You can also create an extension for your favorite server using this open protocol, and CatLight will work with it too.

CatLight Protocol 1.0 is an open standard for continuous delivery servers. The CatLight app can now connect to any server that implements this protocol.

The new protocol is a replacement for the obsolete cc.xml format that was created over a decade ago, and no longer meets the feature set of modern build systems.

CatLight protocol has native support for branches, folders, consistent build history, authentication, caching and selective loading. It provides enough information for CatLight app features like build investigations, automatic branch tracking and personalized build dashboard.

We invite developers of continuous delivery servers to implement this protocol to get an amazing notifier for their own platform.