Add Docker setup and image to README

Included a Dockerfile and docker-compose.yml for setting up the Jerusalem Tunnel service. Also added an image to the README for better visualization.
mjm918 · Aug 15, 2024 · c10d1b2 · c10d1b2
1 parent dfe1fa2
commit c10d1b2
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 1 deletion.
diff --git a/.assets/ss.png b/.assets/ss.png
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,10 @@
+FROM golang:1.22
+LABEL authors="julfikar"
+
+WORKDIR /app
+COPY . .
+
+RUN go build -o jerusalem-tunnel -v ./...
+ENTRYPOINT ["./jerusalem-tunnel"]
+
+EXPOSE 1024-65535
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 Jerusalem Tunnel is a cross-platform `ngrok` alternative written in Go. It allows clients to reserve a port and complete
 a handshake using a secret key shared between the server and the client, identified uniquely by a clientID.
-
+![ss.png](.assets/ss.png)
 ## Features
 
 - **Cross-Platform**: Works on Windows, macOS, and Linux.

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -0,0 +1,14 @@
+version: '3.8'
+
+services:
+ jerusalem-tunnel:
+ build: .
+ ports:
+ - "1024-2000:1024-2000"
+ - "8901:8901"
+ environment:
+ - SERVER_PORT=8901
+ - PORT_RANGE=1024...2000
+ - SECRET_KEY=2y6sUp8cBSfNDk7Jq5uLm0xHAIOb9ZGqE4hR1WVXtCwKjP3dYzvTn2QiFXe8rMb6
+ entrypoint: [ "./jerusalem-tunnel" ]
+ restart: always