Repository navigation
burrow v1.1.2
A documentation release: what burrow records about the people who use your proxy, verified
against mtg's source and a live server. There are no behaviour changes; upgrading is optional.
Fixed
- The logging docs were wrong. The README,
.env.example, the comment in every
generated.envandcompose.nolog.yamlclaimed that mtg logs client IPs with
LOGGING=on. In fact mtg (v2.3.0, withoutDEBUG) logs at warning level only:- connection starts and blocklist/allowlist rejections are never written;
- a client's IP appears only in a few connection-error warnings (for example when
Telegram can't be reached); DEBUG=truelogs every connection with its IP.
Changed
- The README's security section, the deployment guide and the website now say what is
and isn't recorded: no connection logs by default, no decoy access logs, and a host
firewall that logs only blocked packets. Anyone with root can still see live
connections. - New regression tests keep those guarantees: the decoy never gets an access log, and
mtg runs without debug logging unlessDEBUG=true.