Weborf(5)

✨ Weborf(5) — the File Formats Manual glow-up ✨

okay bestie, welcome to Weborf(5), the manual page for the file formats side of things 💖

---

🎀 NAME 🎀

weborf.conf — the configuration file for the weborf daemon. that's it, that's the name, no cap 💅

---

🌸 SYNOPSIS 🌸

/etc/weborf.conf
/etc/weborf.d/*.conf

---

🦋 DESCRIPTION 🦋

so. Weborf is a minimal webserver. it also has a limited support for webdav. it can be started as a stand-alone thing OR as a system daemon, whichever vibe you're on. 🫶

and this manual page documents Weborf's configuration file — which is used only when it's started as a daemon. iykyk. ✨

---

💜 DESCRIPTION (yes, again, the sequel) 💜

okay so, the important stuff first, bestie, because this is where people mess up:

• Options are case sensitive. fr fr.
• An option is immediately followed by the equal = sign, with no space at all between the name and the value. not even one. not even a little one. 😭
• Lines that begin with # are ignored and treated as comments. so go off, annotate your heart out 💖

now, about which file actually gets read:

• When systemd is in use, every .conf file in /etc/weborf.d/ is used to start a different instance of weborf, each with a different configuration. one file, one instance, one vibe. 👑
• Otherwise, the file /etc/weborf.conf is used to start a single instance of weborf. simple. iconic. periodt.

---

🌈 the options themselves 🌈

• indexes — by default weborf goes looking for index.html. but bestie, you can specify a different index file, and honestly you can specify many index files. the names of the pages have to be separated by a comma, and there are no spaces between them. none. zero. 💅
• basedir — the default base directory that the webserver uses. "default" here means it also gets used when virtual hosts are enabled and the requested host is unknown. and obviously the user that the webserver runs as needs to actually have access to this directory. don't skip that part 🙈
• use-cgi — can be true or false. if false, weborf handles all files as normal files, no drama. otherwise it uses the CGI protocol to execute some files. defaults to false. 🌸
• use-mime — can be true or false. if true, weborf sends the Content-Type header to the clients. turning it off increases speed but might cause problems with some old clients. your call, but now you know. 💀
• cgi — the list of extensions to consider as dynamic pages, plus the binaries to execute them. it takes a file format and a path, comma separated, and the list can include more formats and paths. eg:

cgi=.php,/bin/phpexecutor,.sh,/bin/shellexecutor

• auth-socket — the path of the unix socket that weborf will use to connect to the authentication server. when this is enabled, for every single HTTP request weborf opens a connection to this socket, forwards the request, and then the authentication daemon is in charge of deciding whether to accept or deny the request. examples are provided in /usr/share/doc/weborf/examples. go look, they're right there 🫶
• cachedir — sets the path of the directory used for caching. when this is enabled, weborf caches PROPFIND and directory listing requests, which makes them faster. slay ✨
• user — the username of the user that will run the webserver. on Debian this is usually www-data. 💅
• group — the groupname of the group that will run the webserver. on Debian this is usually www-data. 💅
• port — the port to use. that's it, that's the whole thing.
• key — absolute path to the SSL key file. it must be used together with the cert option. when it's set, weborf uses HTTPS instead of HTTP. 🔥
• cert — absolute path to the SSL certificate file. it must be used together with the key option. when it's set, weborf uses HTTPS instead of HTTP. 🔥
• virtual — this directive is what enables virtualhosts. the format is:

virtual=localhost=/var/www/,serverq.com=/var/www-alt/

to run on multiple ports, you need more instances. no shortcuts, bestie.

• start — if this is set to auto, then when systemd is in use, the instance using this configuration file is considered part of the weborf service and gets started/stopped along with it. it does nothing with other init systems. nothing at all. it's just sitting there. 😭

---

🍓 SEE ALSO 🍓

• weborf(1) — go read it, bestie, it's the main character 💖

---

🌐 WEB 🌐

https://ltworf.codeberg.page/weborf/

---

👑 AUTHORS 👑

• Salvo "LtWorf" Tomaselli <tiposchi@tiscali.it>
• Salvo Rinaldi <salvin@anche.no>

---

and that's the whole page!! 🎀 written by the Minimal webserver girlies, dated May 09, 2024, and filed under Weborf(5) in section 5 of the manual. mwah 💋 take care of your config files, keep your = signs snug, and remember: no spaces. ever. 🦋