update README

Author: CodeShellDev

.github/templates/README.template.md

@@ -31,15 +31,44 @@ Let's use jellyfin for example
 { { file.examples/jellyfin.yaml } }
 ```
 
-## Usage
+### Configuration
 
-Use a Reverse Proxy to redirect you from a service `https://jellyfin.mydomain.com` on another machine to `https://wol-red.mydomain.com`,
-WoL Redirect will use the `config.json` to get the host of the requested service.
+```json
+{ { file.examples/config/mapping.json } }
+```
+
+#### PVE (VMs + LXCs)
+
+If you are trying to wakeup a host running PVE, you will probably want to wakeup LXCs or VMs too.
+Sadly LXCs (and VMs) don't have `Wake-on-LAN` functionalities.
+For that you will need (WoL PVE)[https://github.com/codeshelldev/wol-pve]
+
+```json
+{ { file.examples/config/mapping-pve.json } }
+```
+
+#### Docker
+
+If you are running docker on your resource-hungry server, you might want to start docker-containers only if needed.
+For this to work you will need (WoL Dockerized)[https://github.com/codeshelldev/wol-dockerized]
+
+```json
+{ { file.examples/config/mapping-docker.json } }
+```
+
+#### Or both
 
 ```json
-{ { file.config/mapping.json } }
+{ { file.examples/config/mapping-pve-docker.json } }
 ```
 
+_You will need both (WoL PVE)[https://github.com/codeshelldev/wol-pve] and (WoL Dockerized)[https://github.com/codeshelldev/wol-dockerized]_
+
+## Usage
+
+Use a Reverse Proxy to redirect you from a service `https://jellyfin.mydomain.com` on another machine to `https://wol-red.mydomain.com`,
+WoL Redirect will use the `config.json` to get the host of the requested service.
+
 ## Contributing
 
 ## License

examples/config/mapping-docker.json

@@ -0,0 +1,21 @@
+{
+	"hosts": {
+		"docker-server": {
+			"ip": "192.168.1.1",
+			"mac": "XX:XX:XX:XX:XX:XX",
+			"startupTime": 10
+		}
+	},
+	"routes": {
+		"docker": {
+			"route": ["docker-server"],
+			"attributes": {
+				"wakeDocker": true
+			}
+		}
+	},
+	"records": {
+		"jellyfin.mydomain.com": "docker",
+		"*.mydomain.com": "docker"
+	}
+}

config/mapping.json examples/config/mapping-pve-docker.jsonconfig/mapping.json renamed to examples/config/mapping-pve-docker.json

@@ -1,33 +1,33 @@
-{
-	"hosts": {
-		"pve": {
-			"ip": "192.168.1.1",
-			"mac": "XX:XX:XX:XX",
-			"startupTime": 40
-		},
-		"lxc": {
-			"ip": "192.168.1.1",
-			"id": "100",
-			"startupTime": 10,
-			"isVirtual": true
-		},
-		"ubuntu-vm": {
-			"ip": "192.168.1.1",
-			"id": "100",
-			"startupTime": 10,
-			"isVirtual": true
-		}
-	},
-	"routes": {
-		"pve-lxc": {
-			"route": ["pve", "lxc"],
-			"attributes": {
-				"wakeDocker": true
-			}
-		}
-	},
-	"records": {
-		"jellyfin.mydomain.com": "pve-lxc",
-		"*.mydomain.com": "pve-lxc"
-	}
-}
+{
+	"hosts": {
+		"pve": {
+			"ip": "192.168.1.1",
+			"mac": "XX:XX:XX:XX:XX:XX",
+			"startupTime": 40
+		},
+		"lxc": {
+			"ip": "192.168.1.1",
+			"id": "100",
+			"startupTime": 10,
+			"isVirtual": true
+		},
+		"ubuntu-vm": {
+			"ip": "192.168.1.1",
+			"id": "100",
+			"startupTime": 10,
+			"isVirtual": true
+		}
+	},
+	"routes": {
+		"pve-lxc": {
+			"route": ["pve", "lxc"],
+			"attributes": {
+				"wakeDocker": true
+			}
+		}
+	},
+	"records": {
+		"jellyfin.mydomain.com": "pve-lxc",
+		"*.mydomain.com": "pve-lxc"
+	}
+}

examples/config/mapping-pve.json

@@ -0,0 +1,29 @@
+{
+	"hosts": {
+		"pve": {
+			"ip": "192.168.1.1",
+			"mac": "XX:XX:XX:XX:XX:XX",
+			"startupTime": 40
+		},
+		"lxc": {
+			"ip": "192.168.1.1",
+			"id": "100",
+			"startupTime": 10,
+			"isVirtual": true
+		},
+		"ubuntu-vm": {
+			"ip": "192.168.1.1",
+			"id": "100",
+			"startupTime": 10,
+			"isVirtual": true
+		}
+	},
+	"routes": {
+		"pve-lxc": {
+			"route": ["pve", "lxc"]
+		}
+	},
+	"records": {
+		"*.mydomain.com": "pve-lxc"
+	}
+}

examples/config/mapping.json

@@ -0,0 +1,17 @@
+{
+	"hosts": {
+		"server-1": {
+			"ip": "192.168.1.1",
+			"mac": "XX:XX:XX:XX:XX:XX",
+			"startupTime": 40
+		}
+	},
+	"routes": {
+		"server-1": {
+			"route": ["server-1"]
+		}
+	},
+	"records": {
+		"*.mydomain.com": "server-1"
+	}
+}