Configuration
The configuration file is simple Perl.
The lutim.conf.template
is self-documented but here are the options that you can set (Ø means no default value):
Setting | Description | Optional/mandatory | Default value |
---|---|---|---|
hypnotoad | Address and port to listen to. See http://mojolicio.us/perldoc/Mojo/Server/Hypnotoad for a full list of settings. | optional | See http://mojolicio.us/perldoc/Mojo/Server/Hypnotoad for the default values |
contact | Write something which make people able to contact you (contact form URL, email address, whatever) | mandatory | Ø |
secrets | An array of random string. Used by Mojolicious for encrypting session cookies. | mandatory | Ø |
theme | The theme to use. See available themes in themes directory or write a new one
|
optional | default theme |
length | Length of the random string part of image's URL | optional | 8 |
crypto_key_length | Length of the encryption key | optional | 8 |
provis_step | Lutim provisions random strings for image's URL per pack of provis_step
|
optional | 5 |
provisioning | Number of random strings to provision | optional | 100 |
anti_flood_delay | Anti-flood protection delay, in seconds. Users won't be able to ask Lutim to download images more than one per anti_flood_delay seconds. |
optional | 5 |
tweet_card_via | Twitter account which will appear on twitter cards (see more on Social networks integration | optional | @framasky |
max_file_size | Max image size, in octets. You can write it 1010241024. | optional | 10485760 (10 MiB) |
piwik_img | The Piwik image provides you records of visits without javascript (better privacy than js and cookies) | optional | Ø |
hosted_by | If someone hosts your Lutim instance, you can add some HTML (a logo for example) to make it appear on index page | optional | Ø |
broadcast_message | Put some string (not HTML) here and this message will be displayed on all Lutim pages (not in JSON responses) | optional | Ø |
allowed_domains | Array of authorized domains for API calls. Example: ['http://1.example.com', 'http://2.example.com'] . If you want to authorize everyone to use the API: ['\*'] . |
optional | Ø |
default_delay | Default time limit for images. Valid values are 0, 1, 7, 30 and 365. | optional | 0 (no limit) |
max_delay | Number of days after which the images will be deleted, even if they were uploaded with "no delay" (or value superior to max_delay ). |
optional | 0 (no limit) |
always_encrypt | If set to 1, all the images will be encrypted and the encryption option will no be displayed. | optional | 0 |
token_length | Length of the image's delete/modify token. | optional | 24 |
prefix | URL sub-directory in which you want Lutim to be accessible. Example: you want to have Lutim under https://example.org/lutim/ => set prefix to '/lutim' or to '/lutim/', it doesn't matter. | optional | / |
[dbtype | Which db engine do you wish to use? Valid choices are sqlite and postgresql (all lowercase) | optional | sqlite |
db_path | 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 | lutim.db (this is at the root of the Lutim installation directory) |
pgdb | Hash table containing the informations to connect to the PostgreSQL database if dbtype is postgresql | optional | Ø |
minion | Hash table containing the options to enable Minion (a job queue), choose between SQLite or PostgreSQL backend, path to the SQLite database or PostgreSQL connection informations | optional | Ø |
thumbnail_size | Define the height of the thumbnails generated at users' will | optional | 100 |
stats_day_num | Number of days shown in /stats page (used with script/lutim cron stats) | optional | 365 |
keep_ip_during | 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 | 365 |
max_total_size | Max size of the files directory, in octets. Used by script/lutim cron watch to trigger an action |
optional | Ø |
policy_when_full | 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, have a look at the Cron jobs page. |
optional | warn |
delete_no_longer_viewed_files | Images which are not viewed since delete_no_longer_viewed_files days will be deleted by script/lutim cron cleanfiles . If delete_no_longer_viewed_files is not set, the no longer viewed files will NOT be deleted. |
optional | Ø |
You can now go back to the installation page or go back to wiki's homepage.