| | 1 | # Uguu |
| | 2 | |
| | 3 | [](https://sonarcloud.io/dashboard?id=nokonoko_Uguu) |
| | 4 | [](https://www.gnu.org/licenses/gpl-3.0) |
| | 5 | [](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/PostgreSQL. |
| | 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 | * S3 Bucket Support |
| | 61 | * Azure File Storage Support |
| | 62 | * Temporal/RR Support |
| | 63 | |
| | 64 | ## Credits |
| | 65 | |
| | 66 | 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. |
| | 67 | |
| | 68 | ## License |
| | 69 | |
| | 70 | Uguu is free software, and is released under the terms of the GPL-3.0 license. See |
| | 71 | `LICENSE`. |
projects / uguu.git / blame_incremental