From 9cc0416e25c677055c22255843b18a8cc015f786 Mon Sep 17 00:00:00 2001 From: anaxios Date: Fri, 12 Jul 2024 18:21:52 -0700 Subject: [PATCH] Update README.md add headers and stuff. --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7831de1..681ae4c 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,8 @@ -Holesail-docker proxies traffic from another container. +# Holesail-docker + +> ⚠️ **Warning!** Some of these features are untested. + +Holesail-docker proxies traffic from or to other containers. Clone this repo then from within the directory run: ``` @@ -9,6 +13,7 @@ The easiest way to do this is to create a network in Docker: ``` docker network create proxy ``` +## Server mode You can then use the contaier name and port of the container you want to proxy, as exampled below. @@ -49,6 +54,7 @@ networks: external: true ``` +## Client Mode Client mode is untested! @@ -68,6 +74,8 @@ services: "host" network mode only works with linux. Windows and Mac are incompatible. +## Filemanager Mode + ``` services: holesail: