YunoHost-Apps/lutim_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/lutim_ynh.git synced 2024-09-03 19:36:24 +02:00
Code Issues Activity Actions
lutim_ynh/sources/lutim-master/README.md
Maniack Crudelis f49b7a58a6 mise à jour
2015-03-10 12:47:07 +01:00

14 KiB
Raw Blame History

Lutim

What Lutim means?

It means Let's Upload That Image.

What does it do?

It stores images and allows you to see them, download them or share them on social networks. From version 0.5, the gif images can be displayed as animated gifs in Twitter, but you need a HTTPS server (Twitter requires that. Lutim detects if you have a HTTPS server and displays an static image twitter card if you don't);

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.

License

Lutim is licensed under the terms of the AGPL. See the LICENSE file.

Official instance

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.

Lutim's logo

Dependencies

  • 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

Thumbnails and animated gifs in Twitter dependancy

If you want to provide thumbnails of uploaded images or have animated gifs in Twitter, you have to install the ImageMagick image manipulation software (http://www.imagemagick.org/) and the Image::Magick CPAN module.

On Debian, you can do:

sudo apt-get install perlmagick

Twitter integration

If you want to share images of your Lutim instance on Twitter, you have to register your site at https://cards-dev.twitter.com/validator.

Other social networks integration

It seems that you only need to put the Lutim' social page link (the one with ?t) in your post and it will be automatically embedded.

Installation

After installing Carton :

git clone https://git.framasoft.org/luc/lutim.git
cd lutim
carton install
cp lutim.conf.template lutim.conf
vi lutim.conf

Configuration

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;
  • token_length : length of the secret token used to allow people to delete their images when they want;
  • stats_day_num : when you generate statistics with script/lutim cron stats, you will have stats for the last stats_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 than keep_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: ['http://1.example.com', 'http://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 the script/lutim cron cleanfiles command

Usage

Starting Lutim from Command line

carton exec hypnotoad script/lutim

Starting Lutim with the init script

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

Update

git pull
carton install
carton exec hypnotoad script/lutim

Yup, that's all (Mojolicious magic), it will listen at "http://127.0.0.1:8080".

For more options (interfaces, user, etc.), change the configuration in lutim.conf (have a look at http://mojolicio.us/perldoc/Mojo/Server/Hypnotoad#SETTINGS for the available options).

Warning!!!

If you want to update to Lutim 0.3, from a previous version, you'll have to modify the database.

sqlite3 lutim.db
PRAGMA writable_schema = 1;
UPDATE SQLITE_MASTER SET SQL = 'CREATE TABLE lutim ( short TEXT PRIMARY KEY, path TEXT, footprint TEXT, enabled INTEGER, mediatype TEXT, filename TEXT, counter INTEGER, delete_at_first_view INTEGER, delete_at_day INTEGER, created_at INTEGER, created_by TEXT, last_access_at INTEGER, mod_token TEXT)' WHERE NAME = 'lutim';
PRAGMA writable_schema = 0;

Warning!!!

If you want to update to Lutim 0.5, from a previous version, you'll have to modify the database.

sqlite3 lutim.db
PRAGMA writable_schema = 1;
UPDATE SQLITE_MASTER SET SQL = 'CREATE TABLE lutim ( short TEXT PRIMARY KEY, path TEXT, footprint TEXT, enabled INTEGER, mediatype TEXT, filename TEXT, counter INTEGER, delete_at_first_view INTEGER, delete_at_day INTEGER, created_at INTEGER, created_by TEXT, last_access_at INTEGER, mod_token TEXT, width INTEGER, height INTEGER)' WHERE NAME = 'lutim';
PRAGMA writable_schema = 0;

Reverse proxy

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  http://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;
    }
}

Cron jobs

Lutim have commands which can be used in cron jobs.

To see what commands are available:

carton exec script/lutim cron

Statistics

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

Delete IP adresses from database

To automatically delete the IP addresses of image's senders after a configurable delay:

carton exec script/lutim cron cleanbdd

Delete expired files

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

Watch the size of the files directory

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 by cron) ;
  • stop-upload prints a message on the standard out and creates the stop-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

Broadcast message

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.

Encryption

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.

API

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" http://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.

Shutter integration

See where Shutter (http://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 (http://lut.im), feel free to edit it for your own instance.

Internationalization

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/Lutim/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 😄.

Others projects dependancies

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 and freezeframe.js (slightly modified) to be able to freeze animated gifs in twitter card.

Licenses for the icons fonts are in public/font/LICENSE.txt.

Main developers

Contributors