]>
Commit | Line | Data |
---|---|---|
e52293dd | 1 | # Uguu |
84123053 | 2 | |
e52293dd | 3 | [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=nokonoko_Uguu&metric=alert_status)](https://sonarcloud.io/dashboard?id=nokonoko_Uguu) |
f458ad8c | 4 | [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) |
e52293dd | 5 | |
295794b7 | 6 | # What is Uguu? |
d8c46ff7 | 7 | |
0b95d9d1 | 8 | Uguu is a simple lightweight temporary file hosting and sharing platform, but can also be used as a permanent file host. |
d8c46ff7 GJ |
9 | |
10 | ## Features | |
11 | ||
af4b9c42 GJ |
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: | |
84123053 GJ |
16 | - JSON |
17 | - HTML | |
18 | - Text | |
19 | - CSV | |
af4b9c42 GJ |
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. | |
d8c46ff7 GJ |
25 | |
26 | ### Demo | |
27 | ||
cf2f9ae9 | 28 | See the real world site at [uguu.se](https://uguu.se). |
67a54d5c | 29 | |
d8c46ff7 | 30 | ## Requirements |
e3fe8ee9 | 31 | |
9184e8d4 | 32 | Tested and working with Nginx + PHP-8.3 + SQLite/MySQL/PostgreSQL + Node.js 18 or higher. |
d8c46ff7 | 33 | |
f0210517 | 34 | Node.js is used to compile Uguu, after that it runs on PHP. |
d3f3618d | 35 | |
56586dec GJ |
36 | ## Installation |
37 | ||
74a96764 | 38 | Installation and configuration can be found at [Uguu Documentation](https://github.com/nokonoko/Uguu/wiki/Uguu-Configuration-&-Installation). |
56586dec | 39 | |
06507184 | 40 | If you need a admin panel check out [Moe Panel](https://github.com/Pomf/MoePanel). |
2d4a30d6 | 41 | |
d8c46ff7 GJ |
42 | ## Getting help |
43 | ||
63cfe4f6 | 44 | Hit me up at [@nekunekus](https://twitter.com/nekunekus) or email me at neku@pomf.se |
e3fe8ee9 | 45 | |
13019c73 GJ |
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 | |
1f745d39 GJ |
50 | PSR-12](https://www.php-fig.org/psr/psr-12/) |
51 | coding style guides. We use PHPCS tools to enforce these standards. | |
13019c73 GJ |
52 | |
53 | You can also help by sending us feature requests or writing documentation and | |
54 | tests. | |
55 | ||
d8c46ff7 | 56 | ## Credits |
67a54d5c | 57 | |
77a10625 | 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. |
2239bd05 | 59 | |
d8c46ff7 | 60 | ## License |
2239bd05 | 61 | |
83db6ff1 | 62 | Uguu is free software, and is released under the terms of the GPL-3.0 license. See |
56586dec | 63 | `LICENSE`. |