Skip to content

Commit

Permalink
Added docker image to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ameshkov committed Feb 2, 2024
1 parent bd385b4 commit 5594319
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 1 deletion.
9 changes: 8 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,14 @@ adheres to [Semantic Versioning][semver].

## [Unreleased]

[unreleased]: https://github.com/ameshkov/udptlspipe/compare/v1.0.0...HEAD
[unreleased]: https://github.com/ameshkov/udptlspipe/compare/v1.0.1...HEAD

## [1.0.1] - 2024-02-02

* Added a [docker image][dockerregistry].

[dockerregistry]: https://github.com/ameshkov/udptlspipe/pkgs/container/udptlspipe
[1.0.1]: https://github.com/ameshkov/udptlspipe/releases/tag/v1.0.1

## [1.0.0] - 2024-02-02

Expand Down
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ to keep it that way.
* [Why would you need it?](#why)
* [How to install udptlspipe](#install)
* [How to use udptlspipe](#howtouse)
* [Docker](#docker)
* [All command-line arguments](#allcmdarguments)

[dtlspipe]: https://github.com/SenseUnit/dtlspipe
Expand Down Expand Up @@ -51,6 +52,7 @@ are:
go install github.com/ameshkov/udptlspipe@latest
```
* You can get a binary from the [releases page][releases].
* You can also use a [Docker image](#docker) instead.

[releases]: https://github.com/ameshkov/udptlspipe/releases

Expand Down Expand Up @@ -101,6 +103,38 @@ need to make some adjustments to the WireGuard client configuration:

[wireguardcalculator]: https://www.procustodibus.com/blog/2021/03/wireguard-allowedips-calculator/

<a id="docker"></a>

## Docker

The docker image [is available][dockerregistry]. `udptlspipe` listens to the
port `8443` inside the container, so you don't have to specify the listen
address, other arguments are available.
Tunnel server: run `udptlspipe` as a background service in server mode and
expose on the host's port `443` (tcp):

```shell
docker run -d --name udptlspipe -p 443:8443/tcp \
ghcr.io/ameshkov/udptlspipe:master \
--server \
-d 2.3.4.5:8123 \
-p SecurePassword
```

Local machine: run `udptlspipe` as a background service in client mode and
expose on the host's port `1234` (udp):
```shell
docker run -d --name udptlspipe -p 1234:8443/udp \
ghcr.io/ameshkov/udptlspipe:master \
--server \
-d 2.3.4.5:8123 \
-p SecurePassword
```
[dockerregistry]: https://github.com/ameshkov/udptlspipe/pkgs/container/udptlspipe
<a id="allcmdarguments"></a>
## All command-line arguments
Expand Down

0 comments on commit 5594319

Please sign in to comment.