X-Git-Url: https://jfr.im/git/uguu.git/blobdiff_plain/c3b6d61cf6b48536e1011511a9205f0eb757923b..2f98035ac108db6733365c5f54236e0cb55ac69e:/README.md diff --git a/README.md b/README.md index 8700b94..4cf8a3d 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,11 @@ Tested with: * 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` +* Modify includes/core.php where to save files and other paths. +* Set correct paths in several other files. (Will add fix for this via config file instead). +* Change uguu.se to your own name in several files. +* Cron with check.sh: `crontab -e` +* After running `crontab -e`, add `0,15,30,45 * * * * bash /path/to/check.sh`, or read up on how cron works. * Some extensions are blocked by default, this can be changed via includes/core.php's $block array. * Everything else to your likings. @@ -20,27 +23,22 @@ Make the uguu/ directory modifiable to the nginx user: # Todo -* Respond with JSON rather then a white page with echo, will break current tools for the page tho, maybe add a switch so using the webpage will respond using JSON by default and using the 'API' will respond with a plain echo by default? +* Restructure files. +* Make global config file. * Probably a lot of things but I'm a lazy fuck, come with suggestions. # 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. + * 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). + * 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). E.g: - - - curl -i -F name=test.jpg -F file=@localfile.jpg http://uguu.se/api.php?d=upload (HTML Response) - - - curl -i -F name=test.jpg -F file=@localfile.jpg http://uguu.se/api.php?d=upload-tool (Plain text Response) + * curl -i -F name=test.jpg -F file=@localfile.jpg http://uguu.se/api.php?d=upload (HTML Response) + * curl -i -F name=test.jpg -F file=@localfile.jpg http://uguu.se/api.php?d=upload-tool (Plain text Response) This will probably get changed later since it's messy and unpractical.