-# Uguu
+# What is Uguu?
-Uguu is a simple temporary file uploading and sharing platform where files get deleted after 24 hours.
+Uguu is a simple temporary file uploading and sharing platform where files get deleted after X amount of time.
## Features
## Requirements
-Original development environment is Nginx + PHP7.3 + SQLite, but is confirmed to
-work with Apache 2.4 and newer PHP versions.
+Original development environment is Nginx + PHP5.3 + SQLite, but is confirmed to
+work with Apache 2.4 and newer PHP versions like PHP7.3.
## Install
Assuming you already have Node and NPM working, compilation is easy.
-Run the following commands to do so.
+Run the following commands to do so, please configure `dist.json` before you compile.
```bash
cd uguu/
make
only take effect after rebuilding the site pages. This may be done by running
`make` from the root of the site directory.
-Back-end related settings, such as database configuration, and path for uploaded files, are found in `static/php/includes/settings.inc.php`. Changes made here take effect immediately.
+Back-end related settings, such as database configuration, and path for uploaded files, are found in `static/php/includes/settings.inc.php`. Changes made here take effect immediately. Change the following settings:
+```php
+define('UGUU_DB_CONN', 'sqlite:/path/to/db/uguu.sq3');
+define('UGUU_FILES_ROOT', '/path/to/file/');
+define('UGUU_URL', 'https://subdomainforyourfiles.your.site');
+```
If you intend to allow uploading files larger than 2 MB, you may also need to
increase POST size limits in `php.ini` and webserver configuration. For PHP,
These scripts check if DB entries and files are older then 24 hours and if they are deletes them.
+## MIME/EXT Blocking
+
+Blocking certain filetypes from being uploaded can be changed by editing the following settings in `static/php/includes/settings.inc.php`:
+```php
+define('CONFIG_BLOCKED_EXTENSIONS', serialize(['exe', 'scr', 'com', 'vbs', 'bat', 'cmd', 'htm', 'html', 'jar', 'msi', 'apk', 'phtml']));
+define('CONFIG_BLOCKED_MIME', serialize(['application/msword', 'text/html', 'application/x-dosexec', 'application/java', 'application/java-archive', 'application/x-executable', 'application/x-mach-binary']));
+```
+
+By default the most common malicious filetypes are blocked.
+
## Using SQLite as DB engine
We need to create the SQLite database before it may be used by uguu.
Then, create a new SQLite database from the schema, e.g. `sqlite3 /var/db/uguu/uguu.sq3 -init /home/uguu/sqlite_schema.sql`.
Then, finally, ensure the permissions are correct, e.g.
```bash
-chown nginx:nginx /var/db/uguu
+chown www-data:www-data /var/db/uguu
chmod 0750 /var/db/uguu
chmod 0640 /var/db/uguu/uguu.sq3
```
*NOTE: The directory where the SQLite database is stored, must be writable by the web server user*
-### Apache
-
-If you are running Apache and want to compress your output when serving files,
-add to your `.htaccess` file:
+## Nginx/Apache
- AddOutputFilterByType DEFLATE text/html text/plain text/css application/javascript application/x-javascript application/json
+I won't cover settings everything up, however do NOT allow PHP scripts to be executed on your subdomain serving the files or someone will just upload a PHP shell and PwN you.
-Remember to enable `deflate_module` and `filter_module` modules in your Apache
-configuration file.
+## API
+To upload using curl or make a tool you can post using:
+```
+curl -i -F files[]=@yourfile.jpeg https://uguu.se/upload.php (JSON Response)
+```
## Getting help