lissy93/web-check🕵️♂️ All-in-one OSINT tool for analysing any website
<h1 align="center">Web-Check</h1>
<p align="center">
<img src="https://cdn.as93.net/logo/web-check/w256" width="96" /><br />
<b><i>Comprehensive, on-demand open source intelligence for any website</i></b>
<br />
<b>🌐 <a href="https://web-check.xyz/">web-check.xyz</a></b><br />
</p>
---
<p align="center">Kindly supported by:</p>
<table align="center">
<tr>
<td align="center" width="33%">
<a href="https://nubela.co/?utm_source=github&utm_medium=sponsorship&utm_campaign=oss_sponsorships&utm_content=github_readme&utm_id=web_check_2026">
<img src="https://pixelflare.cc/alicia/sponsors/ninja-pear.png" width="260" alt="NinjaPear"><br>
<b>NinjaPear</b>
</a><br>
<sub>API to get a full B2B profiles from any URL</sub>
</td>
<td align="center" width="33%">
<a href="https://www.hostg.xyz/aff_c?offer_id=48&aff_id=243972&url_id=6826">
<img src="https://pixelflare.cc/alicia/sponsors/hostinger-2.png" width="260" alt="Hostinger"><br>
<b>Hostinger</b>
</a><br>
<sub>Deploy Web-Check with one click on Hostinger</sub>
</td>
<td align="center" width="33%">
<a href="https://go.warp.dev/web-check">
<img src="https://raw.githubusercontent.com/warpdotdev/brand-assets/main/Github/Sponsor/Warp-Github-LG-02.png?raw=true" width="260" alt="Warp"><br>
<b>Warp</b>
</a><br>
<sub>Built for coding with multiple AI agents</sub>
</td>
</tr>
</table>
#### Contents
- **[About](#about)**
- [Screenshot](#screenshot)
- [Live Demo](#live-demo)
- [Mirror](#mirror)
- [Features](#features)
- **[Usage](#usage)**
- Deployment
- [Option#1: Netlify](#deploying---option-1-netlify)
- [Option#2: Vercel](#deploying---option-2-vercel)
- [Option#3: Hostinger](#deploying---option-3-hostinger)
- [Option#4: Render](#deploying---option-4-render)
- [Option#5: Docker](#deploying---option-5-docker)
- [Option#6: Source](#deploying---option-6-from-source)
- [Configuration Options](#configuring)
- [Developer Setup](#developing)
- **[Community](#community)**
- [Contributing](#contributing)
- [Bugs](#reporting-bugs)
- [Support](#supporting)
- **[License](#license)**
---
## About
Get an insight into the inner-workings of a given website: uncover potential attack vectors, analyse server architecture, view security configurations, and learn what technologies a site is using.
The aim is to help you easily understand, optimize and secure your website.
### Screenshot
<details>
<summary>Expand Screenshot</summary>
[](https://web-check.as93.net/)
</details>
[](https://github.com/Lissy93/web-check/tree/master/.github/screenshots)
### Live Demo
A hosted version can be accessed at: **[web-check.as93.net](https://web-check.as93.net)**
### Mirror
The source for this repo is mirrored to CodeBerg, available at: **[codeberg.org/alicia/web-check](https://codeberg.org/alicia/web-check)**
### Status
Build & Deploys: [](https://app.netlify.com/sites/web-check/deploys)
[](https://vercel.com/as93/web-check/)
[](https://github.com/Lissy93/web-check/actions/workflows/docker.yml)
[](https://github.com/Lissy93/web-check/actions/workflows/deploy-aws.yml)
<br />
Repo Management & Miscellaneous: [](https://github.com/Lissy93/web-check/actions/workflows/mirror.yml)
[](https://github.com/Lissy93/web-check/actions/workflows/credits.yml)
### Features
See **[web-check.xyz/about](https://web-check.xyz/about)** for the full list of checks, and what each one does
---
## Usage
### Deploying - Option #1: Netlify
Click the button below, to deploy to Netlify 👇
[](https://app.netlify.com/start/deploy?repository=https://github.com/lissy93/web-check)
### Deploying - Option #2: Vercel
Click the button below, to deploy to Vercel 👇
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Flissy93%2Fweb-check&project-name=web-check&repository-name=web-check-fork&demo-title=Web-Check%20Demo&demo-description=Check%20out%20web-check.xyz%20to%20see%20a%20live%20demo%20of%20this%20application%20running.&demo-url=https%3A%2F%2Fweb-check.xyz&demo-image=https%3A%2F%2Fraw.githubusercontent.com%2FLissy93%2Fweb-check%2Fmaster%2F.github%2Fscreenshots%2Fweb-check-screenshot10.png)
### Deploying - Option #3: Hostinger
Deploy Web-Check with a single click on Hostinger – pre-configured and ready to run 👇
<a href="https://www.hostg.xyz/aff_c?offer_id=48&aff_id=243972&url_id=6826"><img height="32" src="https://assets.hostinger.com/vps/deploy.svg"></a>
### Deploying - Option #4: Render
Click the button below, to deploy to Render 👇
[](https://render.com/deploy?repo=https://github.com/Lissy93/web-check)
### Deploying - Option #5: Docker
Run `docker run -p 3000:3000 lissy93/web-check`, then open [`localhost:3000`](http://localhost:3000)
<details>
<summary>Docker Options</summary>
You can get the Docker image from:
- DockerHub: [`lissy93/web-check`](https://hub.docker.com/r/lissy93/web-check)
- GHCR: [`ghcr.io/lissy93/web-check`](https://github.com/Lissy93/web-check/pkgs/container/web-check)
- Or build the image yourself by cloning the repo and running `docker build -t web-check .`
</details>
### Deploying - Option #6: From Source
Install the prerequisites listed in the [Developing](#developing) section, then run:
```bash
git clone https://github.com/Lissy93/web-check.git # Download the code from GitHub
cd web-check # Navigate into the project dir
yarn install # Install the NPM dependencies
yarn build # Build the app for production
yarn start # Start the app (API and GUI)
```
---
### Configuring
By default, no configuration is needed.
But there are some optional environmental variables that you can set to give you access to some additional checks, or to increase rate-limits for some checks that use external APIs.
**API Keys & Credentials**:
| Key | Value |
| ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `GOOGLE_CLOUD_API_KEY` | A Google API key with the PageSpeed Insights and Safe Browsing APIs enabled ([get here](https://developers.google.com/speed/docs/insights/v5/get-started)). Runs the quality and Safe Browsing checks |
| `SHODAN_API_KEY` | A Shodan API key ([get here](https://account.shodan.io/)). Runs the host names, server info and vulnerabilities checks |
| `CLOUDMERSIVE_API_KEY` | A Cloudmersive API key ([get here](https://account.cloudmersive.com/)). Adds the Cloudmersive website scan to the threats check |
| `TRANCO_API_KEY` | A Tranco API key ([get here](https://tranco-list.eu/)). Raises the Tranco rate limit for the rank check |
| `TRANCO_USERNAME` | Your Tranco account email, used with the key above |
| `GITHUB_TOKEN` | A GitHub token ([get here](https://github.com/settings/tokens)). Raises the GitHub rate limit for the social presence check |
| `CERTSPOTTER_TOKEN` | A CertSpotter API token ([get here](https://sslmate.com/certspotter/api/)). Raises the CertSpotter rate limit for the subdomains check |
**Configuration Settings**:
| Key | Value |
| -------------------------- | -------------------------------------------------------------------------- |
| `PORT` | Port to serve the API, when running server.js (e.g. `3000`) |
| `API_ENABLE_RATE_LIMIT` | Enable rate-limiting for the /api endpoints (e.g. `true`) |
| `PUBLIC_API_TIMEOUT_LIMIT` | The timeout limit for API requests, in milliseconds (e.g. `25000`) |
| `API_CORS_ORIGIN` | Enable CORS, by setting your allowed hostname(s) here (e.g. `example.com`) |
| `API_DISABLED_CHECKS` | Comma-separated list of checks to disable (e.g. `trace-route,ports`) |
| `API_ENABLED_CHECKS` | If set, only these checks will run (e.g. `get-ip,ssl,dns,headers`) |
| `API_BLOCKED_HOSTS` | Hosts that must never be scanned (e.g. `lan.example.com,192.168.0.0/16`) |
| `CHROME_PATH` | The path the Chromium executable (e.g. `/usr/bin/chromium`) |
| `DISABLE_GUI` | Disable the GUI, and only serve the API (e.g. `false`) |
| `PUBLIC_API_ENDPOINT` | The endpoint for the API, either local or remote (e.g. `/api`) |
All values are optional.
You can add these as environmental variables. Either put them directly into an `.env` file in the projects root, or via the Netlify / Vercel UI, or by passing to the Docker container with the --env flag, or using your own environmental variable management system
Note that values prefixed with `PUBLIC_` are read by the frontend at build time, so you need to rebuild after changing them
---
### Developing
1. Clone the repo, `git clone [email protected]:Lissy93/web-check.git`
2. Cd into it, `cd web-check`
3. Install dependencies: `yarn`
4. Start the dev server, with `yarn dev`
You'll need [Node.js](https://nodejs.org/en) (v22.22 or later) installed, plus [yarn](https://yarnpkg.com/getting-started/install) as well as [git](https://git-scm.com/).
Some checks also require `chromium`, `traceroute` and `dns` to be installed within your environment. These jobs will just be skipped if those packages aren't present.
---
## Community
### Contributing
Contributions of any kind are very welcome, and would be much appreciated.
For Code of Conduct, see [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).
To get started, fork the repo, make your changes, add, commit and push the code, then come back here to open a pull request. If you're new to GitHub or open source, [this guide](https://www.freecodecamp.org/news/how-to-make-your-first-pull-request-on-github-3#let-s-make-our-first-pull-request-) or the [git docs](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) may help you get started, but feel free to reach out if you need any support.
[](https://github.com/Lissy93/web-check/compare)
### Reporting Bugs
If you've found something that doesn't work as it should, or would like to suggest a new feature, then go ahead and raise a ticket on GitHub.
For bugs, please outline the steps needed to reproduce, and include relevant info like system info and resulting logs.
[](https://github.com/Lissy93/web-check/issues/new/choose)
### Supporting
The app will remain 100% free and open source.
But due to the amount of traffic that the hosted instance gets, the lambda function usage is costing about $25/month.
Any help with covering the costs via GitHub Sponsorship would be much appreciated.
It's thanks to the support of the community that this project is able to be freely available for everyone :)
[](https://github.com/sponsors/Lissy93)
### Contributors
Credit to the following users for contributing to Web-Check
[](https://github.com/lissy93/web-check/graphs/contributors)
### Sponsors
Huge thanks to these wonderful people, who sponsor me on GitHub, their support helps cover the costs required to keep Web-Check and my other projects free for everyone. Consider joining them, by [sponsoring me on GitHub](https://github.com/sponsors/Lissy93) if you're able.
[](https://github.com/sponsors/lissy93)
---
## License
> _**[Lissy93/Web-Check](https://github.com/Lissy93/web-check)** is licensed under [MIT](https://github.com/Lissy93/web-check/blob/HEAD/LICENSE) © [Alicia Sykes](https://aliciasykes.com) 2023 - 2026._<br>
> <sup align="right">For information, see <a href="https://tldrlegal.com/license/mit-license">TLDR Legal > MIT</a></sup>
<details>
<summary>Expand License</summary>
```
The MIT License (MIT)
Copyright (c) Alicia Sykes <[email protected]>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sub-license, and/or sell
copies of the Software, and to permit persons to whom the Software is furnished
to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANT ABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
```
[](https://app.fossa.com/projects/git%2Bgithub.com%2FLissy93%2Fweb-check?ref=badge_large&issueType=license)
</details>
<!-- License + Copyright -->
<p align="center">
<i>© <a href="https://aliciasykes.com">Alicia Sykes</a> 2026</i><br>
<i>Licensed under <a href="https://gist.github.com/Lissy93/143d2ee01ccc5c052a17">MIT</a></i><br>
<a href="https://github.com/lissy93"><img src="https://pixelflare.cc/alicia/images/octoface.webp?w=64" /></a><br>
<sup>Thanks for visiting :)</sup>
</p>
<!-- Dinosaurs are Awesome -->
<!--
. - ~ ~ ~ - .
.. _ .-~ ~-.
//| \ `..~ `.
|| | } } / \ \
(\ \\ \~^..' | } \
\`.-~ o / } | / \
(__ | / | / `.
`- - ~ ~ -._| /_ - ~ ~ ^| /- _ `.
| / | / ~-. ~- _
|_____| |_____| ~ - . _ _~_-_
-->