Sortix cisortix manual

This manual documents Sortix cisortix. You can instead view this document in the latest official manual.

NAME

httpd.conf — HTTP daemon configuration file

DESCRIPTION

httpd.conf is the configuration file for the HTTP daemon, httpd(8).

SECTIONS

httpd.conf is divided into four main sections:

Within the sections, a host address can be specified by IPv4 address, IPv6 address, interface name, interface group, or DNS hostname. If the address is an interface name, httpd(8) will look up the first IPv4 address and any other IPv4 and IPv6 addresses of the specified network interface. If ‘*’ is given as an address, it will be used as an alias for 0.0.0.0 to listen on all IPv4 addresses. Likewise, ‘::’ can be used to listen on all IPv6 addresses. A port can be specified by number or name. The port name to number mappings are found in the file /etc/services; see services(5) for details.

The current line can be extended over multiple lines using a backslash (‘\’). Comments can be put anywhere in the file using a hash mark (‘#’), and extend to the end of the current line. Care should be taken when commenting out multi-line text: the comment is effective until the end of the entire block.

Argument names not beginning with a letter, digit, or underscore must be quoted.

Additional configuration files can be included with the include keyword, for example:

include "/etc/httpd.conf.local"

MACROS

Macros can be defined that will later be expanded in context. Macro names must start with a letter, digit, or underscore, and may contain any of those characters. Macro names may not be reserved words (for example, directory, log, or root). Macros are not expanded inside quotes.

For example:

ext_ip="10.0.0.1" 
server "default" { 
	listen on $ext_ip port 80 
}

GLOBAL CONFIGURATION

Here are the settings that can be set globally:

SERVERS

The configured web servers.

Each server section starts with a declaration of the server name:

Followed by a block of options that is enclosed in curly brackets:

alias name

Specify an additional alias name for this server.

alias match name

Like the alias option, but match the name using pattern matching instead of shell globbing rules, see patterns(7).

[no] authenticate [realm] with htpasswd

Authenticate a remote user for realm by checking the credentials against the user authentication file htpasswd. The file name is relative to the chroot and must be readable by the www user. Use the no authenticate directive to disable authentication in a location.

block drop

Drop the connection without sending an error page.

block [return code [uri]]

Close the connection and send an error page. If the optional return code is not specified, httpd(8) denies access with a ‘403 Forbidden’ response. The optional uri argument can be used with return codes in the 3xx range to send a ‘Location:’ header for redirection to a specified URI.

The uri may contain predefined macros that will be expanded at runtime:

connection option

Set the specified options and limits for HTTP connections. Valid options are:

default type type/subtype

Set the default media type for the specified location, overwriting the global setting.

directory option

Set the specified options when serving or accessing directories. Valid options are:

[no] fastcgi [socket socket]

Enable FastCGI instead of serving files. The socket is a local path name within the chroot(2) root directory of httpd(8) and defaults to /run/slowcgi.sock.

The FastCGI handler will be given the following variables:

hsts [option]

Enable HTTP Strict Transport Security. Valid options are:

listen on address [tls] port number

Set the listen address and port. This statement can be specified multiple times.

location path {...}

Specify server configuration rules for a specific location. The path argument will be matched against the request path with shell globbing rules. In case of multiple location statements in the same context, the first matching location statement will be put into effect, while all later ones will be ignored. Therefore it is advisable to match for more specific paths first and for generic ones later on. A location section may include most of the server configuration rules except alias, connection, hsts, listen on, location, tcp and tls.

location match path {...}

Like the location option, but match the path using pattern matching instead of shell globbing rules, see patterns(7). The pattern may contain captures that can be used in the uri of an enclosed block return option.

[no] log [option]

Set the specified logging options. Logging is enabled by default using the standard access and error log files, but can be changed per server or location. Use the no log directive to disable logging of any requests. Valid options are:

pass

Disable any previous block in a location.

root option

Configure the document root and options for the request path. Valid options are:

tcp option

Enable or disable the specified TCP/IP options; see tcp(4) and ip(4) for more information about the options. Valid options are:

tls option

Set the TLS configuration for the server. These options are only used if TLS has been enabled via the listen directive. Valid options are:

TYPES

Configure the supported media types. httpd(8) will set the Content-Type of the response header based on the file extension listed in the types section. If not specified, httpd(8) will use built-in media types for text/css, text/html, text/plain, image/gif, image/png, image/jpeg, image/svg+xml, and application/javascript.

The types section must include one or more lines of the following syntax:

EXAMPLES

The following example will start one server that is pre-forked two times and is listening on all local IP addresses. It additionally defines some media types overriding the defaults.

prefork 2 
 
server "default" { 
	listen on * port 80 
} 
 
types { 
	text/css		css 
	text/html		html htm 
	text/plain		txt 
	image/gif		gif 
	image/jpeg		jpeg jpg 
	image/png		png 
	application/javascript	js 
	application/xml		xml 
}

The server can also be configured to only listen on the primary IP address of the network interface that is a member of the “egress” group.

server "default" { 
	listen on egress port 80 
}

Multiple servers can be configured to support hosting of different domains. If the same address is repeated multiple times in the listen on statement, the server will be matched based on the requested host name.

server "www.example.com" { 
	alias "example.com" 
	listen on * port 80 
	listen on * tls port 443 
	root "/htdocs/www.example.com" 
} 
 
server "www.a.example.com" { 
	listen on 203.0.113.1 port 80 
	root "/htdocs/www.a.example.com" 
} 
 
server "www.b.example.com" { 
	listen on 203.0.113.1 port 80 
	root "/htdocs/www.b.example.com" 
} 
 
server "intranet.example.com" { 
	listen on 10.0.0.1 port 80 
	root "/htdocs/intranet.example.com" 
}

Simple redirections can be configured with the block directive:

server "example.com" { 
	listen on 10.0.0.1 port 80 
	block return 301 "http://www.example.com$REQUEST_URI" 
} 
 
server "www.example.com" { 
	listen on 10.0.0.1 port 80 
}

AUTHORS

The httpd(8) program was written by Reyk Floeter <reyk@openbsd.org>.