X-Git-Url: https://jfr.im/git/uguu.git/blobdiff_plain/ff4e4efe78f161abdc8d7b41d0bebe1b4b94899b..56586decf49eef2ac741b0ef3e39b300f4ac8349:/README.md?ds=inline diff --git a/README.md b/README.md index fba0a68..0971123 100644 --- a/README.md +++ b/README.md @@ -1,102 +1,51 @@ -# About -[Uguu.se](http://uguu.se) source code, stores files and deletes after X amount of time. - -# Tested with: -* 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 - -# Install: - -* Deploy base code, for example with `git clone https://github.com/nokonoko/Uguu.git` -* 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. -* Copy `rain/template/footer.template.html` as `rain/template/footer.html` and personalize the footer as you wish -* 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 using Apache: - -``` - - ServerName path.to.uguu - - DocumentRoot /var/www/Uguu/ - - AllowOverride All - Require all granted - - - Alias "/files" "/var/www/Uguu/public/files/" - - - SetHandler default-handler - - AllowOverride None - Options -Indexes - Require all granted - - - -``` - -Or something like this using Nginx+PHP-FPM: - -uguu.se -``` -server{ - listen 104.243.35.197:80; - server_name uguu.se www.uguu.se; - - root /home/neku/www/uguu/; - autoindex off; - index index.html index.php; - - location ~* \.php$ { - fastcgi_pass unix:/var/run/php5-fpm.sock; - fastcgi_intercept_errors on; - fastcgi_index index.php; - fastcgi_split_path_info ^(.+\.php)(.*)$; - include fastcgi_params; - fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name; - } - - error_page 404 /404.html; - error_page 403 /404.html; - location /404.html { - root /home/neku/www; - } -} -``` - -a.uguu.se (notice that scripts e.g PHP will NOT be executed from this subdomain) -``` -server{ - listen 104.243.35.197:80; - server_name a.uguu.se www.a.uguu.se; - - root /home/neku/www/files; - autoindex off; - index index.html; - - error_page 404 /404.html; - error_page 403 /404.html; - location /404.html { - root /home/neku/www; - } -} -``` - - -# Using the API - - * 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). - - 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) +# Uguu +[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=nokonoko_Uguu&metric=alert_status)](https://sonarcloud.io/dashboard?id=nokonoko_Uguu) +[![MIT +licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/nokonoko/uguu/master/LICENSE) +[![Documentation Status](https://docs.uguu.se/img/flat.svg)](https://docs.uguu.se) + + +# What is Uguu? + +Uguu is a simple lightweight file uploading and sharing platform, with the option for files to expire. + +## Features + +- One click uploading, no registration required +- A minimal, modern web interface +- Drag & Drop & Paste supported +- Upload API with multiple response choices + - JSON + - HTML + - Text + - CSV +- Supports [ShareX](https://getsharex.com/) and other screenshot tools + +### Demo + +See the real world example at [uguu.se](https://uguu.se). + +## Requirements + +Original development environment is Nginx + PHP5.3 + SQLite, but is confirmed to +work with Apache 2.4 and newer PHP versions like PHP7.3 and PHP8.0 + +Node is used to compile Uguu. + +## Installation + +Installation and configuration can be found at [Uguu Documentation](https://docs.uguu.se). + + +## Getting help + +Hit me up at [@nekunekus](https://twitter.com/nekunekus) or email me at neku@pomf.se + +## Credits + +Uguu is based on [Pomf](http://github.com/pomf/pomf) which was written by Emma Lejack & Eric Johansson (nekunekus) and with help from the open source community. + +## License + +Uguu is free software, and is released under the terms of the Expat license. See +`LICENSE`.