It means Let's Upload That Image.
It stores images and allows you to see them, download them or use them in Twitter. Images are indefinitly stored unless you request that they will be deleted at first view or after 24 hours / one week / one month / one year.
Lutim is licensed under the terms of the AGPL. See the LICENSE file.
You can see it working at https://lut.im.
Lutim's logo is an adaptation of Lutin by Godo, licensed under the terms of the CC-BY-SA 3.0 license.
- Carton : Perl dependencies manager, it will get what you need, so don't bother for Perl modules dependencies (but you can read the file
cpanfile
if you want).
sudo cpan Carton
or
sudo apt-get install carton
- But, on another hand, some modules that Carton will install need to be compiled. So you will need some tools:
sudo apt-get install build-essential libssl-dev
If you want to provide thumbnails of uploaded images, you have to install the ImageMagick image manipulation software (https://www.imagemagick.org/) and the Image::Magick CPAN module.
On Debian, you can do:
sudo apt-get install perlmagick
After installing Carton :
git clone https://github.com/ldidry/lutim.git
cd lutim
carton install
cp lutim.conf.template lutim.conf
vi lutim.conf
The lutim.conf.template
is self-documented but here is the options that you can set:
- hypnotoad: address and port to listen to, user and group which runs hypnotoad (if you run Lutim with a different user from what is defined here, be sure that the user which launchs hypnotoad is able to setuid/setgid to the defined user/group, otherwise it will not work and you'll have 100% CPU consumption. Launch hypnotoad with the root user or with the user which is defined here);
- contact: write something which make people able to contact you (contact form URL, email address, whatever) ;
- secrets: an array of random string. Used by Mojolicious for encrypting session cookies.
- piwik_img: the Piwik image provides you records of visits without javascript (better privacy than js and cookies) ;
- length: length of the random string part of image's URL (default is 8) ;
- provis_step: Lutim provisions random strings for image's URL per pack of
provis\_step
(default is 5) ; - provisioning: number of random strings to provision (default is 100) ;
- hosted_by: if someone hosts your Lutim instance, you can add some HTML (a logo for example) to make it appear on index page ;
- tweet_card_via: a Twitter account which will appear on Twitter cards ;
- max_file_size: well, this is explicit (default is 10Mio = 10485760 octets) ;
- https: 1 if you want to provide secure images URLs (default is 0) DEPRECATED, PASS A
X-Forwarded-Proto
HEADER TO LUTIM FROM YOUR REVERSE PROXY INSTEAD ; - stats_day_num: when you generate statistics with
script/lutim cron stats
, you will have stats for the laststats\_day\_num
days (default is 365) ; - keep_ip_during: when you delete IP addresses of image's senders with
script/lutim cron cleanbdd
, the IP addresses of images older thankeep\_ip\_during
days will be deleted (default is 365) ; - broadcast_message: put some string (not HTML) here and this message will be displayed on all Lutim pages (not in JSON responses) ;
- allowed_domains: array of authorized domains for API calls. Example:
['https://1.example.com', 'https://2.example.com']
. If you want to authorize everyone to use the API:['\*']
. - default_delay: what is the default time limit for files? Valid values are 0, 1, 7, 30 and 365;
- max_delay: if defined, the images will be deleted after that delay (in days), even if they were uploaded with "no delay" (or value superior to max_delay) option and a warning message will be displayed on homepage;
- always_encrypt: if set to 1, all images will be encrypted.
- delete_no_longer_viewed_files: if set, the images which have not been viewed since
delete\_no\_longer\_viewed\_files
days will be deleted by thescript/lutim cron cleanfiles
command
carton exec hypnotoad script/lutim
cp utilities/lutim.init /etc/init.d/lutim
cp utilities/lutim.default /etc/default/lutim
chmod +x /etc/init.d/lutim
chown root:root /etc/init.d/lutim /etc/default/lutim
vim /etc/default/lutim
/etc/init.d/lutim start
git pull
carton install
carton exec hypnotoad script/lutim
Yup, that's all (Mojolicious magic), it will listen at "https://127.0.0.1:8080".
For more options (interfaces, user, etc.), change the configuration in lutim.conf
(have a look at https://mojolicio.us/perldoc/Mojo/Server/Hypnotoad#SETTINGS for the available options).
You can use a reverse proxy like Nginx or Varnish (or Apache with the mod_proxy module). The web is full of tutos.
Here's a valid Nginx configuration:
server {
listen 80;
root /path/to/lutim/public;
# This is important for user's privacy !
access_log off;
error_log /var/log/nginx/lutim.error.log;
# This is important ! Make it OK with your Lutim configuration
client_max_body_size 40M;
location ~* ^/(img|css|font|js)/ {
try_files $uri @lutim;
add_header Expires "Thu, 31 Dec 2037 23:55:55 GMT";
add_header Cache-Control "public, max-age=315360000";
# HTTPS only header, improves security
#add_header Strict-Transport-Security "max-age=15768000";
}
location / {
try_files $uri @lutim;
# HTTPS only header, improves security
#add_header Strict-Transport-Security "max-age=15768000";
}
location @lutim {
# Adapt this to your configuration
# My advice: put a varnish between nginx and Lutim, it's really useful when images are widely viewed
proxy_pass https://127.0.0.1:8080;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
# If you want to log the remote port of the image senders, you'll need that
proxy_set_header X-Remote-Port $remote_port;
# Lutim reads this header and understands that the current session is actually HTTPS.
# Enable it if you run a HTTPS server (in this case, don't forgot to change the listen port above)
#proxy_set_header X-Forwarded-Proto https;
# We expect the downsteam servers to redirect to the right hostname, so don't do any rewrites here.
proxy_redirect off;
}
}
Lutim have commands which can be used in cron jobs.
To see what commands are available:
carton exec script/lutim cron
To generate statistics which can be viewed at the address /stats
(we need to reload hypnotoad after the stats generation):
carton exec script/lutim cron stats && carton exec hypnotoad script/lutim
To automatically delete the IP addresses of image's senders after a configurable delay:
carton exec script/lutim cron cleanbdd
To automatically delete files which availability delay is over (when you choose that your image will be deleted after 24h / one week / etc.)
If delete\_no\_longer\_viewed\_files
, the files not viewed since delete\_no\_longer\_viewed\_files
days will be deleted too.
carton exec script/lutim cron cleanfiles
To execute an action when the files directory is heavier than max\_total\_size
.
The available actions are warn
and stop-upload
:
warn
prints a message on the standard out (which is normally mailed to you bycron
) ;stop-upload
prints a message on the standard out and creates thestop-upload
file which prevents uploading and put a warn on Lutim interface ;- DANGEROUS OPTION!!!
delete
prints a message on the standard out and delete older images until the files directory goes under quota.
If the files directory go under quota, the stop-upload
file is deleted. If you want to manually prevents uploading, create a file named stop-upload.manual
.
carton exec script/lutim cron watch
Set a string in the broadcast\_message
option of lutim.conf
and reload the server with:
carton exec hypnotoad script/lutim
It may take a few reloads of page before the message is displayed.
Lutim does encryption on the server if asked to, but does not store the key.
The encryption is made on the server since Lutim is made to be usable even without javascript. If you want to add client-side encryption for javascript-enabled browsers, patches are welcome.
You can add images by using the API. Here's the parameters of the POST
request to /
adress:.
- format: json MANDATORY if you want to get a json response, otherwise it will send a web page
- file: the image file MANDATORY
- delete-day: number of days you want the image to stay OPTIONAL if 0, it will be available undefinitely
- first-view: 1 OPTIONAL if not 0, the image will be deleted at first view
Exemple with curl:
curl -F "format=json" -F "file=@/tmp/snap0001.jpg" https://lut.im
You can allow people to use your instance of Lutim from other domains.
Add the allowed domains as an array in the allowed\_domains
conf option. Put '[\*]
' if you want to allow all domains.
See where Shutter (https://en.wikipedia.org/wiki/Shutter_%28software%29) keeps its plugins on your computer.
On my computer, it's in /usr/share/shutter/resources/system/upload\_plugins/upload
.
Then:
sudo cp utilities/Shutter.pm /usr/share/shutter/resources/system/upload_plugins/upload/Lutim.pm
And restart Shutter if it was running.
Of course, this plugin is configured for the official instance of Lutim (https://lut.im), feel free to edit it for your own instance.
Lutim comes with English and French languages. It will choose the language to display from the browser's settings.
If you want to add more languages, for example German:
cd lib/I18N
cp en.pm de.pm
vim de.pm
There's just a few sentences, so it will be quick to translate. Please consider to send me you language file in order to help the other users 😄.
Lutim is written in Perl with the Mojolicious framework, uses the Twitter bootstrap framework to look not too ugly, JQuery and JQuery File Uploader (slightly modified) to add some modernity, Raphaël and morris.js for stats graphs.
- Luc Didry, aka Sky (https://www.fiat-tux.fr), main developer, @framasky
- Jean-Bernard Marcon, aka Goofy (https://github.com/goofy-bz)
- Jean-Christophe Bach (https://github.com/jcb)