diff options
| author | Shulhan <ms@kilabit.info> | 2026-01-25 14:05:35 +0700 |
|---|---|---|
| committer | Shulhan <ms@kilabit.info> | 2026-01-25 14:05:35 +0700 |
| commit | b7be49987ff0dc15868acf9ded769830cc157c64 (patch) | |
| tree | e5866706d4879c3f1b7aeee419325c4b83ac41cb | |
| parent | 3bbfcd5d598f0aa0f4d1f840f3ba7df4a74dbe5c (diff) | |
| download | rescached-b7be49987ff0dc15868acf9ded769830cc157c64.tar.xz | |
_www/doc: escape the links in the documentation
For link as an example or does not exist, escaped it from being rendered
into anchor.
| -rw-r--r-- | README | 9 | ||||
| -rw-r--r-- | _www/doc/resolver.adoc | 32 |
2 files changed, 21 insertions, 20 deletions
@@ -333,7 +333,7 @@ If the parent nameserver is using self-signed certificate, you can set "tls.allow_insecure" to true. Using the above configuration, rescached will serve DoH queries on -https://localhost/dns-query on port 443 and UDP queries on port 53. +\https://localhost/dns-query on port 443 and UDP queries on port 53. All queries to both locations will be forwarded to parent nameserver. This feature can be tested using Firefox Nightly by updating the configuration @@ -349,7 +349,7 @@ Since we are using `mode=3`, the `network.trr.bootstrapAddress` is required so Firefox Nightly can resolve "localhost" to "127.0.0.1". If you use the provided self-signed certificate, you must import and/or enable an exception for it manually in Firefox Nightly (for example. by opening -https://localhost/dns-query in new tab and accept security risk). +\https://localhost/dns-query in new tab and accept security risk). To check if DoH works, first, set the `debug` option to `1`, and restart the rescached. @@ -469,10 +469,9 @@ Link to submit the patches and discussion. == LICENSE Copyright 2018, M. Shulhan (ms@kilabit.info). -All rights reserved. -Use of this source code is governed by a GPL 3.0 license that can be found -in the COPYING file. +This software is licensed under GNU General Public License version 3.0 that +can be found in the COPYING file. == SEE ALSO diff --git a/_www/doc/resolver.adoc b/_www/doc/resolver.adoc index 6e7c18c..3530c24 100644 --- a/_www/doc/resolver.adoc +++ b/_www/doc/resolver.adoc @@ -50,10 +50,10 @@ The nameserver is defined in the following format, Examples, -* udp://194.233.68.184:53 for querying with UDP, -* tcp://194.233.68.184:53 for querying with TCP, -* https://194.233.68.184:853 for querying with DNS over TLS (DoT), and -* https://kilabit.info/dns-query for querying with DNS over HTTPS (DoH). +* \udp://194.233.68.184:53 for querying with UDP, +* \tcp://194.233.68.184:53 for querying with TCP, +* \https://194.233.68.184:853 for querying with DNS over TLS (DoT), and +* \https://kilabit.info/dns-query for querying with DNS over HTTPS (DoH). Default to one of "nameserver" in `/etc/resolv.conf`. -- @@ -66,7 +66,7 @@ The rescached-URL use HTTP scheme: ("http" / "https") "://" (domain / ip-address) [":" port] -Default to https://127.0.0.1:5380 if its empty. +Default to \https://127.0.0.1:5380 if its empty. -- == COMMANDS @@ -296,7 +296,7 @@ name server kilabit.info, $ resolver -ns=https://kilabit.info/dns-query query kilabit.info -Inspect the rescached's caches on server at http://127.0.0.1:5380, +Inspect the caches on server at \http://127.0.0.1:5380, $ resolver -server=http://127.0.0.1:5380 caches @@ -466,23 +466,25 @@ $ resolver zone.d rr delete my.zone www A IN 192.168.1.2 OK ---- -== AUTHOR -This software is developed by M. Shulhan (ms@kilabit.info). +== LINKS +https://git.sr.ht/~shulhan/rescached[Repository^]:: +Link to the source code. -== LICENSE +https://todo.sr.ht/~shulhan/rescached[Issues^]:: +List of open issues. -Copyright 2018, M. Shulhan (ms@kilabit.info). -All rights reserved. +https://lists.sr.ht/~shulhan/rescached[Patches^]:: +Link to submit the patches and discussion. -Use of this source code is governed by a GPL 3.0 license that can be -found in the COPYING file. +== LICENSE -== LINKS +Copyright 2018, M. Shulhan (ms@kilabit.info). -Source code repository: https://git.sr.ht/~shulhan/rescached +This software is licensed under GNU General Public License version 3.0 that +can be found in the COPYING file. == SEE ALSO |
