GOT-PORTABLE(7)

💖 GOT-PORTABLE ✨

okay bestie, fold in: this is the manual page for got-portable, section 7 of the Miscellaneous Information Manual. It's the notes you actually need for the -portable flavour of Game of Trees. 🎀

---

🌸 NAME 🌸

got-portable — the tea on everything relevant to the -portable version of Game of Trees. 🦋

---

🧚 GOTWEBD WITH AN HTTP SERVER 🧚

so here's the situation: if you wanna actually use gotwebd(8), you can't just vibe — an HTTP server has to be set up to send traffic to gotwebd(8). To show you how this works, we're using nginx(1) as the example. periodt. 💅

👑 Nginx Configuration 👑

Setting up nginx means you need a server configuration that looks something like this, no cap:

https {
        server {
                listen *:80;
                root /var/www/htdocs;

                location / {
                        index index.html;
                }

                location /gotweb {
                        include fastcgi_params;
                        fastcgi_pass unix:/tmp/gotwebd.sock;
                }
        }
}

With this directive, port 80 is what's being used. You've got the location of "/", which is serving up the page "index.html". 🍓

Then there's the location "/gotweb" — and it includes the fastcgi parameters (this is mandatory, btw, because gotwebd(8) is a FastCGI server, so you literally have to include them, no skipping 🙈). After that, the rest of the requests get forwarded on to gotwebd(8) over the defined unix domain socket. Heads up though: the path to that socket has to match whatever's defined in gotwebd.conf(5). iykyk. 🔥

🌈 Gotwebd Configuration 🌈

This next example config is a bare-minimum situation — it just shows how to make sure gotwebd(8) is listening on the right port, and that the relevant bits from nginx(8) are referenced correctly too. Important: this is not a full tutorial for configuring gotwebd(8). For that whole journey, go look at gotwebd(8) and gotwebd.conf(5). 📚

Also note the in-line comments — they explain how and why gotwebd(8) is being configured this way. iconic of them honestly:

# The "www user" line should match the user that's running nginx.
www user "www-data"

# This is the user which gotwebd should run as.
#
# Note that this user must have permission to read the repositories
# set via `repos_path`.
#
# This should be an unprivileged user.
user n6tadam

# This is the unix domain socket gotwebd will create and listen on.
# This must also be set correctly in nginx's configuration.
listen on socket "/tmp/gotwebd.sock"

# Because we told nginx that we wanted to serve up gotwebd traffic via
# `/gotweb`, we should let gotwebd know this is also where traffic is coming
# from.
gotweb_url_root "/gotweb"

# Matches the home directory of the "www user".
#
# Note that it is assumed that under this directory
chroot "/var/www"

server "localhost" {
        disable authentication
        site_name "Public repos"
        site_owner "Thomas Adam"
        site_link "Thomas' Projects"

        # This is where all the bare repos live.
        repos_path "/home/n6tadam/p/got/root/repos"
}

okay so with all that configuration above, gotwebd(8) is expecting to serve up artefacts relative to the chroot path — and that defaults to "htdocs/gotwebd". Those files might already be packaged for you, and they might be chilling somewhere under "/usr/share/got-portable/". 💀 But regardless: they're packaged in the release tarball, and the "gotwebd/files/htdocs/gotwebd" directory should be copied to "htdocs/" relative to the chroot line in gotwebd's configuration file. Don't forget that part bestie, it's giving crucial. 💜

---

💫 SEE ALSO 💫

• got(1)
• gotwebd.conf(5)
• gotwebctl(8)
• nginx(8)

---

🫶 AUTHORS 🫶

Thomas Adam <thomas@xteddy.org> 💌

---

and that's the whole page, mwah. this one ships out of Debian, version $Mdocdate$, and it's GOT-PORTABLE(7) — go forth and configure your sockets correctly, you're the main character of this server. ⭐👑