whereami.conf(5)

💖 NAME 💖

okay so bestie, this is the manual page for whereami.conf — the whole entire configuration file situation for whereami, the whereami.conf(5) vibe. it lives in section 5, file formats, iykyk 🎀

---

✨ DESCRIPTION ✨

the whereami.conf file is literally the blueprint for what whereami does when you're leaving, staying at, or arriving at locations. like, it's the whole mood board of your network life. 💅

(btw locations get detected by whereami based on whatever you told it in the detect.conf file — that's a whole other manpage, go look 👀)

comment lines start with the # character. and here's the tea: leading whitespace gets ignored on all lines, comment lines included. so go ahead and indent, nobody's judging 🫶

every other line looks like this:

• -location action — this action runs if your system used to be at this location, but is now somewhere else. it's giving "we don't go there anymore" 😭
• =location action — this action runs if your system is now at this location. periodt. that's it, that's the whole thing ✨
• +location action — this action runs if your system is now at this location but was previously at another one. main character arrival energy 👑
• !location action — this action runs if your system is not at this location. the anti-vibe check 💀

---

🧚 HELPER SCRIPTS 🧚

besides all the normal commands you'd get in any shell script, whereami ships with a bunch of helper scripts that are honestly so useful. let's get into them 🔥

• setmailrelay (none | queue [smarthost] | smarthost) set the mail relay (aka the smarthost) to "none" if you've got a permanent connection and can send e-mail straight to the recipient's mailserver. no middleman needed, we love a direct route 💖

if you're not connected, set the relay to "queue" (optionally for a specific smarthost).

or, send all mail to one specific smarthost if that's what this location needs. you do you 🎀

• setresolver <resolv.conf stanza> the <resolv.conf stanza> should be something like search localhost mydomain.com nameserver 1.2.3.4 (all on one line, bestie, don't go splitting it) to specify the domain search path and the nameserver to use.

if you have resolvconf installed, this script will interface with that to manupulate the /etc/resolv.conf file and control DNS resolution. this is recommended. 👑

if you're not using resolvconf, then this will directly rewrite your /etc/resolv.conf file, inserting a section similar to the manner in which DHCP works. okay so it's a little more chaotic but it works 🌈

• setproxy (start | stop | none | <upstream_proxy>) use this script to reconfigure your local oops or squid proxy server to use a specific upstream proxy, no upstream proxy, or to stop the proxy server completely.

the upstream proxy should be specified as "<name or ip> <port>", e.g.:

setproxy 192.168.55.3 3128

for a local squid proxy you can optionally also provide a complete set of parameters for the "cache_peer" directive (without the "cache_peer" name itself). see the squid.conf file for full details of this syntax. e.g.:

setproxy 192.168.55.3 parent 3128 3140 login=user:password

• settimezone timezone use this to set your timezone differently. tiny script, big glow-up ✨
• masqmail_route route_name use this to reconfigure masqmail to use a different masqmail routing. slay 🦋

---

🌸 SEE ALSO 🌸

• whereami(8)
• detect.conf(5)

further documentation is available in the /usr/share/doc/whereami directory. go read it, it's giving educated 💅

---

🎀 FILES 🎀

• /etc/whereami/whereami.conf — the file we are talking about in this here manpage. yes, this one. the one you're reading about. the circle is complete 🔥
• /etc/whereami/whereiam.sh — the script that is built based on the information in this configuration file and then executed by whereami.

---

💀 LIMITATIONS 💀

there should be a configuration program so that the user does not have to do any script programming. like... yeah. ngl, that would be so much nicer. someone get on that 🙈

---

👑 AUTHOR 👑

this manual page was written by Andrew McMillan <debian@mcmillan.net.nz> for the Debian GNU/Linux system (but may be used by others). permission is granted to copy, distribute and/or modify this document under the terms of the GPL version 2. ✨

---

and that's the whole page bestie!! this was whereami.conf(5) from the File Formats Manual — shoutout to Andrew McMillan for writing it, mwah 💖