]> jfr.im git - uguu.git/blame - README.md
Update README.md
[uguu.git] / README.md
CommitLineData
295794b7 1# What is Uguu?
d8c46ff7 2
3edf5c03 3Uguu is a simple lightweight temporary file uploading and sharing platform where files get deleted after X amount of time.
d8c46ff7
GJ
4
5## Features
6
7- One click uploading, no registration required
8- A minimal, modern web interface
9- Drag & drop supported
10- Upload API with multiple response choices
11 - JSON
12 - HTML
13 - Text
14 - CSV
15- Supports [ShareX](https://getsharex.com/) and other screenshot tools
16
17### Demo
18
19See the real world example at [uguu.se](https://uguu.se).
67a54d5c 20
d8c46ff7 21## Requirements
e3fe8ee9 22
c54fa84e
GJ
23Original development environment is Nginx + PHP5.3 + SQLite, but is confirmed to
24work with Apache 2.4 and newer PHP versions like PHP7.3.
d8c46ff7
GJ
25
26## Install
27
b318cf67 28A detailed installation and configuration can be found at [Uguu/Pomf Documentation](https://blog.yeet.nu/blog/uguu-docs).
d8c46ff7 29
5df9340f
GJ
30Please note that if you do not setup the cron scripts Uguu will act as a more slimmed version of Pomf and files won't expire.
31
d501210d
GJ
32## API
33To upload using curl or make a tool you can post using:
36cfd3b8
GJ
34```
35curl -i -F files[]=@yourfile.jpeg https://uguu.se/upload.php (JSON Response)
36```
7c935615
GJ
37```
38curl -i -F files[]=@yourfile.jpeg https://uguu.se/upload.php?output=text (Text Response)
39```
40```
41curl -i -F files[]=@yourfile.jpeg https://uguu.se/upload.php?output=csv (CSV Response)
42```
43```
44curl -i -F files[]=@yourfile.jpeg https://uguu.se/upload.php?output=html (HTML Response)
45```
d501210d 46
d8c46ff7
GJ
47## Getting help
48
63cfe4f6 49Hit me up at [@nekunekus](https://twitter.com/nekunekus) or email me at neku@pomf.se
e3fe8ee9 50
d8c46ff7 51## Credits
67a54d5c 52
0c9a152f 53Uguu 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.
2239bd05 54
d8c46ff7 55## License
2239bd05 56
d8c46ff7
GJ
57Uguu is free software, and is released under the terms of the Expat license. See
58`LICENSE`.
d3acd432
GJ
59
60## To do in release v1.1.0
61* Mod feature and interface
62* Blacklist DB (already exists on Uguu.se, but not in this code)
63* Code cleanup