tpartage.conf.5 - partage - File upload system
(HTM) git clone git://git.z3bra.org/partage.git
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) README
(DIR) LICENSE
---
tpartage.conf.5 (2437B)
---
1 .Dd 2021-11-03
2 .Dt PARTAGE.CONF 5
3 .Os POSIX.1-2017
4 .Sh NAME
5 .Nm partage.conf
6 .Nd partage configuration file format
7 .Sh DESCRIPTION
8 .Nm
9 is the configuration file for the HTTP file sharing system,
10 .Xr partage 1 .
11 .Sh CONFIGURATION
12 Here are the settings that can be set:
13 .Bl -tag -width Ds
14 .It Ic listen Ar socket
15 Have the program listen on
16 .Ar socket .
17 This socket can be specified either as a TCP socket:
18 .Ar host:port
19 or as a Unix socket:
20 .Ar /path/to/partage.sock .
21 When using Unix sockets, the program will serve content using the
22 .Em FastCGI
23 protocol.
24 .It Ic user Ar user
25 Username that the program will drop privileges to upon startup. When
26 using Unix sockets, the owner of the socket will be changed to this user.
27 .It Ic group Ar group
28 Group that the program will drop privileges to upon startup (require that
29 .Ic user
30 is set). When using Unix sockets, the owner group of the socket will be
31 changed to this group.
32 .It Ic chroot Pa dir
33 Directory to chroot into upon startup. When specified, all other path
34 must be set within the chroot directory.
35 .It Ic baseuri Ar uri
36 Base URI to use when constructing hyper links.
37 .It Ic rootdir Pa dir
38 Directory containing static files.
39 .It Ic tmplpath Pa dir
40 Directory containing template files.
41 .It Ic filepath Pa dir
42 Directory where uploaded files must be written to.
43 .It Ic metapath Pa dir
44 Directory where metadata for uploaded files will be saved.
45 .It Ic filectx Pa context
46 URI context to use for serving files.
47 .It Ic maxsize Ar size
48 Maximum size per file to accept for uploads.
49 .It Ic expiry Ar time
50 Default expiration time to set for uploads.
51 .El
52 .Sh EXAMPLE
53 Configuration suitable for use with
54 .Xr httpd 8
55 using fastcgi:
56 .Bd -literal -offset indent
57 listen = /run/partage.sock
58 baseuri = https://domain.tld
59 user = www
60 group = daemon
61 chroot = /var/www
62 rootdir = /htdocs/static
63 filepath = /htdocs/files
64 metapath = /htdocs/meta
65 tmplpath = /htdocs/templates
66 filectx = /d/
67 maxsize = 10737418240 # 10 Gib
68 expiry = 86400 # 24 hours
69 .Ed
70
71 Mathing
72 .Xr httpd.conf 5
73 configuration:
74 .Bd -literal -offset indent
75 server "domain.tld" {
76 listen on * tls port 443
77 connection { max request body 10737418240 }
78 location "*" {
79 fastcgi socket "/run/partage.sock"
80 }
81 }
82 types { include "/usr/share/misc/mime.types" }
83 .Ed
84
85 .Sh SEE ALSO
86 .Xr partage 1 ,
87 .Xr partage-trash 1 ,
88 .Xr httpd 8,
89 .Xr httpd.conf 5
90 .Sh AUTHORS
91 .An Willy Goiffon Aq Mt dev@z3bra.org