README.md

   1 # About
   2 [Uguu.se](http://uguu.se) source code, stores files and deletes after X amount of time.
   3
   4 # Install
   5 Tested with:
   6 * Nginx+PHP5-FPM (PHP 5.4) on Debian 7 Wheezy
   7 * Apache (PHP 5.4) on Ubuntu 14.04 LTS
   8 * Nginx+PHP5-FPM (PHP 5.6) on Debian 8 Jessie
   9
  10 Modify
  11 * Modify includes/core.php where to save files and other paths.
  12 * Set correct paths in several other files. (Will add fix for this via config file instead).
  13 * Change uguu.se to your own name in several files.
  14 * Cron with check.sh: `crontab -e`
  15 * Some extensions are blocked by default, this can be changed via includes/core.php's $block array.
  16 * Everything else to your likings.
  17
  18 Change php.ini and nginx.conf settings to allow bigger uploads.
  19
  20 Make the uguu/ directory modifiable to the nginx user:
  21 `setfacl -m u:www-data:rwx /path/to/uguu/directory/`
  22
  23 # Todo
  24
  25 * Restructure files.
  26 * Make global config file.
  27 * Probably a lot of things but I'm a lazy fuck, come with suggestions.
  28
  29
  30 # Using the API
  31
  32   * Leaving POST value 'name' empty will cause it to save using the original filename.
  33   * Leaving POST value 'randomname' empty will cause it to use original filename or custom name if 'name' is set to file.ext.
  34
  35   * Putting anything into POST value 'randomname' will cause it to return a random filename + ext (xxxxxx.ext).
  36   * Putting a custom name into POST value 'name' will cause it to return a custom filename (yourpick.ext).
  37
  38   E.g:
  39   * curl -i -F name=test.jpg -F file=@localfile.jpg http://uguu.se/api.php?d=upload (HTML Response)
  40   * curl -i -F name=test.jpg -F file=@localfile.jpg http://uguu.se/api.php?d=upload-tool (Plain text Response)
  41
  42
  43 This will probably get changed later since it's messy and unpractical.
  44
  45 # Contact
  46
  47 [neku@pomf.se](mailto:neku@pomf.se) or [@Nekunekus](https://twitter.com/nekunekus).