lufi.conf.template 11.2 KB
Newer Older
Luc Didry's avatar
Luc Didry committed
1
2
3
4
5
6
7
8
# vim:set sw=4 ts=4 sts=4 ft=perl expandtab:
{
    ####################
    # Hypnotoad settings
    ####################
    # see http://mojolicio.us/perldoc/Mojo/Server/Hypnotoad for a full list of settings
    hypnotoad => {
        # array of IP addresses and ports you want to listen to
Luc Didry's avatar
Luc Didry committed
9
        listen => ['http://127.0.0.1:8081'],
10
        # if you use Lufi behind a reverse proxy like Nginx, you want to set proxy to 1
11
12
        # if you use Lufi directly, let it commented
        #proxy  => 1,
Luc Didry's avatar
Luc Didry committed
13

14
15
16
17
        # Please read http://mojolicious.org/perldoc/Mojo/Server/Hypnotoad#workers
        # to adjust this to your server
        workers => 30,
        clients => 1,
Luc Didry's avatar
Luc Didry committed
18
19
20
    },

    # put a way to contact you here and uncomment it
Luc Didry's avatar
Luc Didry committed
21
    # you can put some HTML in it
Luc Didry's avatar
Luc Didry committed
22
    # MANDATORY
Luc Didry's avatar
Luc Didry committed
23
24
25
26
27
28
    #contact       => '<a href="https://contact.example.com">Contact page</a>',

    # put an URL or an email address to receive file reports and uncomment it
    # it's for make reporting illegal files easy for users
    # MANDATORY
    #report => 'report@example.com',
Luc Didry's avatar
Luc Didry committed
29
30
31
32
33

    # array of random strings used to encrypt cookies
    # optional, default is ['fdjsofjoihrei'], PLEASE, CHANGE IT
    #secrets        => ['fdjsofjoihrei'],

Luc Didry's avatar
Luc Didry committed
34
35
36
37
    # choose a theme. See the available themes in `themes` directory
    # optional, default is 'default'
    #theme         => 'default',

Luc Didry's avatar
Luc Didry committed
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
    # length of the random URL
    # optional, default is 8
    #length            => 8,

    # how many URLs will be provisioned in a batch ?
    # optional, default is 5
    #provis_step       => 5,

    # max number of URLs to be provisioned
    # optional, default is 100
    #provisioning      => 100,

    # length of the modify/delete token
    # optional, default is 32
    #token_length      => 32,

Luc Didry's avatar
Luc Didry committed
54
55
56
57
58
    # max file size, in octets
    # you can write it 100*1024*1024
    # optional, no default
    #max_file_size     => 104857600,

Luc Didry's avatar
Luc Didry committed
59
60
61
62
63
    # if you want to have piwik statistics, provide a piwik image tracker
    # only the image tracker is allowed, no javascript
    # optional, no default
    #piwik_img         => 'https://piwik.example.org/piwik.php?idsite=1&amp;rec=1',

64
    # broadcast_message which will displayed on the index page
Luc Didry's avatar
Luc Didry committed
65
66
67
    # optional, no default
    #broadcast_message => 'Maintenance',

Luc Didry's avatar
Luc Didry committed
68
69
70
71
72
73
74
75
76
77
    # default time limit for files
    # valid values are 0, 1, 7, 30 and 365
    # optional, default is 0 (no limit)
    #default_delay     => 0,

    # number of days after which the images will be deleted, even if they were uploaded with "no delay" (or value superior to max_delay)
    # a warning message will be displayed on homepage
    # optional, default is 0 (no limit)
    #max_delay         => 0,

Luc Didry's avatar
Luc Didry committed
78
79
    # size thresholds: if you want to define max delays for different sizes of file
    # the keys are size in Bytes, you can't have 10*1000*10000 as key
Luc Didry's avatar
Luc Didry committed
80
    # if a file is smaller than the smallest configured size, it will have a expiration delay of max_delay (see above)
Luc Didry's avatar
Luc Didry committed
81
82
83
84
85
    # optional, default is using max_delay (see above) for all sizes
    #delay_for_size  => {
    #    10000000   => 90, # between 10MB and 50MB => max is 90 days, less than 10MB => max is max_delay (see above)
    #    50000000   => 60, # between 50MB ans 1GB  => max is 60 days
    #    1000000000 => 2,  # more than 1GB         => max is 2 days
86
    #},
Luc Didry's avatar
Luc Didry committed
87

Luc Didry's avatar
Luc Didry committed
88
89
    # URL sub-directory in which you want Lufi to be accessible
    # example: you want to have Lufi under https://example.org/lufi/
Luc Didry's avatar
Luc Didry committed
90
91
92
93
94
95
96
97
98
99
100
101
    # => set prefix to '/lufi' or to '/lufi/', it doesn't matter
    # optional, defaut is /
    #prefix        => '/',

    # array of authorized domains for API calls.
    # if you want to authorize everyone to use the API: ['*']
    # optional, no domains allowed by default
    #allowed_domains   => ['http://1.example.com', 'http://2.example.com'],

    # if set, the shortened URLs will use this domain
    # optional
    #fixed_domain => 'example.org',
Luc Didry's avatar
Luc Didry committed
102
103
104
105
106
107
108
109
110
111
112
113

    # Mail configuration
    # See https://metacpan.org/pod/Mojolicious::Plugin::Mail#EXAMPLES
    # Optional, default to sendmail method with no arguments
    #mail => {
    #    # Valid values are 'sendmail' and 'smtp'
    #    how => 'smtp',
    #    howargs => ['smtp.example.org']
    #},

    # Email sender address
    # Optional, default to no-reply@lufi.io
114
    #mail_sender => 'no-reply@lufi.io',
115

Luc Didry's avatar
Luc Didry committed
116
    # choose what database you want to use
Luc Didry's avatar
Luc Didry committed
117
    # valid choices are sqlite, postgresql and mysql (all lowercase)
Luc Didry's avatar
Luc Didry committed
118
119
120
121
    # optional, default is sqlite
    #dbtype => 'sqlite',

    # SQLite ONLY - only used if dbtype is set to sqlite
122
123
    # define a path to the SQLite database
    # you can define it relative to lufi directory or set an absolute path
Luc Didry's avatar
Luc Didry committed
124
    # remember that it has to be in a directory writable by Lufi user
125
126
    # optional, default is lufi.db
    #db_path           => 'lufi.db',
127

Luc Didry's avatar
Luc Didry committed
128
129
130
131
132
133
    # PostgreSQL ONLY - only used if dbtype is set to postgresql
    # these are the credentials to access the PostgreSQL database
    # mandatory if you choosed postgresql as dbtype
    #pgdb => {
    #    database => 'lufi',
    #    host     => 'localhost',
Luc Didry's avatar
Luc Didry committed
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
    #    # optional, default is 5432
    #    #port     => 5432,
    #    user     => 'DBUSER',
    #    pwd      => 'DBPASSWORD',
    #    # https://mojolicious.org/perldoc/Mojo/Pg#max_connections
    #    # optional, default is 1
    #    #max_connections => 1,
    #},

    # MySQL ONLY - only used if dbtype is set to mysql
    # these are the credentials to access the MySQL database
    # mandatory if you choosed mysql as dbtype
    #mysqldb => {
    #    database => 'lufi',
    #    host     => 'localhost',
    #    # optional, default is 3306
    #    #port     => 3306,
    #    user     => 'DBUSER',
    #    pwd      => 'DBPASSWORD',
    #    # https://metacpan.org/pod/Mojo::mysql#max_connections
    #    # optional, default is 5 (set to 0 to disable persistent connections)
    #    #max_connections => 5,
Luc Didry's avatar
Luc Didry committed
156
157
    #},

Luc Didry's avatar
Fix #13    
Luc Didry committed
158
159
160
161
162
163
164
    # define a path to the upload directory, where the uploaded files will be stored
    # you can define it relative to lufi directory or set an absolute path
    # remember that it has to be in a directory writable by Lufi user
    # DO NOT CHANGE THIS IF FILES HAVE BEEN ALREADY UPLOADED: THEY WILL NOT BE DOWNLOADABLE ANYMORE
    # optional, default is 'files'
    #upload_dir           => 'files',

165
166
167
168
    # set `ldap` if you want that only authenticated users can upload files
    # please note that everybody can still download files
    # optional, no default
    #ldap => {
Luc Didry's avatar
Luc Didry committed
169
170
171
172
173
174
    #    uri         => 'ldaps://ldap.example.org',                 # server URI
    #    user_tree   => 'ou=users,dc=example,dc=org',               # search base DN
    #    bind_dn     => 'uid=ldap_user,ou=users,dc=example,dc=org', # search bind DN
    #    bind_pwd    => 'secr3t',                                   # search bind password
    #    user_attr   => 'uid',                                      # user attribute (uid, mail, sAMAccountName, etc.)
    #    user_filter => '(!(uid=ldap_user))',                       # user filter (to exclude some users, etc.)
Luc Didry's avatar
Luc Didry committed
175
176
177
178
179
180
    #    # optional start_tls configuration. See https://metacpan.org/pod/distribution/perl-ldap/lib/Net/LDAP.pod#start_tls
    #    # don't set or uncomment if you don't want to configure it
    #    start_tls => {
    #       verify     => 'optional',
    #       clientcert => '/etc/ssl/certs/ca-bundle.pem'
    #    }
181
182
    #},

183
184
185
186
    # set `htpasswd` if you want to use an htpasswd file instead of ldap
    # see 'man htpasswd' to know how to create such file
    #htpasswd => 'lufi.passwd',

Armando Lüscher's avatar
Armando Lüscher committed
187
    # if you've set ldap above, the session will last `session_duration` seconds before
188
189
190
191
    # the user needs to reauthenticate
    # optional, default is 3600
    #session_duration => 3600,

192
    # allow to add a password on files, asked before allowing to download files
193
    # optional, default is 0
194
195
    #allow_pwd_on_files => 0,

196
197
198
199
    # force all files to be in "Burn after reading mode"
    # optional, default is 0
    #force_burn_after_reading => 0,

Luc Didry's avatar
Luc Didry committed
200
    # if set, the files' URLs will always use this domain
201
    # optional, no default
Luc Didry's avatar
Luc Didry committed
202
203
    #fixed_domain => 'example.org',

204
205
206
207
208
209
210
211
212
    # abuse reasons
    # set an integer in the abuse field of a file in the database and it will not be downloadable anymore
    # the reason will be displayed to the downloader, according to the reasons you will configure here.
    # optional, no default
    #abuse => {
    #   0 => 'Copyright infringment',
    #   1 => 'Illegal content',
    #},

213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
    # Content-Security-Policy header that will be sent by Lufi
    # Set to '' to disable CSP header
    # https://content-security-policy.com/ provides a good documentation about CSP.
    # https://report-uri.com/home/generate provides a tool to generate a CSP header.
    # optional, default is "base-uri 'self'; connect-src 'self'; default-src 'none'; font-src 'self'; form-action 'self'; frame-ancestors 'none'; img-src 'self' blob:; media-src blob:; script-src 'self' 'unsafe-inline' 'unsafe-eval'; style-src 'self' 'unsafe-inline'"
    # the default value is good for `default` and `milligram` themes
    #csp => "base-uri 'self'; connect-src 'self'; default-src 'none'; font-src 'self'; form-action 'self'; frame-ancestors 'none'; img-src 'self' blob:; media-src blob:; script-src 'self' 'unsafe-inline' 'unsafe-eval'; style-src 'self' 'unsafe-inline'"

    # X-Frame-Options header that will be sent by Lufi
    # Valid values are: 'DENY', 'SAMEORIGIN', 'ALLOW-FROM https://example.com/'
    # Set to '' to disable X-Frame-Options header
    # See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options
    # Please note that this will add a "frame-ancestors" directive to the CSP header (see above) accordingly
    # to the chosen setting (See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/frame-ancestors)
    # optional, default is 'DENY'
    #x_frame_options => 'DENY',

    # X-Content-Type-Options that will be sent by Lufi
    # See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options
    # Set to '' to disable X-Content-Type-Options header
    # optional, default is 'nosniff'
    #x_content_type_options => 'nosniff',

    # X-XSS-Protection that will be sent by Lufi
    # See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection
    # Set to '' to disable X-XSS-Protection header
    # optional, default is '1; mode=block'
    #x_xss_protection => '1; mode=block',

242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
    #########################
    # Lufi cron jobs settings
    #########################

    # number of days senders' IP addresses are kept in database
    # after that delay, they will be deleted from database (used with script/lufi cron cleanbdd)
    # optional, default is 365
    #keep_ip_during    => 365,

    # max size of the files directory, in octets
    # used by script/lufi cron watch to trigger an action
    # optional, no default
    #max_total_size    => 10*1024*1024*1024,

    # default action when files directory is over max_total_size (used with script/lufi cron watch)
    # valid values are 'warn', 'stop-upload' and 'delete'
    # please, see readme
    # optional, default is 'warn'
    #policy_when_full  => 'warn',

    # images which are not viewed since delete_no_longer_viewed_files days will be deleted by the cron cleanfiles task
    # if delete_no_longer_viewed_files is not set, the no longer viewed files will NOT be deleted
    # optional, no default
265
    #delete_no_longer_viewed_files => 90,
Luc Didry's avatar
Luc Didry committed
266
};