]> jfr.im git - uguu.git/blob - README.md
Update README.md
[uguu.git] / README.md
1 # Uguu
2 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=nokonoko_Uguu&metric=alert_status)](https://sonarcloud.io/dashboard?id=nokonoko_Uguu)
3 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
4 [![Documentation Status](https://docs.uguu.se/img/flat.svg)](https://docs.uguu.se)
5
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
23 ### Demo
24
25 See the real world site at [uguu.se](https://uguu.se).
26
27 ## Requirements
28
29 Original development environment is Nginx + PHP8.1 + SQLite, but is confirmed to
30 work with Apache and older PHP versions like PHP7.4.
31
32 Node is used to compile Uguu.
33
34 ## Installation
35
36 Installation and configuration can be found at [Uguu Documentation](https://docs.uguu.se).
37
38 If you need a admin panel check out [Moe Panel](https://github.com/pomf/MoePanel).
39
40 ## Getting help
41
42 Hit me up at [@nekunekus](https://twitter.com/nekunekus) or email me at neku@pomf.se
43
44 ## Credits
45
46 Uguu is based on [Pomf](http://github.com/pomf/pomf) which was written by Emma Lejack & Eric Johansson (nekunekus) and with help from the open source community.
47
48 ## License
49
50 Uguu is free software, and is released under the terms of the GPL-3.0 license. See
51 `LICENSE`.