{"id":17624698,"url":"https://github.com/ryangibb/eon","last_synced_at":"2025-05-04T08:37:58.542Z","repository":{"id":138190104,"uuid":"595594215","full_name":"RyanGibb/eon","owner":"RyanGibb","description":"Effects-based OCaml Nameserver","archived":false,"fork":false,"pushed_at":"2025-04-23T12:38:38.000Z","size":5581,"stargazers_count":20,"open_issues_count":3,"forks_count":4,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-05-04T00:57:45.584Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"OCaml","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RyanGibb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-01-31T12:10:21.000Z","updated_at":"2025-04-23T12:38:42.000Z","dependencies_parsed_at":"2023-09-24T12:01:43.366Z","dependency_job_id":"ae9106f5-96dd-4a00-bdde-d1bd0f185c81","html_url":"https://github.com/RyanGibb/eon","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RyanGibb%2Feon","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RyanGibb%2Feon/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RyanGibb%2Feon/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RyanGibb%2Feon/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RyanGibb","download_url":"https://codeload.github.com/RyanGibb/eon/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252310887,"owners_count":21727511,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dns","dns-resolver","dns-server","nameserver"],"created_at":"2024-10-22T22:04:58.386Z","updated_at":"2025-05-04T08:37:58.523Z","avatar_url":"https://github.com/RyanGibb.png","language":"OCaml","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# Effects-based OCaml Nameserver (EON)\n\nEON is an authoritative nameserver for the Domain Name System (DNS) using the functionally pure [Mirage OCaml-DNS libraries](https://github.com/mirage/ocaml-dns) and [Effects-Based Parallel IO for multicore OCaml](https://github.com/ocaml-multicore/eio), along with some experimental uses of the DNS.\n\nRead more at [https://ryan.freumh.org/eon.html](https://ryan.freumh.org/eon.html).\n\n### Quick start\n\n```\n$ nix shell github:RyanGibb/eon\n$ sudo eon --zonefile \u003cfilepath\u003e\n```\n\nOr follow the instructions to manually [build from source](#building).\n\nFor help:\n```\n$ eon --help\n```\n\n### Building\n\n[Nix](https://nixos.org) can be used to build the project with:\n\n```\n$ git clone git@github.com:RyanGibb/eon.git\n$ cd eon\n$ nix build .\n```\n\nThe binary can then be found at `result/bin/eon`.\n\nNote that this is using [Nix flakes](https://nixos.org/manual/nix/stable/command-ref/new-cli/nix3-flake.html).\n\nAlternatively, opam and dune tooling can be used:\n```\n$ opam install .\n$ dune build\n```\n\nThe binary can then be found at `_build/default/src/eon.exe`.\n\n### Running\n\nOnce built, to run the project use:\n\n```\n$ ./eon --zonefile \u003cfilepath\u003e\n```\n\nFor example:\n```\n$ ./eon --zonefile examples/example.com\n```\n\nThe zonefile format is defined in [RFC1035 Section 5.1](https://datatracker.ietf.org/doc/html/rfc1035#section-5.1), but a minimal example is provided in [example.org](./example/example.org).\n\nNote root access may be required to bind to port 53.\n\nYou can then query your nameserver using the [BIND](https://www.isc.org/bind/) `dig` utility:\n```\n$ dig example.org @localhost +short\n203.0.113.0\n```\n\nThe command line argument `--log-level` can be used to specify a log verbosity e.g.:\n```\n$ ./eon --zonefile examples/example.com --log-level 2\n```\n\nTo operate as a recursive resolver:\n```\n$ ./eon --zonefile examples/example.com --resolver\n```\n\nWhich will additionally recursively look up records for domains it is not authoritative over.\nBe careful of [DNS amplification attacks](https://www.cloudflare.com/learning/ddos/dns-amplification-ddos-attack/).\n\n### Deployment\n\nA [NixOS module](https://nixos.org/manual/nixos/stable/index.html#sec-writing-modules) is provided that describes a systemd service and some configuration options. See [here](https://www.tweag.io/blog/2020-07-31-nixos-flakes/#adding-modules-from-third-party-flakes) for an example of adding a module from another flake to your NixOS configuration.\n\nIt's also possible to simply run this as a binary.\n\nYou'll need to configure your zonefile with an [NS](https://www.ietf.org/rfc/rfc1035.html#section-3.3.11) record, and set up a glue record with your registrar to point this domain to the IP that your nameserver is hosted on. See [example.org](./example/example.org) for an example NS record.\n\n### Development\n\nWhile it's possible to continuously rebuild the Nix derivation during development, this is quite slow due to isolated builds. A nice compromise is to use Nix to provide the dependencies but to use an un-sandboxed dune to build the project benefiting from caches and incremental builds.\n\nTo do this, use:\n```\nnix develop . -c dune build\n```\n\nDevelopment packages [https://github.com/ocaml/ocaml-lsp](ocaml-lsp) are also provided, so one can launch an editor with:\n```\nnix develop . -c \u003cyour-favourite-editor\u003e\n```\n\nAlternatively, opam tooling can be used to provide the development dependencies.\n\n### Documentation\n\nSee [./docs/](./docs/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fryangibb%2Feon","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fryangibb%2Feon","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fryangibb%2Feon/lists"}