X-Git-Url: https://jfr.im/git/uguu.git/blobdiff_plain/495eda7b237b5ec8c960e16049c3f85c70652fd5..HEAD:/README.md diff --git a/README.md b/README.md index 110eda7..e3144f0 100644 --- a/README.md +++ b/README.md @@ -1,102 +1,71 @@ -# 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 * * * * cd /path/to/uguu/includes && bash 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) +[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) +[![Documentation Status](https://docs.uguu.se/img/flat.svg)](https://docs.uguu.se) + +# What is Uguu? + +Uguu is a simple lightweight temporary file hosting and sharing platform, but can also be used as a permanent file host. + +## 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. +- File extension & MIME black/whitelisting. +- Upload rate limiting. +- File (hash) blacklisting. +- Run bare or as a container. + +### Demo + +See the real world site at [uguu.se](https://uguu.se). + +## Requirements + +Tested and working with Nginx + PHP-8.1 + SQLite/MySQL/PostgreSQL. + +Node is used to compile Uguu, after that it runs on PHP. + +## Installation + +Installation and configuration can be found at [Uguu Documentation](https://docs.uguu.se). + +If you need a admin panel check out [Moe Panel](https://github.com/Pomf/MoePanel). + +## Getting help + +Hit me up at [@nekunekus](https://twitter.com/nekunekus) or email me at neku@pomf.se + +## Contributing + +We'd really like if you can take some time to make sure your coding style is +consistent with the project. Uguu follows [PHP +PSR-12](https://www.php-fig.org/psr/psr-12/) and [Airbnb JavaScript +(ES5)](https://github.com/airbnb/javascript/tree/es5-deprecated/es5) (`airbnb/legacy`) +coding style guides. We use ESLint and PHPCS tools to enforce these standards. + +You can also help by sending us feature requests or writing documentation and +tests. + +## Upcoming Features + +* S3 Bucket Support +* Azure File Storage Support +* Temporal/RR Support + +## Credits + +Uguu is based on [Pomf](http://github.com/pomf/pomf) which was written by Emma Lejack & Go Johansson (nekunekus) and with help from the open source community. + +## License + +Uguu is free software, and is released under the terms of the GPL-3.0 license. See +`LICENSE`.