README.md

   1 # What is Uguu?
   2
   3 Uguu is a simple lightweight temporary file hosting platform where files get deleted after X amount of time.
   4
   5 It can also be configurated to not expire files, and act as a slimmed version of Pomf.
   6
   7 ## Features
   8
   9 - One click uploading, no registration required
  10 - A minimal, modern web interface
  11 - Drag & drop supported
  12 - Upload API with multiple response choices
  13   - JSON
  14   - HTML
  15   - Text
  16   - CSV
  17 - Supports [ShareX](https://getsharex.com/) and other screenshot tools
  18
  19 ### Demo
  20
  21 See the real world example at [uguu.se](https://uguu.se).
  22
  23 ## Requirements
  24
  25 Original development environment is Nginx + PHP5.3 + SQLite, but is confirmed to
  26 work with Apache 2.4 and newer PHP versions like PHP7.3.
  27
  28 ## Install
  29
  30 A detailed installation and configuration can be found at [Uguu/Pomf Documentation](https://blog.yeet.nu/blog/uguu-docs).
  31
  32 ## API
  33 To upload using curl or make a tool you can post using:
  34 ```
  35 curl -i -F files[]=@yourfile.jpeg https://uguu.se/upload.php (JSON Response)
  36 ```
  37 ```
  38 curl -i -F files[]=@yourfile.jpeg https://uguu.se/upload.php?output=text (Text Response)
  39 ```
  40 ```
  41 curl -i -F files[]=@yourfile.jpeg https://uguu.se/upload.php?output=csv (CSV Response)
  42 ```
  43 ```
  44 curl -i -F files[]=@yourfile.jpeg https://uguu.se/upload.php?output=html (HTML Response)
  45 ```
  46
  47 ## Getting help
  48
  49 Hit me up at [@nekunekus](https://twitter.com/nekunekus) or email me at neku@pomf.se
  50
  51 ## Credits
  52
  53 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.
  54
  55 ## License
  56
  57 Uguu is free software, and is released under the terms of the Expat license. See
  58 `LICENSE`.
  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