tjdev/dns-watch-2022
Archived
0
0
Fork 0
Code Pull Requests Activity

📝 clean up readme

Browse Source 
clean up readme in order to get rid of unnecessary stuff
This commit is contained in:
thetek 2021-05-08 20:29:51 +02:00 committed by GitHub
parent 251019d7cb
commit cdb22d6eb6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -4,30 +4,27 @@
## Background
The CUII, which is a German institution consisting of the biggest German ISPs and rightsholders, censors parts of the Internet to reduce the number of copyright infringements in the World Wide Web. In order to block these sites, they use the already existing DNS provided by German ISPs. When your device asks your ISP where it can find a website, it will give you wrong information and instead redirect you to the page of CUII.
Using dns-watch.org, you can check which ISPs actively censor parts of the Internet. This tool can also help developers of blocked sites by giving them information on which ISPs are blocking their web services.
We support a Free Web without Internet censorship, and so should you!
## Directory structure
**Because this web page takes advantage of our custom PHP backend, the code may not make sense immediately. For research purposes, here is an outline of the directories.**
## Other Useful Information
- config/: config files for the backend behavior
### Directory Structure
**Because this web page takes advantage of our custom PHP backend, the code and especially the functions provided by our backend may not make sense immediately. For research purposes as well as help when you want to contribute to the project (feel free to do so!), here is an outline of the directories and some of the files located inside of them:**
- `/config`: config files for the backend behavior
- cache.php: lookup caching
- lookup.php: dns lookups
- nameserver.php: dns servers to use
- functions/: basic callbacks for backend tasks
- `/functions`: basic callbacks for backend tasks
- lookup.php: dns lookups and caching
- icon/: icons for ISPs and DNS providers
- `/icon`: icons for ISPs and DNS providers
- lookup/: page for lookup-api
- index.php: entry point for api
- `/lookup`: page for lookup api with entrypoint for the api
- start/: start-page
- html/: compiled html
- src/: pug/sass source files
- feather.js: load feathericons
- index.css main stylesheet
- index.js main client scripts
- index.php entry point for start-page
- `/start`: start page ([dns-watch.org](https://dns-watch.org))