sugoi/README.md

55 lines
2.4 KiB
Markdown
Raw Normal View History

2015-02-04 19:26:53 +00:00
# About
2016-05-14 19:56:20 +00:00
[Uguu.se](http://uguu.se) source code, stores files and deletes after X amount of time.
2015-02-04 19:25:31 +00:00
2016-05-14 09:56:42 +00:00
# Tested with:
2016-05-14 09:30:07 +00:00
* Nginx+PHP5-FPM (PHP 5.4) on Debian 7 Wheezy
* Apache (PHP 5.4) on Ubuntu 14.04 LTS
2016-05-14 09:30:07 +00:00
* Apache (PHP 5.6) on Debian 8 Jessie
* Nginx+PHP5-FPM (PHP 5.6) on Debian 8 Jessie
2015-02-04 19:25:31 +00:00
2016-05-14 09:56:42 +00:00
# Install:
2015-02-11 17:01:03 +00:00
2016-05-14 19:53:07 +00:00
* Deploy base code, for example with `git clone https://github.com/nokonoko/Uguu.git`
2016-05-14 09:56:42 +00:00
* Modify includes/config.php (copy config.template.php as a starting point) to set up the main options for Uguu.
* Some file extensions are blocked by default, this can be changed via includes/config.php's CONFIG_BLOCKED_EXTENSIONS value.
2016-05-14 10:02:27 +00:00
* Copy `rain/template/footer.template.html` as `rain/template/footer.html` and personalize the footer as you wish
2016-05-14 09:56:42 +00:00
* 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).
* Make the Uguu/public/files and Uguu/rain/cache directory modifiable by 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`
* Make sure the Uguu/public/files folder is not indexable, you may use a virtual host config similar to this one:
```
<VirtualHost *:80>
ServerName path.to.uguu
DocumentRoot /var/www/Uguu/
<Directory /var/www/Uguu/>
AllowOverride All
Require all granted
</Directory>
Alias "/files" "/var/www/Uguu/public/files/"
<Directory /var/www/Uguu/public/files/>
<Files *>
SetHandler default-handler
</Files>
2016-05-14 09:56:42 +00:00
AllowOverride None
Options -Indexes
Require all granted
</Directory>
</VirtualHost>
```
2015-02-11 17:01:03 +00:00
# Using the API
2015-10-07 22:35:01 +00:00
* 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.
2016-05-14 09:30:07 +00:00
2015-10-07 22:35:01 +00:00
* 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).
2016-05-14 09:30:07 +00:00
2015-10-07 21:03:33 +00:00
E.g:
2016-05-14 09:31:48 +00:00
* 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)