TORSOCKS.CONF(5)

🌸 TORSOCKS.CONF(5) 🌸

okay bestie, welcome to the manual page for torsocks.conf — that's the configuration file for torsocks(8) 💅 this is section 5 of the manual, so you know it's the ✨file formats✨ girlies. sit down, grab a strawberry 🍓, we're doing this.

---

💖 NAME 💖

torsocks.conf — Configuration file for torsocks(8)

---

✨ SUMMARY ✨

so by default, torsocks is just gonna assume it should connect to the Tor SOCKS proxy chillin' at 127.0.0.1 on port 9050. that's the default address and port for Tor's socks server on basically most installations, no cap. so if you're running a normal Tor setup and you have zero special requirements?? you literally do not need to create, edit, or invoke a configuration file when using torsocks. it's giving effortless. it's giving low-maintenance. 🎀

your installation of torsocks includes a default configuration file that has values sensible for use with most Tor installations. the installation location for your default configuration file is:

/etc/tor/torsocks.conf

in order to use a configuration file, you must set the environment variable TORSOCKS_CONF_FILE with the location of the file. periodt.

if TORSOCKS_CONF_FILE is not set, torsocks will attempt to read the configuration file at /etc/tor/torsocks.conf. and if that file cannot be read?? torsocks will use sensible defaults for most Tor installations, i.e. it will assume that you want to use a SOCKS proxy running at 127.0.0.1 (localhost) on port 9050. she's got a fallback for everything, we love a prepared queen 👑

---

🦋 CONFIGURATION 🦋

🌈 SYNTAX 🌈

the basic structure of all lines in the configuration file is:

<directive> <parameters>

empty lines are ignored and all input on a line after a # character is ignored. so comment away, bestie, live your truth 💜

👑 DIRECTIVES 👑

the following directives are used in the torsocks configuration file:

• TorAddress ip_addr — the IP address of the Tor SOCKS server (e.g "server = 10.1.4.253"). only one server may be specified. currently, torsocks does NOT support hostname. (default: 127.0.0.1)
• TorPort port — the port on which the Tor SOCKS server receives requests. (default: 9050)
• OnionAddrRange subnet/mask — Tor hidden sites do not have real IP addresses. this specifies what range of IP addresses will be handed to the application as "cookies" for .onion names. of course, you should pick a block of addresses which you aren't going to ever need to actually connect to. this is similar to the MapAddress feature of the main tor daemon. (default: 127.42.42.0/24)
• SOCKS5Username username — username to use for SOCKS5 authentication method that makes the connections to Tor to use a different circuit from other existing streams. if set, the SOCKS5Password must be specified also. (Default: none).
• SOCKS5Password password — password to use for SOCKS5 authentication method that makes the connections to Tor to use a different circuit from other existing streams. if set, the SOCKS5Username must be specified also. (Default: none).
• AllowInbound 0|1 — allow inbound connections meaning that listen() and accept()/accept4() will be allowed for non localhost address so the application can handle incoming connection. note that Unix socket are allowed. (Default: 0)
• AllowOutboundLocalhost 0|1|2 — allow outbound connections to the loopback interface meaning that connect() will be allowed to connect to localhost addresses bypassing Tor. if set to 1, TCP connections will be allowed. if set to 2, both TCP/IP and UDP connections will be allowed. this option should not be used by most users. (Default: 0)

🚨 bestie listen to me. AllowOutboundLocalhost is not for most users. do not just set it because it sounds fun. it bypasses Tor. that's the whole point of torsocks and you're out here handing it a hall pass 😭

• IsolatePID 0|1 — set Torsocks to use an automatically generated SOCKS5 username/password based on the process ID and current time, that makes the connections to Tor use a different circuit from other existing streams in Tor on a per-process basis. if set, the SOCKS5Username and SOCKS5Password options must not be set. (Default: 0)

---

🔥 EXAMPLE 🔥

$ export TORSOCKS_CONF_FILE=$PWD/torsocks.conf
$ torsocks ssh account@sshserver.com

look at her go. set the env var, run the thing, iconic behaviour 💅✨

---

🌸 SEE ALSO 🌸

torsocks(1), torsocks(8),

---

💜 AUTHOR 💜

David Goulet <dgoulet@ev0ke.net>

---

and that's the whole page, bestie!! this version is from August 24th, 2013, and yes the page name at the bottom of the original is TORSOCKS.CONF(5) — same as the top, because manpages love symmetry 🫶 go forth and configure responsibly. mwah 💖🎀🦋