parados/docs/parados.1 at master · uint23/parados · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
.Dd January 31, 2026
.Dt PARADOS 1
.Os
.Sh NAME
.Nm parados
.Nd simple HTTP media server
.Sh SYNOPSIS
.Nm parados
.Op Fl v
.Sh DESCRIPTION
.Nm
is a minimal HTTP media server for serving local audio and
video files over a network.  It exposes a HTTP interface
intended for use by external clients such as media players
or web frontends.
.Pp
The server scans a directory tree at startup and exposes the
contents through a simple HTTP API.  Each file is assigned
an identifier derived from its relative path.
.Pp
.Nm
does not provide a user interface; all interaction is
expected to happen through clients.
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl v
Print version information and exit.
.El
.Sh OPERATION
On startup,
.Nm
performs the following steps:
.Bl -enum -compact
.It
Load configuration from
.Ev PARADOS_CONFIG
if set, otherwise
.Pa /etc/parados.conf
or, if not present,
.Pa ./parados.conf .
.It
Parse user and access rules.
.It
Scan the configured media directory and build the media
library.
.It
Bind to the configured address and port.
.It
Accept and handle HTTP requests.
.El
.Pp
Each incoming connection is handled independently in its own
thread.  The maximum number of concurrent clients is limited
by the
.Ic max_clients
configuration option.
.Pp
Connections are closed after each request.
.Sh LOGGING
.Nm
writes diagnostic and status messages to standard error.
.Pp
Logging verbosity is controlled by the
.Ic verbose_log
setting in
.Xr parados.conf 5 .
.Sh HTTP INTERFACE
The HTTP interface is documented in
.Xr parados 7 .
.Sh AUTHENTICATION
Authentication is optional and configured through
.Xr parados.conf 5 .
.Pp
If no users are defined, all requests are served without
authentication.  If one or more users are defined, HTTP
Basic authentication is required for all endpoints except
.Pa /ping .
.Pp
Access to media files is restricted per user based on
configured allow-lists.
.Sh LIBRARY MANAGEMENT
The media library is scanned at startup.
.Pp
If authentication is enabled, the library may be rescanned
at runtime by issuing a request to the
.Pa /rescan
endpoint.
.Sh EXIT STATUS
.Ex -std
.Sh SEE ALSO
.Xr parados.conf 5 ,
.Xr parados 7
.Sh AUTHORS
.An Abhinav Prasai