From d0608f6e3666e5c65b2af7eac2df246ee7b5a5c0 Mon Sep 17 00:00:00 2001 From: Quentin McGaw Date: Thu, 24 Sep 2020 22:02:44 -0400 Subject: [PATCH] HTTP control server section --- HTTP Control server/DNS over TLS.md | 7 +++++++ HTTP Control server/Openvpn.md | 15 +++++++++++++++ HTTP Control server/Setup.md | 5 +++++ Home.md | 1 + 4 files changed, 28 insertions(+) create mode 100644 HTTP Control server/DNS over TLS.md create mode 100644 HTTP Control server/Openvpn.md create mode 100644 HTTP Control server/Setup.md diff --git a/HTTP Control server/DNS over TLS.md b/HTTP Control server/DNS over TLS.md new file mode 100644 index 0000000..0cc65ef --- /dev/null +++ b/HTTP Control server/DNS over TLS.md @@ -0,0 +1,7 @@ +# DNS over TLS + +The HTTP control server allows to modify the state of Unbound, which is the subprocess responsible for DNS over TLS. + +## Restart + +Sending an HTTP GET request to `http://:8000/unbound/actions/restart` triggers a re-download of the DNS files (crypto and block lists) and restarts the unbound process diff --git a/HTTP Control server/Openvpn.md b/HTTP Control server/Openvpn.md new file mode 100644 index 0000000..5a772cd --- /dev/null +++ b/HTTP Control server/Openvpn.md @@ -0,0 +1,15 @@ +# OpenVPN + +The HTTP control server allows to modify the state of OpenVPN, which is the subprocess responsible for your VPN connection. + +## Restart + +Sending an HTTP GET request to `http://:8000/openvpn/actions/restart` restarts the OpenVPN process + +## Port forwarding + +Sending an HTTP GET request to `http://:8000/openvpn/portforwarded` returns the port forwarded in a JSON object, for example: + +```json +{"port":5914} +``` diff --git a/HTTP Control server/Setup.md b/HTTP Control server/Setup.md new file mode 100644 index 0000000..547ec67 --- /dev/null +++ b/HTTP Control server/Setup.md @@ -0,0 +1,5 @@ +# Setup + +A built-in HTTP server listens on port `8000` to modify the state of the container. + +To access it, simply map the ports for the container `-p 8000:8000/tcp` and set up `EXTRA_SUBNETS` accordingly. diff --git a/Home.md b/Home.md index feab37a..9284ebd 100644 --- a/Home.md +++ b/Home.md @@ -1,3 +1,4 @@ # Home +1. [HTTP Control server](HTTP-Control-server) 1. [Contributing](Contributing)