lutim.conf.template 8.32 KB
Newer Older
Luc Didry's avatar
Luc Didry committed
1 2
# vim:set sw=4 ts=4 sts=4 ft=perl expandtab:
{
3 4 5 6 7 8
    ####################
    # 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:8080'],
Luc Didry's avatar
Luc Didry committed
10 11 12
        # if you use Lutim behind a reverse proxy like Nginx, you want to set proxy to 1
        # if you use Lutim directly, let it commented
        #proxy  => 1,
Luc Didry's avatar
Luc Didry committed
13
    },
14 15

    ################
16
    # Lutim settings
17 18 19 20
    ################

    # put a way to contact you here and uncomment it
    # mandatory
Luc Didry's avatar
Luc Didry committed
21
    #contact           => 'John Doe, admin[at]example.com',
22 23 24 25 26

    # random string used to encrypt cookies
    # mandatory
    secrets           => ['fdjsofjoihrei'],

Luc Didry's avatar
Luc Didry committed
27 28 29 30
    # choose a theme. See the available themes in `themes` directory
    # optional, default is 'default'
    #theme         => 'default',

31 32 33 34
    # length of the images random URL
    # optional, default is 8
    #length            => 8,

35 36 37 38
    # length of the encryption key
    # optional, default is 8
    #crypto_key_length => 8,

39 40 41 42 43 44 45 46
    # 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,

Luc Didry's avatar
Luc Didry committed
47
    # anti-flood protection delay, in seconds
48
    # users won't be able to ask Lutim to download images more than one per anti_flood_delay seconds
Luc Didry's avatar
Luc Didry committed
49
    # optional, default is 5
50
    #anti_flood_delay  => 5,
Luc Didry's avatar
Luc Didry committed
51

52
    # twitter account which will appear on twitter cards
53
    # see https://dev.twitter.com/docs/cards/validation/validator to register your Lutim instance on twitter
54 55 56 57 58 59 60 61 62 63 64 65 66 67
    # optional, default is @framasky
    #tweet_card_via    => '@framasky',

    # max image size, in octets
    # you can write it 10*1024*1024
    # optional, default is 10485760
    #max_file_size     => 10485760,

    # 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&rec=1',

    # if you want to include something in the right of the screen, put it here
68
    # here's an example to put the logo of your hoster
69 70 71
    # optional, no default
    #hosted_by         => 'My super hoster <img src="http://hoster.example.com" alt="Hoster logo">',

72
    # DEPRECATED DEPRECATED DEPRECATED DEPRECATED DEPRECATED DEPRECATED DEPRECATED DEPRECATED DEPRECATED DEPRECATED
73
    # Lutim now checks if the X-Forwarded-Proto header is present and equal to https.
74 75 76 77
    # set to 1 if you use Lutim behind a secure web server
    # optional, default is 0
    #https             => 0,

78
    # broadcast_message which will displayed on all pages of Lutim (but no in json response)
79 80 81 82 83 84 85 86 87 88 89 90 91
    # optional, no default
    #broadcast_message => 'Maintenance',

    # 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'],

    # default time limit for files
    # valid values are 0, 1, 7, 30 and 365
    # optional, default is 0 (no limit)
    #default_delay     => 0,

92
    # comma-separated values proposed for delays
93 94
    # optional, default is '0,1,7,30,365'
    #proposed_delays         => '0,1,7,30,365',
Luc Didry's avatar
Luc Didry committed
95

96 97 98 99 100 101 102 103 104
    # 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,

    # if set to 1, all the images will be encrypted and the encryption option will no be displayed
    # optional, default is 0
    #always_encrypt    => 0,

Luc Didry's avatar
Luc Didry committed
105 106 107 108
    # length of the image's delete token
    # optional, default is 24
    #token_length      => 24,

Luc Didry's avatar
Luc Didry committed
109 110
    # URL sub-directory in which you want Lutim to be accessible
    # example: you want to have Lutim under https://example.org/lutim/
111
    # => set prefix to '/lutim' or to '/lutim/', it doesn't matter
Luc Didry's avatar
Luc Didry committed
112
    # optional, defaut is /
113
    #prefix            => '/',
Luc Didry's avatar
Luc Didry committed
114

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

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

Luc Didry's avatar
Luc Didry committed
127 128 129 130 131 132 133 134 135 136
    # 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 => 'lutim',
    #    host     => 'localhost',
    #    #user     => 'DBUSER',
    #    #pwd      => 'DBPASSWORD'
    #},

Luc Didry's avatar
Luc Didry committed
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
    # use Minion instead of directly increase counters
    # need to launch a minion worker service if enabled
    # optional, Minion is disabled by default
    #minion => {
    #    enabled => 0,
    #    # Which Minion backend to use?
    #    # valid values are sqlite and postgresql (all lowercase)
    #    # mandatory if Minion is enabled, default is sqlite
    #    dbtype  => 'sqlite',
    #    # SQLite ONLY - only used if if you choose sqlite as Minion backend, define the path to the minion database
    #    # you can define it relative to lutim directory or set an absolute path
    #    # remember that it has to be in a directory writable by Lutim user
    #    # optional, default is minion.db
    #    db_path => 'minion.db',
    #    # PostgreSQL ONLY - only used if you choose postgresql as Minion backend
    #    # these are the credentials to access the Minion's PostgreSQL database
    #    # mandatory if you choosed postgresql as Minion backend, no default
    #    pgdb => {
    #        database => 'lutim_minion',
    #        host     => 'localhost',
    #        #user     => 'DBUSER',
    #        #pwd      => 'DBPASSWORD'
    #    }
    #},

Luc Didry's avatar
Luc Didry committed
162
    # define the height of the thumbnails generated at users' will
Luc Didry's avatar
Luc Didry committed
163 164 165 166 167 168 169
    # this is not the height of the thumbnails send after upload,
    # we're talking about thumbnails generated when someone asked for
    # https://example.org/lutim/tesrinp?thumb
    # this works only if you have ImageMagick
    # optional, default is 100 (pixels)
    #thumbnail_size => 100,

170 171 172 173 174 175 176 177
    # maximum number of files that can be downloaded as a single zip archive
    # if too many files are asked, it results a timeout, so Lutim split the zip URL
    # in multiple URLs, each with max_file_size images.
    # timeout behavior depends heavily on your server ressources (CPU) and if images
    # are encrypted
    # optional, default is 15
    #max_files_in_zip => 15,

Luc Didry's avatar
Luc Didry committed
178 179 180 181 182 183 184
    # maximum size (in MB) of memory allowed for the image cache
    # Lutim has a built-in memory-based image cache to accelerate responses to often-viewed images.
    # This setting makes the cache remove oldest viewed image if the cache size is over it.
    # If set to 0, the cache is disabled
    # optional, default is 0
    #cache_max_size => 0,

185
    ##########################
186
    # Lutim cron jobs settings
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
    ##########################

    # number of days shown in /stats page (used with script/lutim cron stats)
    # optional, default is 365
    #stats_day_num     => 365,

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

    # max size of the files directory, in octets
    # used by script/lutim 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/lutim cron watch)
    # valid values are 'warn', 'stop-upload' and 'delete'
    # please, see readme
206
    # optional, default is 'warn'
207
    #policy_when_full  => 'warn',
Luc Didry's avatar
Luc Didry committed
208 209 210 211 212

    # 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
    #delete_no_longer_viewed_files => 90
Luc Didry's avatar
Luc Didry committed
213
};