Adding options in the config file

[uguu.git] / README.md

diff --git a/README.md b/README.md
index 5fec99faba40186c2d3876524acbf71f422b9bac..9daab4162d8e291a27d8c552a8b73aa0d83563d7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,40 +1,29 @@
 # About
-[Uguu.se](http://uguu.se) source code, stores files and deletes after X amount of time.
+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).
 
 # Install
 Tested with:
-* Nginx+PHP5-FPM (PHP 5.4) on Debian 7 Wheezy 
+* Nginx+PHP5-FPM (PHP 5.4) on Debian 7 Wheezy
 * Apache (PHP 5.4) on Ubuntu 14.04 LTS
+* Apache (PHP 5.6) on Debian 8 Jessie
 * Nginx+PHP5-FPM (PHP 5.6) on Debian 8 Jessie
 
-Modify 
-* core.php on where to save the files (line 4) and the prepend to the uploaded URL (line 26)
-* Cron with check.sh: `crontab -e` 
-* Everything else to your likings.
-
-Change php.ini and nginx.conf settings to allow bigger uploads.
-
-Make the uguu/ directory modifiable to the nginx user:
-`setfacl -m u:www-data:rwx /path/to/uguu/directory/`
-
-# Todo
-
-Proper design, commit new design and updated code (when finished, in preview phase).
+Modify
+* Modify includes/config.php (copy config.template.php as a starting point) to determine the path and URL to the app, the default retention time and other config points
+* Execute check.sh 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).
+* Some extensions are blocked by default, this can be changed via includes/config.php's CONFIG_BLOCKED_EXTENSIONS value.
 
+Make the uguu/public/files and uguu/rain/cache directory modifiable to the web server user:
+`chown -R www-data:www-data /path/to/uguu/public/files` and `chown -R www-data:www-data /path/to/uguu/rain/cache`
 
 # Using the API
 
-  Be sure to set a user agent, otherwise CF might reject you as malicious.
-
-  Leaving POST value 'name' empty will cause it to save using the original filename.
-  Leaving POST value 'randomname' empty will cause it to use original filename or custom name if 'name' is set to file.ext.
-  
-  Putting anything into POST value 'randomname' will cause it to return a random filename + ext (xxxxxx.ext).
-  Putting a custom name into POST value 'name' will cause it to return a custom filename (yourpick.ext).
-
-
-This will probably get changed later since it's messy and unpractical.
+  * Leaving POST value 'name' empty will cause it to save using the original filename.
+  * Leaving POST value 'randomname' empty will cause it to use original filename or custom name if 'name' is set to file.ext.
 
-# Contact
+  * Putting anything into POST value 'randomname' will cause it to return a random filename + ext (xxxxxx.ext).
+  * Putting a custom name into POST value 'name' will cause it to return a custom filename (yourpick.ext).
 
-[neku@pomf.se](mailto:neku@pomf.se) or [@Nekunekus](https://twitter.com/nekunekus).
+  E.g:
+  * curl -i -F name=test.jpg -F file=@localfile.jpg http://path.to.uguu/api.php?d=upload (HTML Response)
+  * curl -i -F name=test.jpg -F file=@localfile.jpg http://path.to.uguu/api.php?d=upload-tool (Plain text Response)