aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorShulhan <ms@kilabit.info>2025-07-04 01:45:08 +0700
committerShulhan <ms@kilabit.info>2025-07-04 01:45:08 +0700
commite9188df6e7e2f5c926497713c3d4afaa5774deae (patch)
treec09389bcef3315475fc10d3c3ba8cb2dd586bef7
parentfcee8c10c0dab80b29e8bab93869900f4fbfb84a (diff)
downloadrescached-e9188df6e7e2f5c926497713c3d4afaa5774deae.tar.xz
all: cleaning README and expand the index in documentation
In the README, we remove the EXIT STATUS and AUTHOR sections. Those sections are not informative. In the index, we expand the preamble to include short information about what is rescached.
-rw-r--r--README27
-rw-r--r--_www/doc/index.adoc32
2 files changed, 40 insertions, 19 deletions
diff --git a/README b/README
index d1a0404..ad8cf6e 100644
--- a/README
+++ b/README
@@ -370,7 +370,7 @@ request is from HTTPS connection and its working.
== WEB USER INTERFACE
The rescached service provide a web user interface that can be accessed at
-http://127.0.0.1:5380.
+\http://127.0.0.1:5380 .
.Screenshot of front page
image:https://raw.githubusercontent.com/shuLhan/rescached-go/master/_www/doc/images/Screenshot_wui_frontpage.png[Screenshot
@@ -407,11 +407,6 @@ The Zone.d page allow user manage zone file, creating new zone file, adding or
deleting new resource record in the zone file.
-== EXIT STATUS
-
-Upon success, `rescached` will return 0, or 1 otherwise.
-
-
== FILES
`/etc/rescached/rescached.cfg`:: The `rescached` main configuration.
@@ -459,9 +454,16 @@ OPT:: This is a "pseudo DNS record type" needed to support EDNS
Technically, if it can compiled, it will run in any operating system.
-== AUTHOR
+== LINKS
+
+https://git.sr.ht/~shulhan/rescached[Repository^]::
+Link to the source code.
+
+https://todo.sr.ht/~shulhan/rescached[Issues^]::
+List of open issues.
-`rescached` is developed by Shulhan (ms@kilabit.info).
+https://lists.sr.ht/~shulhan/rescached[Patches^]::
+Link to submit the patches and discussion.
== LICENSE
@@ -473,15 +475,6 @@ Use of this source code is governed by a GPL 3.0 license that can be found
in the COPYING file.
-== LINKS
-
-The project for this software is available at
-https://sr.ht/~shulhan/rescached.
-
-For request of features and/or bugs report please submitted through web at
-https://todo.sr.ht/~shulhan/rescached.
-
-
== SEE ALSO
*rescached.cfg*(5)
diff --git a/_www/doc/index.adoc b/_www/doc/index.adoc
index 94018ab..5f42ec9 100644
--- a/_www/doc/index.adoc
+++ b/_www/doc/index.adoc
@@ -5,6 +5,34 @@
:sectanchors:
:sectlinks:
+`rescached` is a daemon that caching internet name and address on local memory
+for speeding up DNS resolution.
+
+`rescached` is not a reimplementation of DNS server like BIND.
+
+`rescached` primary goal is only to caching DNS queries and answers, used by
+personal or small group of users, to minimize unneeded traffic to outside
+network.
+
+
+== Features
+
+List of current features,
+
+* Enable to handle request from UDP and TCP connections
+* Enable to forward request using UDP or TCP
+* Load and serve addresses and host names in `/etc/hosts`
+* Load and serve hosts formatted files inside directory
+ `/etc/rescached/hosts.d/`
+* Blocking ads and/or malicious websites through host list in
+ `/etc/rescached/hosts.d/`
+* Support loading and serving zone file format from
+ `/etc/rescached/zone.d`
+* Integration with openresolv
+* Support DNS over TLS (DoH) (RFC 7858)
+* Support DNS over HTTPS (DoH) (RFC 8484)
+
+
== Documentation
link:benchmark.html[Benchmark^]:: The benchmark result of rescached server.
@@ -18,6 +46,7 @@ configuration.
link:resolver.html[resolver^]:: Manual page for resolver.
+
== Development
https://git.sr.ht/~shulhan/rescached[Repository^]::
@@ -29,10 +58,10 @@ List of open issues.
https://lists.sr.ht/~shulhan/rescached[Patches^]::
Link to submit the patches.
+
== Todo
* Zoned create should fill default SOA
-
* zone.d rr add - check for duplicate value.
* Prioritize the order of hosts file to be loaded:
@@ -41,5 +70,4 @@ Link to submit the patches.
** zone.d
* Generate unique ID for each RR in caches/zone for deletion.
-
* Support DNSSec