\n Javascript library for DNS over HTTPS lookups in web apps\n
\n\n[](https://badge.fury.io/js/dohjs)\n\n\n---\n\n**Try sending DoH lookups from your browser - [https://dohjs.org](https://dohjs.org)**\n\n# Contents\n\n- [Why DoHjs](#why-dohjs)\n - [Features](#features)\n- [Installation](#installation)\n- [Quickstart](#quickstart)\n- [Examples](#examples)\n- [Docs](#docs)\n- [Tests](#tests)\n- [Web interface](#web-interface)\n- [CORS Issues](#cors-issues)\n- [License](#license)\n\n# Why dohjs\n\nThe purpose of dohjs is described well in the Internet standard document for DNS over HTTPS ([RFC 8484](https://tools.ietf.org/html/rfc8484)):\n\n> allowing web applications to access DNS information via existing browser APIs in a safe way consistent with Cross Origin Resource Sharing (CORS)\n\n## Features\n\n- Fully compliant DNS over HTTPS client implementation\n- Supports GET and POST wireformat queries\n- Command line DNS over HTTPS lookup tool\n- [Web interface](https://dohjs.org) to try dohjs\n- CORS proxy to get past CORS errors associated with DoH ([source code here](https://github.com/byu-imaal/dohjs/blob/gh-pages/cors_proxy.js)). This is mainly for use on [https://dohjs.org](https://dohjs.org).\n\n# Installation\n\nIf you're not using npm, you can skip to [quickstart](#quickstart).\n\n```bash\nnpm install dohjs\n```\n\nIf you want to just use the command line tool `dohjs` to issue DoH lookups, install it globally (or use [npx](https://github.com/npm/npx)):\n```bash\nnpm install -g dohjs\n```\n\n*NOTE: The above command may need to be run as root ([how to fix this](https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally))*\n\n# Quickstart\n\nA simple way to start is to include doh.js in your HTML file. You can include it from [jsdelivr](https://www.jsdelivr.com/) or your local installation.\n\n```html\n\n\n\n\n```\n\nIf your project is mostly nodejs-style (e.g. you're using [browserify](https://github.com/browserify/browserify)),\nyou can `require()` dohjs like so:\n```javascript\nconst doh = require('dohjs');\n```\n\nNow here's a quick example of a DoH lookup using dohjs:\n\n```javascript\n// create your stub resolver\nconst resolver = new doh.DohResolver('https://1.1.1.1/dns-query');\n\n// lookup the A records for example.com and log the IP addresses to the console\nresolver.query('example.com', 'A')\n .then(response => {\n response.answers.forEach(ans => console.log(ans.data));\n })\n .catch(err => console.error(err));\n```\n\n# Examples\n\nCheckout our [examples](examples) to see dohjs in action.\nSee [examples/README](examples/README.md) for a description of the examples.\n\nTo serve thr examples, run `npm start`. \nYour browser will open up to an index of your current directory, then just navigate to the examples and open whatever html file you were wanting to look at.\n\n# Docs\n\nAPI documentation for dohjs can be found in [docs/README.md](docs/README.md).\n\nDocumentation for the dohjs CLI is in [docs/cli.md](docs/cli.md).\n\n# Contributing\n\nWe love contributors!\n\nIf you find a bug in dohjs, or you have a feature you'd like added, please open an issue and/or submit a pull request.\n\n# Tests\n\nTo run tests, clone the repo, and run:\n```bash\nnpm test\n```\n\n# Web interface\nThe web interface is available at [https://dohjs.org](https://dohjs.org).\n\nSee the `gh-pages` branch for code.\n\n# CORS issues\n\nYou'll probably get some CORS errors when sending DoH queries. A few ways to get around those are:\n\n- Use a CORS proxy. At [dohjs.org](https://dohjs.org), there is an option to use a CORS proxy if you want to try it out.\n- Disable CORS when you launch your browser sometimes works (e.g. `google-chrome --user-data-dir=/tmp/asdf --disable-web-security`)\n- Run your own DoH server that sets the Access-Control-Allow-Origin header appropriately (e.g. `Access-Control-Allow-Origin: *` to allow everyone)\n\n# License\nGPLv3 (see [LICENSE](./LICENSE))\n","readmeFilename":"README.md"}
![\"DoHjs\"](\"https://dohjs.org/dohjs.png\")
\n \n