2021-06-23 23:23:17 +02:00
# Uguu
2022-12-17 00:23:38 +01:00
2021-06-23 23:23:17 +02:00
[](https://sonarcloud.io/dashboard?id=nokonoko_Uguu)
2022-01-22 20:02:37 +01:00
[](https://www.gnu.org/licenses/gpl-3.0)
2021-06-23 23:23:17 +02:00
2020-11-18 13:54:47 +01:00
# What is Uguu?
2020-11-18 12:54:47 +01:00
2021-06-24 13:46:00 +02:00
Uguu is a simple lightweight temporary file hosting and sharing platform, but can also be used as a permanent file host.
2020-11-18 12:54:47 +01:00
## Features
2023-01-01 09:45:39 +01:00
- One click uploading, no registration required.
- A minimal, modern web interface.
- Drag & Drop & Paste supported.
- Upload API with multiple response choices:
2022-12-17 00:23:38 +01:00
- JSON
- HTML
- Text
- CSV
2023-01-01 09:45:39 +01:00
- Supports [ShareX ](https://getsharex.com/ ) and other screenshot tools.
- File extension & MIME black/whitelisting.
- Upload rate limiting.
- File (hash) blacklisting.
- Run bare or as a container.
2020-11-18 12:54:47 +01:00
### Demo
2023-09-09 16:34:50 +02:00
See the real world site at [uguu.se ](https://uguu.se ).
2015-02-11 18:01:03 +01:00
2020-11-18 12:54:47 +01:00
## Requirements
2016-05-15 17:06:36 +02:00
2023-09-09 15:45:57 +02:00
Tested and working with Nginx + PHP-8.1 + SQLite/MySQL/PostgreSQL + Node.js 18 or higher.
2020-11-18 12:54:47 +01:00
2023-09-09 15:45:57 +02:00
Node.js is used to compile Uguu, after that it runs on PHP.
2021-06-22 20:37:28 +02:00
2021-06-24 00:18:41 +02:00
## Installation
2023-08-02 18:53:43 +02:00
Installation and configuration can be found at [Uguu Documentation ](https://github.com/nokonoko/Uguu/wiki/Uguu-Configuration-&-Installation ).
2021-06-24 00:18:41 +02:00
2022-07-16 07:03:56 +02:00
If you need a admin panel check out [Moe Panel ](https://github.com/Pomf/MoePanel ).
2022-04-17 15:22:36 +02:00
2020-11-18 12:54:47 +01:00
## Getting help
2020-11-18 12:56:49 +01:00
Hit me up at [@nekunekus ](https://twitter.com/nekunekus ) or email me at neku@pomf.se
2016-05-15 17:06:36 +02:00
2022-01-22 21:34:29 +01:00
## Contributing
We'd really like if you can take some time to make sure your coding style is
consistent with the project. Uguu follows [PHP
PSR-12](https://www.php-fig.org/psr/psr-12/) and [Airbnb JavaScript
(ES5)](https://github.com/airbnb/javascript/tree/es5-deprecated/es5) (`airbnb/legacy`)
coding style guides. We use ESLint and PHPCS tools to enforce these standards.
You can also help by sending us feature requests or writing documentation and
tests.
2022-12-17 00:23:38 +01:00
## Upcoming Features
* S3 Bucket Support
* Azure File Storage Support
* Temporal/RR Support
2020-11-18 12:54:47 +01:00
## Credits
2015-02-11 18:01:03 +01:00
2022-04-17 15:36:42 +02:00
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.
2016-05-14 11:30:07 +02:00
2020-11-18 12:54:47 +01:00
## License
2016-05-14 11:30:07 +02:00
2022-01-22 17:53:33 +01:00
Uguu is free software, and is released under the terms of the GPL-3.0 license. See
2021-06-24 00:18:41 +02:00
`LICENSE` .
