OBFS-LOCAL(1)

📦
version 0.0.5 · 3 versions
, in opensuse-leap 16.0

💅 obfs-local(1) — simple-obfs client 💅

okay bestie, welcome to the obfs-local(1) page from the Shadowsocks-libev Manual. This is the local-side icon of the obfs-simple situation, and we are gonna go through every flag like it's a group chat receipt. 💖

🌸 NAME 🌸

obfs-local — simple-obfs client. That's the whole vibe. ✨

🦋 SYNOPSIS 🦋

obfs-local [-6] [-h|--help] [-s <server_host>] [-p <server_port>] [-l
       <local_port>] [-f <pid_file>] [-t <timeout>] [-c <config_file>] [-i
       <interface>] [-a <user_name>] [-b <local_address] [-n <nofile>]
       [--fast-open] [--obfs <http|tls>] [--obfs-host <hostname>]

🎀 DESCRIPTION 🎀

Obfs-simple is lowkey a very simple obfuscating tunnel tool. No cap. 🫶

It's written in pure C and takes advantage of libev to achieve both high performance and low resource consumption. So it's giving efficient, not messy. 💅

Obfs-simple consists of two components. obfs-local(1) works as a standard tunnel on local machines to obfuscate TCP traffic. Main character energy, honestly. 👑

✨ OPTIONS ✨

  • -s <server_host> — set the server's hostname or IP. 🖥️
  • -p <server_port> — set the server's port number. 🔢
  • -l <local_port> — set the local port number. 📍
  • -a <user_name> — run as a specific user. 👤
  • -f <pid_file> — start obfs-simple as a daemon with a specific pid file. 🧚
  • -t <timeout> — set the socket timeout in seconds. The default value is 60. ⏱️
  • -c <config_file> — use a configuration file. 🗂️
  • -n <number> — specify max number of open files. Only available on Linux. 🐧
  • -i <interface> — send traffic through a specific network interface. For example, there are three interfaces in your device: lo (127.0.0.1), eth0 (192.168.0.1) and eth1 (192.168.0.2). Meanwhile, you configure obfs-local to listen on 0.0.0.0:8388 and bind to eth1. That results the traffic go out through eth1, but not lo nor eth0. This option is useful to control traffic in a multi-interface environment. 🌐
  • -b <local_address> — specify local address to bind. 🪢
  • -6 — resolve hostname to IPv6 address first. 🛰️
  • --fast-open — enable TCP fast open. Only available with Linux kernel > 3.7.0. ⚡
  • --mptcp — enable Multipath TCP. Only available with MPTCP enabled Linux kernel. 🛣️
  • --obfs <http|tls> — enable HTTP or TLS obfuscating. (Experimental) 🧪
  • --obfs-host <hostname> — specify the hostname for obfuscating. (Experimental) 🧪
  • -v — enable verbose mode. 🗣️
  • -h|--help — print help message. 🆘

🌈 EXAMPLE 🌈

obfs-local(1) can be started from the command line and run in the foreground. Here is an example:

# Start obfs-local with given parameters
obfs-local -s example.com -p 12345 -l 1080 --obfs http --obfs-host www.baidu.com

💜 SEE ALSO 💜

obfs-server(1), /etc/simple-obfs/config.json

💖 big kiss, bestie — this page is from Shadowsocks-libev 0.0.5, dated 02/26/2024. 💖

📦 where this page comes from