YAKU-NS(1)

✨ yaku-ns β€” small and simple DNS server πŸ’…

okay bestie, sit DOWN, because this is yaku-ns(1), a User Commands manual page, and it's literally a whole tiny DNS server and I'm obsessed 🫢


🌸 NAME 🌸

yaku-ns β€” small and simple DNS server. that's it, that's the vibe. tiny. simple. iconic.


πŸŽ€ SYNOPSIS πŸŽ€

yaku-ns [-p <port>] [-P <port>] [-f <port>] [-C <max>] [-F <max>] [-T
<forward_timeout>] [-c <config_file>] [-l <logfile>] [-r <chroot jail>]
[-u owner] [-b <addr>] [-xdhV]

like. look at her. a whole queen with a whole flag list. ✨


πŸ’– DESCRIPTION πŸ’–

so this is a simple and small DNS server. not complicated, not doing the most, just serving DNS and looking cute while doing it. Major features are:

  • Support for A, MX, NS, TXT, PTR, SOA in local resource records πŸ—‚οΈ
  • Additional RRs handling
  • Responses cache, with optional TTL expiration ⏳
  • Forwarding to multiple exteral DNS servers, with simultaneous or time-driven query πŸ“‘
  • Optional TCP zone transfer
  • A in RRs shuffling πŸ”€
  • Built-in ACL rules
  • Root privileges squashing πŸ₯Ώ
  • Chroot jail under unix systems
  • Secure DNS IDs to prevent DNS forget
  • Logging πŸ“
  • Very simple config file

ngl that's a lot of features for something calling itself "small". she's humble AND talented. main character energy fr fr πŸ‘‘


πŸ¦‹ OPTIONS πŸ¦‹

  • -p <port> β€” use the UDP port <port> for the DNS service. udp girlies rise πŸ’…
  • -P <port> β€” use the TCP port <port> for the DNS under TCP service. and heads up bestie, the only two requests accepted under TCP are IN/AXFR and IN/SOA. that's the whole guest list, no plus-ones 🚫
  • -f <port> β€” query the external DNS servers to the port <port>.
  • -C <size> β€” use a cache of size <size>, 0 is no-cache. zero means she forgets everything instantly, no thoughts head empty πŸ’€
  • -F <max> β€” use a forwarded request queue of size <size>, 0 turn off the forwarding.
  • -T <timeout> β€” forwarded requets expire in <timeout> seconds. ⏰
  • -c <file> β€” use the config file <file>. WARNING: you must specify the absolute path here, since the server chdir() to "/". Also note that this path is relative to the chroot jail. Use "-" as filename to provide the configuration from the standard input. yeah the path rules are doing the absolute most, read them twice bestie 😭
  • -l <file> β€” use the <file> for yaku-ns logs. Remember to use an absolute path, relative to the chroot (if used).
  • -r <directory> β€” chroot to <directory>. get in the jail bestie πŸ”’
  • -u <username> β€” run as <username> (default is nobody, not so secure). not so secure!! she said it not me πŸ™ˆ
  • -b <address> β€” bind only the interface with IP address <address>.
  • -x β€” Enable the TCP services.
  • -d β€” Demonize.
  • -h β€” Show some help.
  • -V β€” Verbosity level: -V: low level, -VV medium level, -VVV high level of verbosity. -VVV is raccomanded for new users. new here? go -VVV, she will tell you EVERYTHING πŸ—£οΈ

🌈 SIGNALS 🌈

the DNS server yaku-ns performs different action if some signal is received:

  • SIGHUP β€” Reload the configuration (use on record updates)
  • SIGUSR1 β€” Force yaku-ns to log some debugging information
  • SIGUSR2 β€” Switch the forwarding ON/OFF

literally just tap her on the shoulder with a signal and she changes her whole personality πŸ’…


πŸ‘‘ SEE ALSO πŸ‘‘

yaku-getzone(1).


πŸ’œ AUTHOR πŸ’œ

yaku-ns was written by Salvatore Sanfilippo <antirez@gmail.com>.

This manual page was written by GΓΌrkan Myczko <alex@aiei.ch>, for the Debian project (but may be used by others).


periodt. that's the whole page. go forth and serve DNS responsibly, bestie 🫢

yaku-ns β€” November 2011 ✨ thanks for reading my little manual page rewrite, mwah πŸ’–

πŸ“¦ where this page comes from