Blame


1 63a1ddbc 2022-09-14 op Galileo is a Gemini proxy for the World Wide Web (www.) It speaks
2 83f0f95a 2022-09-29 op FastCGI and is intended to be run behind OpenBSD' httpd(8), but is known
3 83f0f95a 2022-09-29 op to work also with nginx and lighttpd.
4 63a1ddbc 2022-09-14 op
5 63a1ddbc 2022-09-14 op Galileo doesn't serve static files, it connects to an upstream Gemini
6 83f0f95a 2022-09-29 op server and translate HTTP requests into Gemini requests. It serves the
7 83f0f95a 2022-09-29 op content as-is, with the only exception of translating text/gemini into
8 83f0f95a 2022-09-29 op HTML.
9 63a1ddbc 2022-09-14 op
10 83f0f95a 2022-09-29 op To compile Galileo run:
11 63a1ddbc 2022-09-14 op
12 83f0f95a 2022-09-29 op $ ./configure
13 63a1ddbc 2022-09-14 op $ make
14 63a1ddbc 2022-09-14 op $ doas make install
15 5b17e3ec 2022-09-21 op
16 83f0f95a 2022-09-29 op To change the default user (`www`), the default configuration file
17 83f0f95a 2022-09-29 op (`/etc/galileo.conf`) or the default socket location
18 83f0f95a 2022-09-29 op (`/var/www/run/galileo.sock`), pass the the custom `USER`, `CONF` and
19 83f0f95a 2022-09-29 op `SOCK` to the configure:
20 5b17e3ec 2022-09-21 op
21 e750b7de 2022-09-29 op $ ./configure USER=_galileo CONF=/usr/local/etc/galileo.conf
22 83f0f95a 2022-09-29 op
23 83f0f95a 2022-09-29 op While a custom configuration file can be given using `-f`, the user
24 83f0f95a 2022-09-29 op can only be set during compilation.
25 83f0f95a 2022-09-29 op
26 83f0f95a 2022-09-29 op The `galileo.css` file is installed by default in `/var/www/htdocs`,
27 83f0f95a 2022-09-29 op set a custom `WWWDIR` during the install to specify another location:
28 83f0f95a 2022-09-29 op
29 83f0f95a 2022-09-29 op $ doas make WWWDIR=/usr/local/www/htdocs install
30 83f0f95a 2022-09-29 op
31 83f0f95a 2022-09-29 op The dependencies are
32 83f0f95a 2022-09-29 op
33 83f0f95a 2022-09-29 op - libasr
34 83f0f95a 2022-09-29 op - libevent
35 83f0f95a 2022-09-29 op - libtls or libretls
36 83f0f95a 2022-09-29 op
37 83f0f95a 2022-09-29 op When *not* building from a release tarball:
38 83f0f95a 2022-09-29 op
39 83f0f95a 2022-09-29 op - (or if `parse.y' is modified) yacc or GNU bison are also needed.
40 83f0f95a 2022-09-29 op
41 83f0f95a 2022-09-29 op - cross-compiling requires `HOSTCC' and `HOSTCFLAGS' to be passed to
42 83f0f95a 2022-09-29 op the `configure' script, e.g.:
43 83f0f95a 2022-09-29 op
44 83f0f95a 2022-09-29 op $ ./configure CC=riscv64-unknown-elf-gcc HOSTCC=cc