API¶
This part of the documentation covers the CLI interface and is autogenerated by sphinx-click extension.
dothdns¶
Handle your DoTH-DNS system
dothdns [OPTIONS] COMMAND [ARGS]...
Options
-
--version¶ Show the version and exit.
-
-h,--help¶ Show this message and exit.
config¶
Edit or create DoTH-DNS configuration
dothdns config [OPTIONS]
Options
-
--fresh¶ Discard current .env file and write new file.
-
-n,--traefik-auth,-N,--traefik-no-auth¶ Activate authentication for traefik dashboard when .htpasswd file is present. [default: True]
-
--traefik-network<traefik_network>¶ Docker network to use for internal communication. Defaults to predefined network. Only change if you know what you do.
-
-a,--architecture<architecture>¶ ARCHITECTURE of the system’s processor. [case-insensitive]
- Options
x86 | arm
-
-i,--host-ip<host_ip>¶ HOST_IP address used by the system by default.
-
-H,--hostname<hostname>¶ The system’s HOST_NAME.
-
-t,--timezone<timezone>¶ TIMEZONE of the system in ‘olson’ format. See docs for more info.
-
-d,--domain<domain>¶ DOMAIN for dashboards, DoH and DoT (SNI). Defaults to [HOSTNAME.dns] and falls back to [doth.dns] if not HOST_NAME is found or given.
-
-h,--help¶ Show this message and exit.
Environment variables
-
TRAEFIK_AUTH Provide a default for
-n
-
TRAEFIK_NETWORK Provide a default for
--traefik-network
-
ARCHITECTURE Provide a default for
-a
-
HOST_IP Provide a default for
-i
-
HOST_NAME Provide a default for
-H
-
TIMEZONE Provide a default for
-t
-
DOMAIN Provide a default for
-d
down¶
Shut down DoTH-DNS container
dothdns down [OPTIONS]
Options
-
-c,--container-name<container_name>¶ Shut down given container. Can be set multiple times. [case-sensitive]
- Options
traefik | doh_server | pihole | unbound
-
-r,--remove¶ Remove container after shutdown.
-
-f,--force¶ Force container shutdown and removal if ‘-r’ flag is set.
-
-h,--help¶ Show this message and exit.
images¶
Handle DoTH-DNS docker images
dothdns images [OPTIONS]
Options
-
-c,--recompile¶ Force recompiling ‘cielquan/doh_server’ docker image.
-
-u,--update<update>¶ Update given image. Can be set multiple times. [case-sensitive]
- Options
traefik | doh_server | pihole | unbound
-
-U,--update-all¶ Update all images if updates are available.
-
-h,--help¶ Show this message and exit.
init¶
Create DoTH-DNS configuration directory
dothdns init [OPTIONS]
Options
-
-c,--only-create¶ Only create config dir if not already existing.
-
-f,--overwrite¶ Overwrite existing config dir, additional files are not touched. Only supported with python >= 3.8.
-
-F,--fresh¶ Overwrite existing config dir totally. No files will be kept.
-
-h,--help¶ Show this message and exit.
run¶
Start DoTH-DNS docker container
dothdns run [OPTIONS]
Options
-
--proxy,--no-proxy¶ If predefined instance of traefik should be used as reverse proxy. [default: True]
-
-h,--help¶ Show this message and exit.
Environment variables
-
PROXY Provide a default for
--proxy
update¶
Update DoTH-DNS container
dothdns update [OPTIONS]
Options
-
-c,--container-name<container_name>¶ Shut down given container. Can be set multiple times. [case-sensitive]
- Options
traefik | doh_server | pihole | unbound
-
--proxy,--no-proxy¶ If predefined instance of traefik should be used as reverse proxy. [default: True]
-
-h,--help¶ Show this message and exit.
Environment variables
-
PROXY Provide a default for
--proxy