README.md

   1 # About
   2 Temp file sharing application source code, stores files and deletes after X amount of time. Forked from Uguu.se available [here](https://github.com/nokonoko/uguu).
   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/pierre-alain-b/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 * 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).
  16 * Make the Uguu/public/files and Uguu/rain/cache directory modifiable by the web server user:
  17 `chown -R www-data:www-data /path/to/Uguu/public/files` and `chown -R www-data:www-data /path/to/Uguu/rain/cache`
  18 * Make sure the Uguu/public/files folder is not indexable, you may use a virtual host config similar to this one:
  19
  20 ```
  21 <VirtualHost *:80>
  22         ServerName path.to.uguu
  23
  24         DocumentRoot /var/www/Uguu/
  25         <Directory /var/www/Uguu/>
  26                 AllowOverride All
  27                 Require all granted
  28         </Directory>
  29
  30         Alias "/files" "/var/www/Uguu/public/files/"
  31         <Directory /var/www/Uguu/public/files/>
  32                 AllowOverride None
  33                 Options -Indexes
  34                 Require all granted
  35         </Directory>
  36
  37 </VirtualHost>
  38 ```
  39
  40 # Using the API
  41
  42   * Leaving POST value 'name' empty will cause it to save using the original filename.
  43   * Leaving POST value 'randomname' empty will cause it to use original filename or custom name if 'name' is set to file.ext.
  44
  45   * Putting anything into POST value 'randomname' will cause it to return a random filename + ext (xxxxxx.ext).
  46   * Putting a custom name into POST value 'name' will cause it to return a custom filename (yourpick.ext).
  47
  48   E.g:
  49   * curl -i -F name=test.jpg -F file=@localfile.jpg http://path.to.uguu/api.php?d=upload (HTML Response)
  50   * curl -i -F name=test.jpg -F file=@localfile.jpg http://path.to.uguu/api.php?d=upload-tool (Plain text Response)