1
0
mirror of https://github.com/nokonoko/Uguu.git synced 2024-01-06 13:35:15 +00:00
uguu/README.md
Go Johansson (neku) cf2f9ae99f
Update README.md
2023-09-09 16:34:50 +02:00

2.2 KiB
Executable File

Uguu

Quality Gate Status License: GPL v3

What is Uguu?

Uguu is a simple lightweight temporary file hosting and sharing platform, but can also be used as a permanent file host.

Features

  • One click uploading, no registration required.
  • A minimal, modern web interface.
  • Drag & Drop & Paste supported.
  • Upload API with multiple response choices:
    • JSON
    • HTML
    • Text
    • CSV
  • Supports ShareX and other screenshot tools.
  • File extension & MIME black/whitelisting.
  • Upload rate limiting.
  • File (hash) blacklisting.
  • Run bare or as a container.

Demo

See the real world site at uguu.se.

Requirements

Tested and working with Nginx + PHP-8.1 + SQLite/MySQL/PostgreSQL + Node.js 18 or higher.

Node.js is used to compile Uguu, after that it runs on PHP.

Installation

Installation and configuration can be found at Uguu Documentation.

If you need a admin panel check out Moe Panel.

Getting help

Hit me up at @nekunekus or email me at neku@pomf.se

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 and Airbnb JavaScript (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.

Upcoming Features

  • S3 Bucket Support
  • Azure File Storage Support
  • Temporal/RR Support

Credits

Uguu is based on Pomf which was written by Emma Lejack & Go Johansson (nekunekus) and with help from the open source community.

License

Uguu is free software, and is released under the terms of the GPL-3.0 license. See LICENSE.