fergalmoran/DnsServer
1
0
Fork 0
mirror of https://github.com/fergalmoran/DnsServer.git synced 2025-12-22 09:29:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

updated api docs.

Browse Source
This commit is contained in:
Shreyas Zare
2021-10-16 15:05:48 +05:30
parent 78f5d03ef1
commit d9c1590f75
1 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
APIDOCS.md
View File

@@ -151,7 +151,7 @@ RESPONSE:
``` ```
{ {
"response": { "response": {
"version": "7.0", "version": "7.1",
"dnsServerDomain": "server1", "dnsServerDomain": "server1",
"dnsServerLocalEndPoints": [ "dnsServerLocalEndPoints": [
"0.0.0.0:53", "0.0.0.0:53",
@@ -165,6 +165,7 @@ RESPONSE:
"webServiceEnableTls": false, "webServiceEnableTls": false,
"webServiceHttpToTlsRedirect": false, "webServiceHttpToTlsRedirect": false,
"webServiceTlsPort": 53443, "webServiceTlsPort": 53443,
"webServiceUseSelfSignedTlsCertificate": false,
"webServiceTlsCertificatePath": null, "webServiceTlsCertificatePath": null,
"webServiceTlsCertificatePassword": "************", "webServiceTlsCertificatePassword": "************",
"enableDnsOverHttp": false, "enableDnsOverHttp": false,
@@ -258,6 +259,7 @@ WHERE:
- `webServiceHttpPort` (optional): Specify the TCP port number for the web console and this API web service. Default value is `5380`. - `webServiceHttpPort` (optional): Specify the TCP port number for the web console and this API web service. Default value is `5380`.
- `webServiceEnableTls` (optional): Set this to `true` to start the HTTPS service to acccess web service. - `webServiceEnableTls` (optional): Set this to `true` to start the HTTPS service to acccess web service.
- `webServiceTlsPort` (optional): Specified the TCP port number for the web console for HTTPS access. - `webServiceTlsPort` (optional): Specified the TCP port number for the web console for HTTPS access.
- `webServiceUseSelfSignedTlsCertificate` (optional): Set `true` for the web service to use an automatically generated self signed certificate when TLS certificate path is not specified.
- `webServiceTlsCertificatePath` (optional): Specify a PKCS #12 certificate (.pfx) file path on the server. The certificate must contain private key. This certificate is used by the web console for HTTPS access. - `webServiceTlsCertificatePath` (optional): Specify a PKCS #12 certificate (.pfx) file path on the server. The certificate must contain private key. This certificate is used by the web console for HTTPS access.
- `webServiceTlsCertificatePassword` (optional): Enter the certificate (.pfx) password, if any. - `webServiceTlsCertificatePassword` (optional): Enter the certificate (.pfx) password, if any.
- `enableDnsOverHttp` (optional): Enable this option to accept DNS-over-HTTP requests for both wire and json response formats. It must be used with a TLS terminating reverse proxy like nginx and will work only on private networks. - `enableDnsOverHttp` (optional): Enable this option to accept DNS-over-HTTP requests for both wire and json response formats. It must be used with a TLS terminating reverse proxy like nginx and will work only on private networks.