https://github.com/mrluit/censorradar
A website to scan your local network for any blocked domains
https://github.com/mrluit/censorradar
censor censorradar censorship html javascript network scanner
Last synced: 10 months ago
JSON representation
A website to scan your local network for any blocked domains
- Host: GitHub
- URL: https://github.com/mrluit/censorradar
- Owner: MrLuit
- License: mit
- Created: 2017-03-25T11:39:23.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-06-05T10:58:01.000Z (over 8 years ago)
- Last Synced: 2025-04-02T06:51:12.171Z (11 months ago)
- Topics: censor, censorradar, censorship, html, javascript, network, scanner
- Language: JavaScript
- Homepage: https://mrluit.github.io/CensorRadar/
- Size: 725 KB
- Stars: 5
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# CensorRadar
[](https://github.com/MrLuit/CensorRadar/releases) [](https://github.com/MrLuit/CensorRadar/graphs/contributors)
This repository is the open-source project for a website that scans your local network for any blocked websites.
## How to use
### Online
Go to the website and click 'Start scan'. You will see all blocked domains (if there are any). If a website is blocked, you can click the little info icon to find the full path that the client couldn't access. The image is path is helpful for troubleshooting why the request can't reach the server.
### Offline
If you want to use the website locally, just [download](https://github.com/MrLuit/CensorRadar/archive/master.zip) the website and open the index.html in one of the compatible browsers. Keep in mind that by default browsers won't let you access files with files so you have to enable that or find another way to access your domains.json, for example hosting domain.json online or launching chrome with `--allow-file-access-from-files`.
## How does it work
Javascript creates a new image with an image on the domain we want to check as source. This will prevent [CORS errors](https://enable-cors.org/) and works without too much trouble for the user. A disadvantage is that some popular domains host images on a different server and therefore it's hard to check if the domain is blocked or the image server of the domain. To solve this we try to request favicon.ico from the primary server and that works in most cases because even in the worst scenario the server would probably still redirect you to the right favicon URL.
## Compatibility
| Google Chrome | Mozilla Firefox | Safari | Opera | Internet Explorer | Microsoft Edge |
|:------------------:|:------------------:|:------------------:|:------------------:|:-----------------:|:--------------:|
| :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :x: | :x: |
## Libraries
* [jQuery 3.2.0](https://github.com/jquery/jquery/tree/3.2.0)
* [Semantic-UI 2.2.9](https://github.com/Semantic-Org/Semantic-UI/tree/2.2.9)
* [SweetAlert2 6.4.4](https://github.com/limonte/sweetalert2/tree/v6.4.4)
* [Github Corners](https://github.com/tholman/github-corners)
## API
Making an official API on Github Pages is hard because this project is written in Javascript and a simple curl request can't render Javascript. A solution would be to create your own project using the data from this repository. If you make your program fetch data from https://raw.githubusercontent.com/MrLuit/CensorRadar/master/domains.json (we will try to keep this list updated) you can use the data to ping all the websites on the list. Let me know about projects you've created :)
## Contributing
When adding a new domain to domains.json, please follow this checklist:
* The website is a popular international website and has an accesible image on the primary domain (not a different CDN server)
* Don't put `http://` or `https://` in the domain and **only** put the path to the image in img without leading `/`
* Make sure the image provided is accessible from not only your computer. A favicon works best but if the server stores favicon on another server and doesn't automatically redirect just use another image URL from the website.
* If you don't want to append `www.` to the domain, put a `~` in front of the domain. This is required for subdomains like `assets.github.com`.
You can then proceed to make a [pull request](https://github.com/MrLuit/CensorRadar/pulls).
## Report issue
Create an [issue](https://github.com/MrLuit/CensorRadar/issues) with as many details as possible regarding the problem. Useful information could be the image URL, your OS, your browser, your ISP or country, and steps to reproduce the issue.