README.md

   1 # What is Uguu?
   2
   3 Uguu is a simple lightweight file uploading and sharing platform, with the option for files to expire.
   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
  19 See the real world example at [uguu.se](https://uguu.se).
  20
  21 ## Requirements
  22
  23 Original development environment is Nginx + PHP5.3 + SQLite, but is confirmed to
  24 work with Apache 2.4 and newer PHP versions like PHP7.3.
  25
  26 ## Install
  27
  28 A detailed installation and configuration can be found at [Uguu/Pomf Documentation](https://blog.yeet.nu/blog/uguu-docs).
  29
  30 ## API
  31 To upload using curl or make a tool you can post using:
  32 ```
  33 curl -i -F files[]=@yourfile.jpeg https://uguu.se/upload.php (JSON Response)
  34 ```
  35 ```
  36 curl -i -F files[]=@yourfile.jpeg https://uguu.se/upload.php?output=text (Text Response)
  37 ```
  38 ```
  39 curl -i -F files[]=@yourfile.jpeg https://uguu.se/upload.php?output=csv (CSV Response)
  40 ```
  41 ```
  42 curl -i -F files[]=@yourfile.jpeg https://uguu.se/upload.php?output=html (HTML Response)
  43 ```
  44
  45 ## Getting help
  46
  47 Hit me up at [@nekunekus](https://twitter.com/nekunekus) or email me at neku@pomf.se
  48
  49 ## Credits
  50
  51 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.
  52
  53 ## License
  54
  55 Uguu is free software, and is released under the terms of the Expat license. See
  56 `LICENSE`.
  57
  58 ## To do in release v1.1.0
  59 * Mod feature and interface
  60 * Blacklist DB (already exists on Uguu.se, but not in this code)
  61 * Code cleanup