1+-----------------------------------------------------------------------
 2| Running ${PKGSTEM} on OpenBSD
 3+-----------------------------------------------------------------------
 4
 5Initial configuration
 6=====================
 7By default forgejo listens on all configured IP addresses, TCP port 3000.
 8If this is not wanted behavior, either adjust your pf(4) rules or change
 9HTTP_ADDR/HTTP_PORT in ${SYSCONFDIR}/forgejo/app.ini.
10
11To complete the initial configuration, point your browser to
12http://forgejo.example.com:3000 and press "Sign In". Usually you'll need to
13configure SSH Server Domain/Port, Gitea HTTP Listen Port/Base URL, E-Mail
14Settings and Administrator Account Settings.
15
16On OpenBSD, initial forgejo configuration has the following restrictions:
17
18 - Self-Registration is disabled
19 - Sign-In is required to view the content
20 - E-Mail addresses are not shown
21 - Server runs in "offline" mode, which means that external services such as
22   Gravatar/OpenID are not used
23 - New repositories have "private" checkbox checked by default
24 - Password hash algorithm changed from pbkdf2 to argon2
25
26Adjust these configuration settings according to your requirements.
27
28Configuring HTTP access
29=======================
30By default forgejo serves HTTP requests on its own.
31It can also be configured to run behind HTTP proxy like relayd(8) or nginx(8).
32
33Another option is to let OpenBSD httpd(8) serve HTTP(S) requests and pass it
34to forgejo via FastCGI protocol:
35
36Example configuration for httpd(8) and forgejo communicating via FastCGI
37----------------------------------------------------------------------
38
39Relevant configuration directives in ${SYSCONFDIR}/httpd.conf:
40
41	# An HTTPS server using SSL/TLS
42	server "forgejo.example.com" {
43		listen on $ext_addr tls port 443
44		tls certificate "/etc/ssl/forgejo.example.com.pem"
45		tls key "/etc/ssl/private/forgejo.example.com.key"
46		location "*" { fastcgi socket "/run/forgejo/forgejo.sock" }
47	}
48
49Relevant configuration directives in ${SYSCONFDIR}/forgejo/app.ini:
50
51	[server]
52	PROTOCOL               = fcgi+unix
53	DOMAIN                 = forgejo.example.com
54	ROOT_URL               = https://%(DOMAIN)s/
55	HTTP_ADDR              = /var/www/run/forgejo/forgejo.sock
56	LOCAL_ROOT_URL         = %(ROOT_URL)s
57
58Create the directory for forgejo socket with the following command:
59	# install -d -o _forgejo /var/www/run/forgejo
60
61Customizing forgejo
62=================
63For custom public files, templates, gitignores, labels, licenses and READMEs,
64please use ${LOCALSTATEDIR}/forgejo/custom directory.