From 38f36179c3aa5bf5cf8049801bcdab9511ca65a9 Mon Sep 17 00:00:00 2001
From: Bob <bob@atreyu.stargazer-mountain.ts.net>
Date: Wed, 10 Jul 2024 21:27:40 -0700
Subject: [PATCH] add README

---
 README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 46 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1798398
--- /dev/null
+++ b/README.md
@@ -0,0 +1,46 @@
+Holesail-docker proxies traffic from another container.
+
+The easiest way to do this is to create a network in Docker:
+```
+docker network create proxy
+```
+
+You can then use the contaier name and port of the container you want to proxy, as exampled below.
+
+```
+---
+services:
+  holesail:
+    container_name: holesail
+    restart: unless-stopped
+    build: .
+    environment:
+      MODE: server      # defaults to client
+      PORT: 25565
+      HOST: minecraft   # defaults to 0.0.0.0
+      CONNECTOR: very-super-secret # leave this blank to generate a random secret.
+    networks:
+      - proxy
+
+  mc:
+    image: itzg/minecraft-server
+    container_name: minecraft
+    tty: true
+    stdin_open: true
+    restart: unless-stopped
+    ports:
+      - "25565:25565"
+    environment:
+      EULA: "TRUE"
+    volumes:
+      # attach the relative directory 'data' to the container's /data path
+      - ./data:/data
+    depends_on:
+      - holesail
+    networks:
+      - proxy
+
+networks:
+  proxy:
+    external: true 
+```