Repository files navigation

A fork ofLissy93/Web-Check, optimized for easy self-hosting
Comprehensive, on-demand open source intelligence for any website

Click the button below, to deploy to Netlify 👇

Click the button below, to deploy to Vercel 👇

Rundocker run -p 3000:3000 lissy93/web-check:1.0.0, then openlocalhost:3000

git clone https://github.com/xray-web/web-check-free.git# Download the code from GitHubcd web-check-free# Navigate into the project diryarn install# Install the NPM dependenciesyarn build# Build the app for productionyarn serve# Start the app (API and GUI)

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.

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 keys that are prefixed withREACT_APP_ are used client-side, and as such they must be scoped correctly with minimum privileges, since may be made visible when intercepting browser <-> server network requests

WhileWeb Check willalways remain 100% free and open source, the work on the upstream repo at the moment is more geared towards making the managed instance as scalable and cost effective to run at scale as possible. This includes features for advanced rate-limiting, user signup and billing. This new work adds excess overhead for those who just want to host their own instance on the cloud or locally.

To solve this, we cut this repo fromWeb-Check:1.0.0, to keep it free and easy for anyone who wants to self-host their own instance of Web Check.

If you'd rather not deploy your own, and would just like to use the public instance, you can do so atweb-check.xyz.

Found Web Check useful? Consider supporting us, bysponsoring Lissy93 on GitHub 💖

This project is only possible, thanks to supporters like you. Your donations will be used to cover running costs, and to fund both ongoing maintence and the development of new features, on both Web Check, and ourother projects.

Web-Check is licensed underMIT ©Alicia Sykes 2024.
^{For information, seeTLDR Legal > MIT}

The MIT License (MIT)Copyright (c) Alicia Sykes <alicia@omg.com> 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 install 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 APARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHTHOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTIONOF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THESOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

^{Kindly supported by:}

The $HOME of all things in the terminal.
_{Find your next CLI / TUI tool and more at Terminal Trove,}
^{Get updates on new tools on our newsletter.}

©Alicia Sykes 2024
Licensed underMIT

^{Thanks for visiting :)}