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
   6 # What is Uguu?
   7
   8 Uguu is a simple lightweight temporary file hosting and sharing platform, but can also be used as a permanent file host.
   9
  10 ## Features
  11
  12 - One click uploading, no registration required.
  13 - A minimal, modern web interface.
  14 - Drag & Drop & Paste supported.
  15 - Upload API with multiple response choices:
  16     - JSON
  17     - HTML
  18     - Text
  19     - CSV
  20 - Supports [ShareX](https://getsharex.com/) and other screenshot tools.
  21 - File extension & MIME black/whitelisting.
  22 - Upload rate limiting.
  23 - File (hash) blacklisting.
  24 - Run bare or as a container.
  25
  26 ### Demo
  27
  28 See the real world site at [uguu.se](https://uguu.se).
  29
  30 ## Requirements
  31
  32 Tested and working with Nginx + PHP-8.3 + SQLite/MySQL/PostgreSQL + Node.js 18 or higher.
  33
  34 Node.js is used to compile Uguu, after that it runs on PHP.
  35
  36 ## Installation
  37
  38 Installation and configuration can be found at [Uguu Documentation](https://github.com/nokonoko/Uguu/wiki/Uguu-Configuration-&-Installation).
  39
  40 If you need a admin panel check out [Moe Panel](https://github.com/Pomf/MoePanel).
  41
  42 ## Getting help
  43
  44 Hit me up at [@nekunekus](https://twitter.com/nekunekus) or email me at neku@pomf.se
  45
  46 ## Contributing
  47
  48 We'd really like if you can take some time to make sure your coding style is
  49 consistent with the project. Uguu follows [PHP
  50 PSR-12](https://www.php-fig.org/psr/psr-12/)
  51 coding style guides. We use PHPCS tools to enforce these standards.
  52
  53 You can also help by sending us feature requests or writing documentation and
  54 tests.
  55
  56 ## Credits
  57
  58 Uguu is based on [Pomf](http://github.com/pomf/pomf) which was written by Emma Lejack & Go Johansson (nekunekus (nokonoko)) and with help from the open source community.
  59
  60 ## License
  61
  62 Uguu is free software, and is released under the terms of the GPL-3.0 license. See
  63 `LICENSE`.