README.md

   1 # Uguu
   2
   3 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=nokonoko_Uguu&metric=alert_status)](https://sonarcloud.io/dashboard?id=nokonoko_Uguu)
   4 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
   5 [![Documentation Status](https://docs.uguu.se/img/flat.svg)](https://docs.uguu.se)
   6
   7 # What is Uguu?
   8
   9 Uguu is a simple lightweight temporary file hosting and sharing platform, but can also be used as a permanent file host.
  10
  11 ## Features
  12
  13 - One click uploading, no registration required.
  14 - A minimal, modern web interface.
  15 - Drag & Drop & Paste supported.
  16 - Upload API with multiple response choices:
  17     - JSON
  18     - HTML
  19     - Text
  20     - CSV
  21 - Supports [ShareX](https://getsharex.com/) and other screenshot tools.
  22 - File extension & MIME black/whitelisting.
  23 - Upload rate limiting.
  24 - File (hash) blacklisting.
  25 - Run bare or as a container.
  26
  27 ### Demo
  28
  29 See the real world site at [uguu.se](https://uguu.se).
  30
  31 ## Requirements
  32
  33 Tested and working with Nginx + PHP-8.1 + SQLite/MySQL.
  34
  35 Node is used to compile Uguu, after that it runs on PHP.
  36
  37 ## Installation
  38
  39 Installation and configuration can be found at [Uguu Documentation](https://docs.uguu.se).
  40
  41 If you need a admin panel check out [Moe Panel](https://github.com/Pomf/MoePanel).
  42
  43 ## Getting help
  44
  45 Hit me up at [@nekunekus](https://twitter.com/nekunekus) or email me at neku@pomf.se
  46
  47 ## Contributing
  48
  49 We'd really like if you can take some time to make sure your coding style is
  50 consistent with the project. Uguu follows [PHP
  51 PSR-12](https://www.php-fig.org/psr/psr-12/) and [Airbnb JavaScript
  52 (ES5)](https://github.com/airbnb/javascript/tree/es5-deprecated/es5) (`airbnb/legacy`)
  53 coding style guides. We use ESLint and PHPCS tools to enforce these standards.
  54
  55 You can also help by sending us feature requests or writing documentation and
  56 tests.
  57
  58 ## Upcoming Features
  59
  60 * PostgreSQL Support
  61 * S3 Bucket Support
  62 * Azure File Storage Support
  63 * Temporal/RR Support
  64
  65 ## Credits
  66
  67 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.
  68
  69 ## License
  70
  71 Uguu is free software, and is released under the terms of the GPL-3.0 license. See
  72 `LICENSE`.