2 b8dcf4d9 2022-09-14 op .\" Copyright (c) 2022 Omar Polo
4 b8dcf4d9 2022-09-14 op .\" Permission to use, copy, modify, and distribute this software for any
5 b8dcf4d9 2022-09-14 op .\" purpose with or without fee is hereby granted, provided that the above
6 b8dcf4d9 2022-09-14 op .\" copyright notice and this permission notice appear in all copies.
8 b8dcf4d9 2022-09-14 op .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 b8dcf4d9 2022-09-14 op .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 b8dcf4d9 2022-09-14 op .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 b8dcf4d9 2022-09-14 op .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 b8dcf4d9 2022-09-14 op .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 b8dcf4d9 2022-09-14 op .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 b8dcf4d9 2022-09-14 op .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15 b8dcf4d9 2022-09-14 op .Dd September 14, 2022
16 b8dcf4d9 2022-09-14 op .Dt GALILEO.CONF 5
19 b8dcf4d9 2022-09-14 op .Nm galileo.conf
20 b8dcf4d9 2022-09-14 op .Nd galileo configuration file
21 b8dcf4d9 2022-09-14 op .Sh DESCRIPTION
23 b8dcf4d9 2022-09-14 op is the run-time configuration file for
24 b8dcf4d9 2022-09-14 op .Xr galileo 8 .
26 b8dcf4d9 2022-09-14 op The file format is line-based, with one configuration directive per line.
27 b8dcf4d9 2022-09-14 op Any lines beginning with a
29 b8dcf4d9 2022-09-14 op are treated as comments and ignored.
30 b8dcf4d9 2022-09-14 op .Sh GLOBAL CONFIGURATION
31 b8dcf4d9 2022-09-14 op The available global configuration directives are as follows:
32 b8dcf4d9 2022-09-14 op .Bl -tag -width Ds
33 b8dcf4d9 2022-09-14 op .It Ic chroot Ar path
34 b8dcf4d9 2022-09-14 op Set the path to the
37 b8dcf4d9 2022-09-14 op .Xr galileo 8 .
38 b8dcf4d9 2022-09-14 op .It Ic prefork Ar number
39 b8dcf4d9 2022-09-14 op Specify the number of proxy processes.
41 b8dcf4d9 2022-09-14 op .Sh SERVER CONFIGURATION
42 b8dcf4d9 2022-09-14 op At least one server context must exist for
46 b8dcf4d9 2022-09-14 op A server context is declared with a unique
48 b8dcf4d9 2022-09-14 op followed by server-specific configuration directive inside curly braces:
50 b8dcf4d9 2022-09-14 op .Ic server Ar name Brq ...
52 b8dcf4d9 2022-09-14 op The available server configuration directives are as follows:
53 b8dcf4d9 2022-09-14 op .Bl -tag -width Ds
54 b8dcf4d9 2022-09-14 op .It Ic proxy Brq ...
55 b8dcf4d9 2022-09-14 op Define the proxy configuration for the matching host.
56 b8dcf4d9 2022-09-14 op The available proxy configuration directives are as follows:
57 b8dcf4d9 2022-09-14 op .Bl -tag -width Ds
58 b8dcf4d9 2022-09-14 op .It Ic source Ar address Ic port Ar port
59 b8dcf4d9 2022-09-14 op Specify to which
64 b8dcf4d9 2022-09-14 op .It Ic hostname Ar name
67 b8dcf4d9 2022-09-14 op used for SNI and the Gemini request.
69 b8dcf4d9 2022-09-14 op .It Ic stylesheet Ar path
70 b8dcf4d9 2022-09-14 op Specify the path to the stylesheet linked in the generated HTML.
73 b8dcf4d9 2022-09-14 op .Bl -tag -width Ds -compact
74 b8dcf4d9 2022-09-14 op .It Pa /etc/galileo.conf
75 b8dcf4d9 2022-09-14 op Default location of the
77 b8dcf4d9 2022-09-14 op configuration file.
80 b8dcf4d9 2022-09-14 op The following example will proxy the Gemini capsule
81 b8dcf4d9 2022-09-14 op .Sq gemini://gemini.example.com
83 b8dcf4d9 2022-09-14 op .Sq https://www.example.com
84 b8dcf4d9 2022-09-14 op .Pq or Sq http://
85 b8dcf4d9 2022-09-14 op assuming a Gemini server is listening on 127.0.0.1:
86 b8dcf4d9 2022-09-14 op .Bd -literal -offset indent
87 b8dcf4d9 2022-09-14 op server "www.example.com" {
89 b8dcf4d9 2022-09-14 op source 127.0.0.1 port 1965
90 b8dcf4d9 2022-09-14 op hostname "gemini.example.com"
92 b8dcf4d9 2022-09-14 op stylesheet "/galileo.css"
96 b8dcf4d9 2022-09-14 op The matching configuration for
99 b8dcf4d9 2022-09-14 op .Bd -literal -offset indent
100 b8dcf4d9 2022-09-14 op server "www.example.com" {
101 b8dcf4d9 2022-09-14 op listen on * port 80
102 b8dcf4d9 2022-09-14 op listen on * tls port 443
104 b8dcf4d9 2022-09-14 op certificate "/etc/ssl/example.com.fullchain.pem"
105 b8dcf4d9 2022-09-14 op key "/etc/ssl/private/example.com.key"
107 b8dcf4d9 2022-09-14 op location "/.well-known/acme-challenge/*" {
109 b8dcf4d9 2022-09-14 op request strip 2
111 b8dcf4d9 2022-09-14 op location "/galileo.css" {
112 b8dcf4d9 2022-09-14 op root "/htdocs"
114 b8dcf4d9 2022-09-14 op location "/*" {
115 b8dcf4d9 2022-09-14 op fastcgi socket "/run/galileo.sock"
120 b8dcf4d9 2022-09-14 op .Xr httpd.conf 5 ,
121 b8dcf4d9 2022-09-14 op .Xr galileo 8 ,