summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLaurent Bercot <ska-skaware@skarnet.org>2023-12-20 23:33:53 +0000
committerLaurent Bercot <ska@appnovation.com>2023-12-20 23:33:53 +0000
commitfbe9bc96ccc5d6f824b177c216fd137627615c79 (patch)
tree9e7225a16fb591bccd470e4ff6192c3e13de8f21 /doc
parent8f525220efdc796133f67b4bccc70583141e6396 (diff)
downloadshibari-fbe9bc96ccc5d6f824b177c216fd137627615c79.tar.xz
Update doc and deps
Signed-off-by: Laurent Bercot <ska@appnovation.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/index.html26
-rw-r--r--doc/shibari-server-tcp.html6
-rw-r--r--doc/shibari-server-udp.html6
3 files changed, 29 insertions, 9 deletions
diff --git a/doc/index.html b/doc/index.html
index be2cc5a..22a4ee7 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -26,16 +26,21 @@ programs.
</p>
<p>
- It was previously named s6-dns. The name of the project was changed to
-avoid confusion; despite being written by the same author and with the
-same mindset, it is not part of the s6 project.
+ It is an ongoing project; at the moment, only a DNS server is
+provided (one program to serve over TCP, another to serve over UDP).
+Currently, it relies on the
+<a href="//skarnet.org/software/s6-dns/">s6-dns</a> library, but it
+aims to integrate it over time, and eventually completely replace
+s6-dns (which is a badly named software collection, because despite
+being written by the same author and with the same mindset, it is not
+part of the s6 project).
</p>
<h3> Why "shibari"? </h3>
<p>
- There's a de facto tradition that DNS software has a name related to
-binding. shibari aims to be the most pleasant of all DNS software.
+ There's a de facto tradition that DNS software should have a name
+related to binding. shibari is the most pleasant of them.
</p>
<hr />
@@ -51,12 +56,12 @@ binding. shibari aims to be the most pleasant of all DNS software.
2.14.1.0 or later. It's a build-time requirement. It's also a run-time
requirement if you link against the shared version of the skalibs library. </li>
<li> <a href="//skarnet.org/software/s6/">s6</a> version
-2.12.0.2 or later. It's a build-time requirement. It's also a run-time
+2.12.0.3 or later. It's a build-time requirement. It's also a run-time
requirement if you link against the shared version of the s6 library. That
library is used for the access control and client location features in
<a href="shibari-server-udp.html">shibari-server-udp</a>. </li>
<li> (for now) <a href="//skarnet.org/software/s6-dns/">s6-dns</a> version
-2.3.7.0 or later. It's a build-time requirement. It's also a run-time
+2.3.7.1 or later. It's a build-time requirement. It's also a run-time
requirement if you link against the shared version of the s6-dns library. </li>
</ul>
@@ -70,8 +75,7 @@ requirement if you link against the shared version of the s6-dns library. </li>
<h3> Download </h3>
<ul>
- <li> The current released version of shibari is <a href="shibari-0.0.1.0.tar.gz">0.0.1.0</a>.
-(That is a lie. shibari is currently unreleased, so that link does not work.) </li>
+ <li> The current released version of shibari is <a href="shibari-0.0.1.0.tar.gz">0.0.1.0</a>. </li>
<li> You can checkout a copy of the
<a href="//git.skarnet.org/cgi-bin/cgit.cgi/shibari/">shibari
git repository</a>:
@@ -108,6 +112,7 @@ commands exit 0 on success. Other exit codes are documented in the
relevant page.
</p>
+<!--
<h4> Command-line DNS clients programs </h4>
<ul>
@@ -117,6 +122,7 @@ relevant page.
<ul>
</ul>
+-->
<h4> Servers </h4>
@@ -125,6 +131,7 @@ relevant page.
<li> The <a href="shibari-server-udp.html">shibari-server-udp</a> program </li>
</ul>
+<!--
<h4> Filtering tools </h4>
<ul>
@@ -153,6 +160,7 @@ relevant page.
<ul>
</ul>
+-->
<hr />
diff --git a/doc/shibari-server-tcp.html b/doc/shibari-server-tcp.html
index 42808fa..9e4571f 100644
--- a/doc/shibari-server-tcp.html
+++ b/doc/shibari-server-tcp.html
@@ -23,6 +23,12 @@
on its standard output.
</p>
+<p>
+ The goal of shibari-server-tcp is, at the moment, to be a drop-in replacement
+for the <a href="https://cr.yp.to/djbdns/axfrdns.html">axfrdns</a> program, while
+following the DNS specifications more closely and being more maintainable.
+</p>
+
<div id="interface">
<h2> Interface </h2>
</div>
diff --git a/doc/shibari-server-udp.html b/doc/shibari-server-udp.html
index a3395ba..b1afaec 100644
--- a/doc/shibari-server-udp.html
+++ b/doc/shibari-server-udp.html
@@ -23,6 +23,12 @@
answers DNS queries it receives, until it is killed.
</p>
+<p>
+ The goal of shibari-server-udp, at the moment, is to be a drop-in replacement
+for the <a href="https://cr.yp.to/djbdns/tinydns.html">tinydns</a> program,
+while being more maintainable.
+</p>
+
<div id="interface">
<h2> Interface </h2>
</div>