Skip to content

Commit

Permalink
Add Docker setup and image to README
Browse files Browse the repository at this point in the history
Included a Dockerfile and docker-compose.yml for setting up the Jerusalem Tunnel service. Also added an image to the README for better visualization.
  • Loading branch information
mjm918 committed Aug 15, 2024
1 parent c10d1b2 commit 106c277
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,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.
Expand Down Expand Up @@ -31,6 +32,12 @@ Start the server:

./jerusalem-tunnel --config config.yaml

Start the server using Docker:

```bash
docker build -t jerusalem-tunnel .
docker run -d -p 8901:8901 --name jerusalem-tunnel -v $(pwd)/config.yaml:/app/config.yaml jerusalem-tunnel
```

## Configuration

Expand Down

0 comments on commit 106c277

Please sign in to comment.