]>
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) |
7887c7e4 | 5 | [![Documentation Status](https://docs.uguu.se/img/flat.svg)](https://docs.uguu.se) |
e52293dd | 6 | |
295794b7 | 7 | # What is Uguu? |
d8c46ff7 | 8 | |
0b95d9d1 | 9 | Uguu is a simple lightweight temporary file hosting and sharing platform, but can also be used as a permanent file host. |
d8c46ff7 GJ |
10 | |
11 | ## Features | |
12 | ||
af4b9c42 GJ |
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: | |
84123053 GJ |
17 | - JSON |
18 | - HTML | |
19 | - Text | |
20 | - CSV | |
af4b9c42 GJ |
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. | |
d8c46ff7 GJ |
26 | |
27 | ### Demo | |
28 | ||
ab5bedd3 | 29 | See the real world site at [uguu.se](https://uguu.se). |
67a54d5c | 30 | |
d8c46ff7 | 31 | ## Requirements |
e3fe8ee9 | 32 | |
52053519 | 33 | Tested and working with Nginx + PHP-8.1 + SQLite/MySQL/PostgreSQL. |
d8c46ff7 | 34 | |
eec51db0 | 35 | Node is used to compile Uguu, after that it runs on PHP. |
d3f3618d | 36 | |
56586dec GJ |
37 | ## Installation |
38 | ||
39 | Installation and configuration can be found at [Uguu Documentation](https://docs.uguu.se). | |
40 | ||
06507184 | 41 | If you need a admin panel check out [Moe Panel](https://github.com/Pomf/MoePanel). |
2d4a30d6 | 42 | |
d8c46ff7 GJ |
43 | ## Getting help |
44 | ||
63cfe4f6 | 45 | Hit me up at [@nekunekus](https://twitter.com/nekunekus) or email me at neku@pomf.se |
e3fe8ee9 | 46 | |
13019c73 GJ |
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 | ||
84123053 GJ |
58 | ## Upcoming Features |
59 | ||
84123053 GJ |
60 | * S3 Bucket Support |
61 | * Azure File Storage Support | |
62 | * Temporal/RR Support | |
84123053 | 63 | |
d8c46ff7 | 64 | ## Credits |
67a54d5c | 65 | |
1736639a | 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. |
2239bd05 | 67 | |
d8c46ff7 | 68 | ## License |
2239bd05 | 69 | |
83db6ff1 | 70 | Uguu is free software, and is released under the terms of the GPL-3.0 license. See |
56586dec | 71 | `LICENSE`. |