Skip to content

add single-port mode section to README #129

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pin merged 1 commit into from
Feb 25, 2026
Merged

add single-port mode section to README #129

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,29 @@ or, for no backoff
s.SetBackoff(func (int) time.Duration { return 0 })
```

Single-port mode
----------------

By default, each transfer uses a separate server UDP port (standard TFTP
behavior). If your environment requires the server to stay on one port only
(typically UDP/69), enable single-port mode:

```go
s := tftp.NewServer(readHandler, writeHandler)
s.EnableSinglePort()
err := s.ListenAndServe(":69")
```

In this mode, all transfer packets are handled on the listening port, and the
server does not switch to random TIDs.

Notes:
* `EnableSinglePort` is experimental.
* It can reduce performance compared to the default mode.
* It is useful in networks where opening dynamic UDP ports is not possible
(for example, strict firewall/NAT setups).

Distribution packages
---------------------
* Debian: [golang-github-pin-tftp](https://packages.debian.org/source/sid/golang-github-pin-tftp)
* Fedora: [golang-github-pin-tftp-3](https://packages.fedoraproject.org/pkgs/golang-github-pin-tftp-3/golang-github-pin-tftp-3-devel/)
* Fedora: [golang-github-pin-tftp-3](https://packages.fedoraproject.org/pkgs/golang-github-pin-tftp-3/golang-github-pin-tftp-3-devel/)