-# About
-[Uguu.se](http://uguu.se) source code, stores files and deletes after X amount of time.
+# Uguu
+[](https://sonarcloud.io/dashboard?id=nokonoko_Uguu)
+[](https://www.gnu.org/licenses/gpl-3.0)
+[](https://docs.uguu.se)
-# Install
-Tested with:
-* Nginx+PHP5-FPM (PHP 5.4) on Debian 7 Wheezy
-* Apache (PHP 5.4) on Ubuntu 14.04 LTS
-* Nginx+PHP5-FPM (PHP 5.6) on Debian 8 Jessie
-Modify
-* Modify includes/core.php where to save files and other paths.
-* Set correct paths in several other files. (Will add fix for this via config file instead).
-* Change uguu.se to your own name in several files.
-* Cron with check.sh: `crontab -e`
-* Some extensions are blocked by default, this can be changed via includes/core.php's $block array.
-* Everything else to your likings.
+# What is Uguu?
-Change php.ini and nginx.conf settings to allow bigger uploads.
+Uguu is a simple lightweight temporary file hosting and sharing platform, but can also be used as a permanent file host.
-Make the uguu/ directory modifiable to the nginx user:
-`setfacl -m u:www-data:rwx /path/to/uguu/directory/`
+## Features
-# Todo
+- 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](https://getsharex.com/) and other screenshot tools
-* Restructure files.
-* Make global config file.
-* Probably a lot of things but I'm a lazy fuck, come with suggestions.
+### Demo
+See the real world site at [uguu.se](https://uguu.se).
-# Using the API
+## Requirements
- * Leaving POST value 'name' empty will cause it to save using the original filename.
- * Leaving POST value 'randomname' empty will cause it to use original filename or custom name if 'name' is set to file.ext.
-
- * Putting anything into POST value 'randomname' will cause it to return a random filename + ext (xxxxxx.ext).
- * Putting a custom name into POST value 'name' will cause it to return a custom filename (yourpick.ext).
-
- E.g:
- * curl -i -F name=test.jpg -F file=@localfile.jpg http://uguu.se/api.php?d=upload (HTML Response)
- * curl -i -F name=test.jpg -F file=@localfile.jpg http://uguu.se/api.php?d=upload-tool (Plain text Response)
+Original development environment is Nginx + PHP8.1 + SQLite, but is confirmed to
+work with Apache and older PHP versions like PHP7.4.
+Node is used to compile Uguu.
-This will probably get changed later since it's messy and unpractical.
+## Installation
-# Contact
+Installation and configuration can be found at [Uguu Documentation](https://docs.uguu.se).
-[neku@pomf.se](mailto:neku@pomf.se) or [@Nekunekus](https://twitter.com/nekunekus).
+If you need a admin panel check out [Moe Panel](https://github.com/pomf/MoePanel).
+
+## Getting help
+
+Hit me up at [@nekunekus](https://twitter.com/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](https://www.php-fig.org/psr/psr-12/) and [Airbnb JavaScript
+(ES5)](https://github.com/airbnb/javascript/tree/es5-deprecated/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.
+
+## Credits
+
+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.
+
+## License
+
+Uguu is free software, and is released under the terms of the GPL-3.0 license. See
+`LICENSE`.
projects / uguu.git / blobdiff