NAME

parados.conf — configuration file for parados

DESCRIPTION

The parados.conf file configures parados(1).

The file format is line-oriented. Each non-empty, non-comment line is a key/value pair int he form:

key=value

Whitespace around keys and values ignored. Lines beginning with ‘#’ are comments and are ignored. Unknown keys are ignored but logged.

FILES

/etc/parados.conf

System-wide configuration file.

./parados.conf

Fallback configuration file in the current working directory.

PARAMETERS

media_dir

Directory containing all media files. The library is built by recursively scanning this directory at startup.

Example:

media_dir=/path/to/media

server_addr

Address to bind the HTTP server to. Use 127.0.0.1 to listen on the local host only. This is recommended if a web interface is being hosted on the same machine; exposing the server to the network may unnecessarily increase risk. Use 0.0.0.0 to listen on all IPv4 interfaces.

Example:

server_addr=0.0.0.0

server_port

TCP port to listen on.

Example:

server_port=8088

verbose_log

Enable or disable verbose logging. Accepted values are 1, 0, true, false, yes, and no (case-insensitive).

Example:

verbose_log=true

cors_origin

Configure Cross-Origin Resource Sharing (CORS) for web clients.

If empty, no CORS headers are sent. If set to *, all origins are allowed. Otherwise, the value is interpreted as a comma-separated list of allowed origins (clients that can interact over the web).

Example:

cors_origin=http://127.0.0.1:8000

http_io_timeout

Maximum number of seconds the server will block on a single socket read/write operation.

This limits how long a client may stall for while sending a request or receiving a response. If the timeout is exceeded, the connection is closed.

This option is used to protect against stalled or misbehaving clients. It does not limit the total duration of a request or stream.

Valid values are integers in the range 1 to 300.

Example:

http_io_timeout=5

max_clients

Maximum number of concurrent client connections. If the limit is reached, new connections receive a 503 response.

Valid values are integers in the range 1 to 1024.

Example:

max_clients=64

auth_delay

Delay (in ms) before returning 401 Unauthorized responses.

This can slow down brute force login attempts.

Valid values are non-negative integers 0.. INT_MAX. A value of 0 disables the delay.

Example:

auth_delay=250

AUTHENTICATION

Authentication entries are specified using repeated groups of the keys user, pass, and allow.

If no user entries are present, authentication is disabled and all files are accessible. If one or more users are present, HTTP Basic authentication is required for all requests except /ping.

Each user starts a new authentication entry. The following pass and allow lines apply to that user until the next user line.

user

Set the username for a new authentication entry.

Example:

user=glenda

pass

Set the password for the most recently declared user. If empty, the account is passwordless and accepts only an empty password.

Example:

pass=secret

allow

Add an allowed path prefix for the most recently declared user. Multiple allow directives may be used.

A value of * allows all paths. Otherwise, the value must match the beginning of a file's relative path. Directory boundaries are respected.

Example:

allow=Media/
allow=Music/

EXAMPLES

Minimal configuration:

media_dir=/path/to/media
server_addr=127.0.0.1
server_port=8088
verbose_log=true
cors_origin=
auth_delay=0

Two users with separate access:

user=glenda
pass=pass123
allow=Media/
allow=Music/

user=bob
pass=
allow=TV/NBA/

Single passwordless administrative user with full access:

user=admin
pass=
allow=*

SEE ALSO

parados(1), parados(7)

AUTHORS

Abhinav Prasai