]> git.ipfire.org Git - thirdparty/knot-resolver.git/commitdiff
update README.md
authorVladimír Čunát <vladimir.cunat@nic.cz>
Mon, 5 Feb 2018 15:13:55 +0000 (16:13 +0100)
committerVladimír Čunát <vladimir.cunat@nic.cz>
Mon, 5 Feb 2018 15:13:55 +0000 (16:13 +0100)
- no need to have gitter twice
- update information about modules (one cache, no alternative backends)
- add EPEL 7
- add mailing-list
- link to stable docs instead of latest master

README.md

index 327e23ed2394598f069dc6557734055b6ddb39f5..5bc515eeb5a2727aa45aefab0aa47166a7e6546f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -4,15 +4,13 @@
 [![Coverage Status](https://gitlab.labs.nic.cz/knot/knot-resolver/badges/master/coverage.svg?x)](https://knot.pages.labs.nic.cz/knot-resolver/)
 [![Coverity](https://img.shields.io/coverity/scan/3912.svg)](https://scan.coverity.com/projects/3912)
 [![Documentation Status](https://readthedocs.org/projects/knot-resolver/badge/?version=latest)](https://readthedocs.org/projects/knot-resolver/?badge=latest)
-[![Join the chat at gitter.im/CZ-NIC/knot-resolver](https://badges.gitter.im/Join%20Chat.svg?x)](https://gitter.im/CZ-NIC/knot-resolver?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-
 
 Knot DNS Resolver is a caching full resolver implementation written in C and [LuaJIT][luajit], both a resolver library and a daemon. The core architecture is tiny and efficient, and provides a foundation and
-a state-machine like API for extensions. There are four of those built-in - *iterator*, *validator* and two caching modules. Most of the [rich features](https://knot-resolver.readthedocs.io/en/latest/modules.html) are written in Lua(JIT) and C. Batteries are included, but optional.
+a state-machine like API for extensions. There are three modules built-in - *iterator*, *validator*, *cache*, and a few more are loaded by default. Most of the [rich features](https://knot-resolver.readthedocs.io/en/latest/modules.html) are written in Lua(JIT) and C. Batteries are included, but optional.
 
 The LuaJIT modules, support DNS privacy and DNSSEC, and persistent cache with low memory footprint make it a great personal DNS resolver or a research tool to tap into DNS data. TL;DR it's the [OpenResty][openresty] of DNS.
 
-Several cache backends (LMDB, Redis and Memcached), strong filtering rules, and auto-configuration with etcd make it a great large-scale resolver solution.
+Strong filtering rules, and auto-configuration with etcd make it a great large-scale resolver solution.
 
 The server adopts a [different scaling strategy][scaling] than the rest of the DNS recursors - no threading, shared-nothing architecture (except MVCC cache that may be shared) that allows you to pin instances on available CPU cores and grow by self-replication. You can start and stop additional nodes depending on the contention without downtime.
 
@@ -24,12 +22,13 @@ Knot Resolver is packaged for
 [Debian](https://packages.debian.org/sid/knot-resolver),
 [Fedora](https://apps.fedoraproject.org/packages/knot-resolver/),
 [Ubuntu](https://packages.ubuntu.com/zesty/knot-resolver),
+[EPEL 7](https://download.fedoraproject.org/pub/epel/7/SRPMS/Packages/k/) (for RHEL 7 or CentOS 7),
 [Homebrew](https://github.com/Homebrew/homebrew-core/blob/master/Formula/knot-resolver.rb) and
 [NixOS/Nixpkgs](https://hydra.nixos.org/search?query=knot-resolver).
 You can also find it as the default DNS resolver in our open-source router [Turris Omnia](https://omnia.turris.cz).
 See the [Knot-resolver homepage](https://www.knot-resolver.cz/download/) for more information.
 
-<!-- [openSUSE](https://build.opensuse.org/package/show/server:dns/knot-resolver), (it seems to be in a bad shape) -->
+<!-- [openSUSE](https://software.opensuse.org/package/knot-resolver), (it seems to be in a bad shape; vulnerable 1.3.2 ATM) -->
 
 ### Building from sources
 
@@ -56,9 +55,9 @@ $ kresd
 
 See the documentation at [knot-resolver.readthedocs.io][doc] for more options.
 
-[depends]: https://knot-resolver.readthedocs.io/en/latest/build.html
-[doc]: https://knot-resolver.readthedocs.io/en/latest/index.html
-[scaling]: https://knot-resolver.readthedocs.io/en/latest/daemon.html#scaling-out
+[depends]: https://knot-resolver.readthedocs.io/en/stable/build.html
+[doc]: https://knot-resolver.readthedocs.io/en/stable/index.html
+[scaling]: https://knot-resolver.readthedocs.io/en/stable/daemon.html#scaling-out
 [deckard]: https://gitlab.labs.nic.cz/knot/deckard
 [luajit]: https://luajit.org/
 [libuv]: http://libuv.org
@@ -66,4 +65,7 @@ See the documentation at [knot-resolver.readthedocs.io][doc] for more options.
 
 ### Contacting us
 
-[![Join the chat at https://gitter.im/CZ-NIC/knot-resolver](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/CZ-NIC/knot-resolver?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+- [GitLab issues](https://gitlab.labs.nic.cz/knot/knot-resolver/issues) (you may authenticate via GitHub)
+- [mailing list](https://lists.nic.cz/cgi-bin/mailman/listinfo/knot-resolver-users)
+- [![Join the chat at https://gitter.im/CZ-NIC/knot-resolver](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/CZ-NIC/knot-resolver?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+