https://github.com/tjenkinson/is-github

A small JavaScript library which checks if the provided IP address belongs to GitHub.
https://github.com/tjenkinson/is-github

github ip ip-address secure security validate validation

Last synced: 4 months ago
JSON representation

A small JavaScript library which checks if the provided IP address belongs to GitHub.

• Host: GitHub
• URL: https://github.com/tjenkinson/is-github
• Owner: tjenkinson
• License: mit
• Created: 2020-03-12T19:21:13.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2025-05-06T13:20:23.000Z (about 1 year ago)
• Last Synced: 2025-12-02T06:57:29.344Z (7 months ago)
• Topics: github, ip, ip-address, secure, security, validate, validation
• Language: JavaScript
• Size: 1.09 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![npm version](https://badge.fury.io/js/is-github.svg)](https://badge.fury.io/js/is-github)

# is-github

A small JavaScript library which checks if the provided IP address belongs to GitHub. Works in Node and the browser.

It uses [GitHub's meta endpoint](https://developer.github.com/v3/meta/) to get the valid IP ranges. The response is cached for the duration GitHub provides in the `Cache-Control` header.

## Usage

```sh

$ npm i is-github

```

or "[https://cdn.jsdelivr.net/npm/is-github@1](https://cdn.jsdelivr.net/npm/is-github@1)".

```js

import { isGitHub } from 'is-github';

if (await isGitHub('1.2.3.4')) {

  console.log('Request came from GitHub!');

} else {

  console.log('Request was not from GitHub.');

}

```

### Options

It is possible to provide the following options in an object as the second argument:

- `service`: The service to check. One of: 'hooks', 'web', 'api', 'git', 'pages', 'importer' (_Default: 'hooks'_)

- `userAgent`: The user agent to use for the request to GitHub. This might not work in the browser. (_Default: 'is-github'_)

- `timeout`: The timeout in ms. (_Default: 5000_)

## Requirements

The following API's are required when running in the browser.

- [`fetch`](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)

- [`AbortController`](https://developer.mozilla.org/en-US/docs/Web/API/AbortController)