![Web Check]()
Web Check
Stack
Web Check give you a comprehensive, on-demand open source intelligence for any website
Image details
Source details
Configuration
TypeComposelinuxlissy93/web-check3333:3000unless-stoppedStandalone Install
Select an install method, to see config/commands for deploying Web Check
Install on Portainer
Import all app templates into your Portainer instance, for easy 1-click deploys
- Ensure both Docker and Portainer are installed, and up-to-date
- Log into your Portainer web UI
- Under Settings → App Templates, paste the below URL
- Head to Home → App Templates, and the list of apps will show up
- Select Web Check, fill in any config options, and hit Deploy
Template Import URL
https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me
Original stackfile
The compose file this template deploys, straight from its repo:
version: '3.9'
services:
web-check:
container_name: Web-Check
image: lissy93/web-check
ports:
- 3333:3000
restart: unless-stopped
Or deploy it directly from the source:
git clone https://github.com/xneo1/portainer_templates
cd portainer_templates
docker compose -f Template/Stack/webcheck.yml up -dMore install options in our documentation, or see lissy93/web-check for app-specific guidance.
Web-Check
Comprehensive, on-demand open source intelligence for any website
🌐 web-check.xyz
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.Currently the dashboard will show: IP info, SSL chain, DNS records, cookies, headers, domain info, search crawl rules, page map, server location, redirect ledger, open ports, traceroute, DNS security extensions, site performance, trackers, associated hostnames, carbon footprint. Stay tuned, as I'll add more soon!
The aim is to help you easily understand, optimize and secure your website.
Screenshot
Live Demo
A hosted version can be accessed at: web-check.as93.netMirror
The source for this repo is mirrored to CodeBerg, available at: codeberg.org/alicia/web-checkMotivation
Often when you're looking into a website, there's several things you always initially check. Think: Whois, SSL chain, DNS records, tech stack, security protocols, crawl rules, sitemap, redirects, basic performance, open ports, server info, etc. None of this is hard to find with a series of basic curl commands, or a combination of online tools. But it's just so much easier to have everything presented clearly and visible in one place :)Usage
Developing
You'll need Node.js (V 18.16.1 or later) installed.- Clone the repo,
git clone git@github.com:Lissy93/web-check.git - Cd into it,
cd web-check - Install dependencies:
yarn - Start the dev server, with
yarn dev
Note that some checks also require
chromium, traceroute and dns to be installed. These jobs will be skipped if those packages arn't present.Deploying - Option #1: Netlify
Click the button below, to deploy to Netlify 👇
Deploying - Option #2: Docker
Rundocker run -p 8888:3000 lissy93/web-check, then open http://localhost:3000The app is published to DockerHub (
hub.docker.com/r/lissy93/web-check) as well as GHCR (ghcr.io/lissy93/web-check), or you can build the image yourself by cloning the project and running docker build -t web-check .
Deploying - Option #3: From Source
Follow the instructions in the Developing section above, then runyarn build && yarn start to build and serve the application.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. These include:GOOGLE_CLOUD_API_KEY- A Google API key (get here). This can be used to return quality metrics for a siteTORRENT_IP_API_KEY- A torrent API key (get here). This will show torrents downloaded by an IPREACT_APP_SHODAN_API_KEY- A Shodan API key (get here). This will show associated host names for a given domainREACT_APP_WHO_API_KEY- A WhoAPI key (get here). This will show more comprehensive WhoIs records than the default jobSECURITY_TRAILS_API_KEY- A Security Trails API key (get here). This will show org info associated with the IPBUILT_WITH_API_KEY- A BuiltWith API key (get here). This will show the main features of a site
The above keys can be added into an
.env file in the projects root, or via the Netlify UI, or by passing directly to the Docker container.Community
Contributing
Contributions of any kind are very welcome, and would be much appreciated. For Code of Conduct, see Contributor Convent.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 or the git docs may help you get started, but feel free to reach out if you need any support.
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.
Supporting
License
Lissy93/Web-Check is licensed under MIT © Alicia Sykes 2023.
For information, see TLDR Legal > MIT
Expand License
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 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.
© Alicia Sykes 2023
Licensed under MIT
Thanks for visiting :)
Serve Web Check on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.
Proxying web-check.example.com to http://web-check:3000
Add this to your Caddyfile
web-check.example.com {
reverse_proxy http://web-check:3000
}Check the logs first
Nine times out of ten the logs tell you exactly what went wrong.
- In Portainer, go to Containers, click the container, then Logs. Or run
docker logs <container> - Exit codes help too:
137means killed, usually out of memory.126or127means the command inside the image is broken.
Port already in use
If deployment fails with "Bind for 0.0.0.0:3333 failed: port is already allocated", something else on your server is using that port.
- Find what's using it:
sudo ss -tlnp | grep :3333 - Stop the other service, or pick a different host port. In
3333:3000only the left number is yours to change, the right one belongs to the app.
Running but the page won't load
The container is up but nothing appears in your browser.
- Use your server's real IP:
http://your-server-ip:3333. The 0.0.0.0 link Portainer shows isn't a real address. - Give it a minute after first deploy, web-check can take a while to initialise.
- Make sure your firewall allows the port, e.g.
sudo ufw allow 3333
Image won't pull
Test the pull directly on the host: docker pull lissy93/web-check
- "manifest unknown" means the tag no longer exists. This template uses
latest, so try pinning a specific version instead. - "toomanyrequests" is the Docker Hub rate limit. Log in with
docker loginto raise it. - "no space left on device" means a full disk. Reclaim space with
docker system prune
"exec format error"
This means the image was built for a different CPU architecture than your server.
- This image supports:
amd64, arm64 - Check yours with
uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.
Container keeps restarting
The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.
- Check the logs right after a restart, the last few lines before it died are the useful ones.
- Get the exit code with
docker inspect <container> --format '{{.State.ExitCode}}' - Still stuck? Redeploy once with the restart policy set to
noso the failure stays visible.
Stack won't deploy
Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.
- YAML only accepts spaces for indentation, a single tab breaks the whole file.
Raise an issue
Found something which isn't working as it should? Here's how to report it.
- Bug within the app: Open an issue on lissy93/web-check
- Template not working: Open an issue on xneo1/portainer_templates
- This website not working: Open an issue on lissy93/portainer-templates
A Compose stack
Web Check is a Compose stack, a set of containers defined in one file and brought up together by Portainer, then started and stopped as a single app.
The app image
An image is the app packed up ready to go, everything Web Check needs bundled into one download. This template pulls lissy93/web-check, which Docker fetches once (about 498 MB) and then starts your own copy from.
Where the image comes from
Docker pulls its images from registries, public libraries of ready-built apps. Web Check's comes from Docker Hub, published by lissy93.
Version tags
The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Newest right now is 2.2. Pin a specific tag if you would rather stay on one version.
Which machines it runs on
Every image is built for particular CPU types. This one ships for amd64, arm64, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.
Ports
A port is the door the app answers on. A mapping like 3333:3000 means it's reachable on port 3333 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:3333 in a browser. It opens:
3333:3000, likely the web interface
No stored data
This template doesn't mount any storage, so whatever Web Check writes stays inside the container and is wiped if it's recreated or updated. That's fine for something stateless, but add a volume before trusting it with anything you want to keep.
Restart policy
The restart policy here is unless-stopped, so Docker restarts Web Check after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).
Networking
Nothing custom is set, so Web Check sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.
Container name
Once it's deployed, Portainer names the container web-check. That's what you'll spot in the containers list and use in commands like docker logs web-check.
Platform
The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.
Open source license
Web Check is open source, released under the MIT license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.
Portainer app templates
Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Web Check up. Add the template list to Portainer once, then deploying Web Check is a click rather than a wall of config.