Merge HTTP control server documents together

Quentin McGaw
2020-12-30 22:43:20 -05:00
parent bc6e19579f
commit d8f7257aa0
5 changed files with 22 additions and 27 deletions
-5
@@ -1,5 +0,0 @@
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://<your-docker-host-ip>:8000/unbound/actions/restart` triggers a re-download of the DNS files (crypto and block lists) and restarts the unbound process
-13
@@ -1,13 +0,0 @@
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://<your-docker-host-ip>:8000/openvpn/actions/restart` restarts the OpenVPN process
## Port forwarding
Sending an HTTP GET request to `http://<your-docker-host-ip>:8000/openvpn/portforwarded` returns the port forwarded in a JSON object, for example:
```json
{"port":5914}
```
+22 -3
@@ -1,5 +1,24 @@
The HTTP control server allows to obtain and modify the state of the container without restarting it.
- [Setup](Setup-the-HTTP-control-server)
- [OpenVPN Control](Control-Openvpn)
- [DNS over TLS Control](Control-DNS-over-TLS)
## Setup
A built-in HTTP server listens on port `8000` to modify the state of the container.
To access it, simply publish this port for the container, for example: `-p 8000:8000/tcp`.
## OpenVPN
The HTTP control server allows to modify the state of OpenVPN, which is the subprocess responsible for your VPN connection.
- Sending an HTTP GET request to `http://<your-docker-host-ip>:8000/openvpn/actions/restart` restarts the OpenVPN process
- Sending an HTTP GET request to `http://<your-docker-host-ip>:8000/openvpn/portforwarded` returns the port forwarded in a JSON object, for example:
```json
{"port":5914}
```
## DNS
The HTTP control server allows to modify the state of Unbound, which is the subprocess responsible for DNS over TLS.
- Sending an HTTP GET request to `http://<your-docker-host-ip>:8000/unbound/actions/restart` triggers a re-download of the DNS files (crypto and block lists) and restarts the unbound process
@@ -1,3 +0,0 @@
A built-in HTTP server listens on port `8000` to modify the state of the container.
To access it, simply publish this port for the container, for example: `-p 8000:8000/tcp`.
-3
@@ -12,9 +12,6 @@
- [Portainer](Portainer)
- [Mullvad](Mullvad)
- [HTTP Control server](HTTP-Control-server)
- [Control Openvpn](Control-Openvpn)
- [Control DNS over TLS](Control-DNS-over-TLS)
- [Setup the HTTP control server](Setup-the-HTTP-control-server)
- Servers
- [Cyberghost Servers](Cyberghost-Servers)
- [Surfshark Servers](Surfshark-Servers)