README.md

   1 # About
   2 [Uguu.se](http://uguu.se) source code, stores files and deletes after X amount of time.
   3
   4 # Tested with:
   5 * Nginx+PHP5-FPM (PHP 5.4) on Debian 7 Wheezy
   6 * Apache (PHP 5.4) on Ubuntu 14.04 LTS
   7 * Apache (PHP 5.6) on Debian 8 Jessie
   8 * Nginx+PHP5-FPM (PHP 5.6) on Debian 8 Jessie
   9
  10 # Install:
  11
  12 * Deploy base code, for example with `git clone https://github.com/nokonoko/Uguu.git`
  13 * Modify includes/config.php (copy config.template.php as a starting point) to set up the main options for Uguu.
  14 * Some file extensions are blocked by default, this can be changed via includes/config.php's CONFIG_BLOCKED_EXTENSIONS value.
  15 * Copy `rain/template/footer.template.html` as `rain/template/footer.html` and personalize the footer as you wish
  16 * Execute check.sh regularly with cron to delete old files: `crontab -e` and add `0,15,30,45 * * * * bash /path/to/check.sh` (or adapt if you know how cron works).
  17 * Make the Uguu/public/files and Uguu/rain/cache directory modifiable by the web server user:
  18 `chown -R www-data:www-data /path/to/Uguu/public/files` and `chown -R www-data:www-data /path/to/Uguu/rain/cache`
  19 * Make sure the Uguu/public/files folder is not indexable, you may use a virtual host config similar to this one:
  20
  21 ```
  22 <VirtualHost *:80>
  23         ServerName path.to.uguu
  24
  25         DocumentRoot /var/www/Uguu/
  26         <Directory /var/www/Uguu/>
  27                 AllowOverride All
  28                 Require all granted
  29         </Directory>
  30
  31         Alias "/files" "/var/www/Uguu/public/files/"
  32         <Directory /var/www/Uguu/public/files/>
  33           <Files *>
  34             SetHandler default-handler
  35           </Files>
  36           AllowOverride None
  37           Options -Indexes
  38           Require all granted
  39         </Directory>
  40
  41 </VirtualHost>
  42 ```
  43
  44 Or something like this using Nginx:
  45
  46 uguu.se
  47 ```
  48 server{
  49     listen              104.243.35.197:80;
  50     server_name         uguu.se www.uguu.se;
  51
  52     root                        /home/neku/www/uguu/;
  53     autoindex           off;
  54     index                       index.html index.php;
  55
  56 return 301 https://$host$request_uri;
  57
  58     location ~* \.php$ {
  59         fastcgi_pass unix:/var/run/php5-fpm.sock;
  60         fastcgi_intercept_errors on;
  61         fastcgi_index index.php;
  62         fastcgi_split_path_info ^(.+\.php)(.*)$;
  63         include fastcgi_params;
  64         fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
  65     }
  66
  67         error_page 404 /404.html;
  68         error_page 403 /404.html;
  69         location /404.html {
  70         root /home/neku/www;
  71         }
  72 }
  73 ```
  74
  75 a.uguu.se (notice that scripts e.g PHP will NOT be executed from this subdomain)
  76 ```
  77 server{
  78     listen          104.243.35.197:80;
  79     server_name     a.uguu.se www.a.uguu.se;
  80
  81     root            /home/neku/www/files;
  82     autoindex       off;
  83     index           index.html;
  84
  85 return 301 https://$host$request_uri;
  86
  87         error_page      404 /404.html;
  88         error_page      403 /404.html;
  89         location /404.html {
  90         root /home/neku/www;
  91         }
  92 }
  93 ```
  94
  95
  96 # Using the API
  97
  98   * Leaving POST value 'name' empty will cause it to save using the original filename.
  99   * Leaving POST value 'randomname' empty will cause it to use original filename or custom name if 'name' is set to file.ext.
 100
 101   * Putting anything into POST value 'randomname' will cause it to return a random filename + ext (xxxxxx.ext).
 102   * Putting a custom name into POST value 'name' will cause it to return a custom filename (yourpick.ext).
 103
 104   E.g:
 105   * curl -i -F name=test.jpg -F file=@localfile.jpg http://path.to.uguu/api.php?d=upload (HTML Response)
 106   * curl -i -F name=test.jpg -F file=@localfile.jpg http://path.to.uguu/api.php?d=upload-tool (Plain text Response)