summarylogtreecommitdiffstats
path: root/example.conf
diff options
context:
space:
mode:
Diffstat (limited to 'example.conf')
-rw-r--r--example.conf34
1 files changed, 34 insertions, 0 deletions
diff --git a/example.conf b/example.conf
new file mode 100644
index 000000000000..87cdc8c7cbab
--- /dev/null
+++ b/example.conf
@@ -0,0 +1,34 @@
+# This file configures onetun using environment variables
+# See onetun --help for more information
+
+# The address (IP + port) of the Wireguard endpoint (remote).
+ONETUN_ENDPOINT_ADDR=1.2.3.4:51820
+
+# The public key of the Wireguard endpoint (remote).
+ONETUN_ENDPOINT_PUBLIC_KEY=9Ztnedd1CxaLoWcxCCAusdamG2ag3ZRKtTLEEChnN2g=
+
+# Configures a persistent keep-alive for the WireGuard tunnel, in seconds.
+# ONETUN_KEEP_ALIVE=
+
+# Configures the log level and format.
+# ONETUN_LOG=
+
+# The private key of this peer. The corresponding public key should be registered in the Wireguard endpoint.
+# You can also use 'ONETUN_PRIVATE_KEY_FILE=' to specify a file containing the key instead.
+ONETUN_PRIVATE_KEY=uG76ogG4mYlOVe7N9+FEML790Zumecacihitssd/yF0=
+
+# The path to a file containing the private key of this peer. The corresponding public key should be registered in the Wireguard endpoint.
+# ONETUN_PRIVATE_KEY_FILE=
+
+# The source IP to identify this peer as (local).
+ONETUN_SOURCE_PEER_IP=192.168.4.3
+
+# Port forward configurations. The format of each argument is
+# [src_host:]<src_port>:<dst_host>:<dst_port>[:TCP,UDP,...], where [src_host] is the local IP
+# to listen on, <src_port> is the local port to listen on, <dst_host> is the remote peer IP
+# to forward to, and <dst_port> is the remote port to forward to. Environment variables must be
+# of the form 'ONETUN_PORT_FORWARD_[#]', where [#] starts at 1.
+ONETUN_PORT_FORWARD_1=127.0.0.1:80:10.0.0.2:8080:TCP
+ONETUN_PORT_FORWARD_2=127.0.0.1:443:10.0.0.2:8443:TCP,UDP
+ONETUN_PORT_FORWARD_3=127.0.0.1:1900:10.0.0.2:1900
+