aramperes/onetun
1
0
Fork 0
mirror of https://github.com/aramperes/onetun.git synced 2025-09-09 06:18:31 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

README adjustments

Browse source
This commit is contained in:
Aram 🍐 2022-03-27 14:15:25 -04:00
parent 7ebf8e0737
commit 472a4df69f
2 changed files with 7 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

2
LICENSE
View file

@ -1,6 +1,6 @@
MIT License MIT License
Copyright (c) 2021 Aram Peres Copyright (c) 2021-2022 Aram Peres
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal of this software and associated documentation files (the "Software"), to deal

13
README.md
View file

@ -16,8 +16,7 @@ A cross-platform, user-space WireGuard port-forwarder that requires no system ne
- You want to access this TCP or UDP service from a second computer, on which you can't install WireGuard because you - You want to access this TCP or UDP service from a second computer, on which you can't install WireGuard because you
can't (no root access) or don't want to (polluting OS configs). can't (no root access) or don't want to (polluting OS configs).
For example, this can be useful to forward a port from a Kubernetes cluster to a server behind WireGuard, For example, this can be useful to access a port on your WireGuard network from a dev machine that doesn't have WireGuard installed.
without needing to install WireGuard in a Pod.
## Download ## Download
@ -33,8 +32,8 @@ the [Releases](https://github.com/aramperes/onetun/releases) page.
You can also run onetun using [Docker](https://hub.docker.com/r/aramperes/onetun): You can also run onetun using [Docker](https://hub.docker.com/r/aramperes/onetun):
```shell ```shell
docker run --rm --name onetun --user 1000 -p 8080:8080 aramperes/onetun \ $ docker run --rm --name onetun --user 1000 -p 8080:8080 aramperes/onetun \
0.0.0.0:8080:192.168.4.2:8080 [...options...] 0.0.0.0:8080:192.168.4.2:8080 [...options...]
``` ```
You can also build onetun locally, using Rust ≥1.55: You can also build onetun locally, using Rust ≥1.55:
@ -61,7 +60,7 @@ onetun [src_host:]<src_port>:<dst_host>:<dst_port>[:TCP,UDP,...] [...] \
--private-key <private key assigned to onetun> \ --private-key <private key assigned to onetun> \
--source-peer-ip <IP assigned to onetun> \ --source-peer-ip <IP assigned to onetun> \
--keep-alive <optional persistent keep-alive in seconds> \ --keep-alive <optional persistent keep-alive in seconds> \
--log <optional log level, defaults to "info" --log <optional log level, defaults to "info">
``` ```
> Note: you can use environment variables for all of these flags. Use `onetun --help` for details. > Note: you can use environment variables for all of these flags. Use `onetun --help` for details.
@ -175,7 +174,7 @@ INFO onetun::tunnel > Tunneling TCP [127.0.0.1:8080]->[192.168.4.2:8080] (via [
To capture packets sent to and from the onetun local port, you must use an external tool like `tcpdump` with root access: To capture packets sent to and from the onetun local port, you must use an external tool like `tcpdump` with root access:
``` ```
$ sudo tcpdump -i lo -w local.pcap 'dst 127.0.0.1 && port 8443' $ sudo tcpdump -i lo -w local.pcap 'dst 127.0.0.1 && port 8080'
``` ```
## Architecture ## Architecture
@ -244,4 +243,4 @@ All in all, I would not recommend using UDP forwarding for public services, sinc
## License ## License
MIT. See `LICENSE` for details. MIT License. See `LICENSE` for details. Copyright &copy; 2021-2022 Aram Peres.