diff --git a/README.md b/README.md index 10d31b6..6513e84 100644 --- a/README.md +++ b/README.md @@ -61,31 +61,31 @@ The `lutim.conf.template` is self-documented but here is the options that you ca * 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) ; +* 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) ; +* 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) ; +* 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 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 +* 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 -### Command line +### Starting Lutim from Command line ``` carton exec hypnotoad script/lutim ``` -### Init script +### Starting Lutim with the init script ``` cp utilities/lutim.init /etc/init.d/lutim cp utilities/lutim.default /etc/default/lutim @@ -119,7 +119,7 @@ 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. +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: ``` @@ -194,13 +194,13 @@ 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. +If `delete_no_longer_viewed_files`, the files not viewed since `delete_no_longer_viewed_files` days will be deleted too. ```shell 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`. +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 ; @@ -213,7 +213,7 @@ carton exec script/lutim cron watch ``` ## Broadcast message -Set a string in the `broadcast\_message` option of `lutim.conf` and reload the server with: +Set a string in the `broadcast_message` option of `lutim.conf` and reload the server with: ```shell carton exec hypnotoad script/lutim ``` @@ -243,11 +243,11 @@ 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. +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 () keeps its plugins on your computer. -On my computer, it's in `/usr/share/shutter/resources/system/upload\_plugins/upload`. +On my computer, it's in `/usr/share/shutter/resources/system/upload_plugins/upload`. Then: ``` @@ -273,8 +273,10 @@ There's just a few sentences, so it will be quick to translate. Please consider ## Others projects dependancies Lutim is written in Perl with the [Mojolicious](http://mojolicio.us) framework, uses the [Twitter bootstrap](http://getbootstrap.com) framework to look not too ugly, [JQuery](http://jquery.com) and [JQuery File Uploader](https://github.com/danielm/uploader/) (slightly modified) to add some modernity, [Raphaël](http://raphaeljs.com/) and [morris.js](http://www.oesmith.co.uk/morris.js/) for stats graphs. -## Contributors +## Core developer * Luc Didry, aka Sky (), main developer, [@framasky](https://twitter.com/framasky) + +## Contributors * Jean-Bernard Marcon, aka Goofy () * Jean-Christophe Bach () * Florian Bigard, aka Chocobozzz ()