From fbe9bc96ccc5d6f824b177c216fd137627615c79 Mon Sep 17 00:00:00 2001 From: Laurent Bercot Date: Wed, 20 Dec 2023 23:33:53 +0000 Subject: Update doc and deps Signed-off-by: Laurent Bercot --- INSTALL | 4 ++-- doc/index.html | 26 +++++++++++++++++--------- doc/shibari-server-tcp.html | 6 ++++++ doc/shibari-server-udp.html | 6 ++++++ 4 files changed, 31 insertions(+), 11 deletions(-) diff --git a/INSTALL b/INSTALL index 00468b0..6776259 100644 --- a/INSTALL +++ b/INSTALL @@ -7,8 +7,8 @@ Build Instructions - A POSIX-compliant C development environment - GNU make version 3.81 or later - skalibs version 2.14.1.0 or later: https://skarnet.org/software/skalibs/ - - s6 version 2.12.0.2 or later: https://skarnet.org/software/s6/ - - for now: s6-dns version 2.3.7.0 or later: https://skarnet.org/software/s6-dns/ + - s6 version 2.12.0.3 or later: https://skarnet.org/software/s6/ + - for now: s6-dns version 2.3.7.1 or later: https://skarnet.org/software/s6-dns/ This software will run on any operating system that implements POSIX.1-2008, available at: 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.

- 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 +s6-dns 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).

Why "shibari"?

- 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.

@@ -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.
  • s6 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 shibari-server-udp.
  • (for now) s6-dns 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.
    • @@ -70,8 +75,7 @@ requirement if you link against the shared version of the s6-dns library.

    Download

    +
    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.

    +

    + The goal of shibari-server-tcp is, at the moment, to be a drop-in replacement +for the axfrdns program, while +following the DNS specifications more closely and being more maintainable. +

    +

    Interface

    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.

    +

    + The goal of shibari-server-udp, at the moment, is to be a drop-in replacement +for the tinydns program, +while being more maintainable. +

    +

    Interface

    -- cgit v1.2.3