change desc

[uguu.git] / README.md

diff --git a/README.md b/README.md
index 3697f4e01dd5f50cfb91030e58a5b3e8b5e56ec7..0a59c6079547fd05279f571234455a59cdef5709 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
-# 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
 
 
 ## Features
 


@@ -83,6 +83,16 @@ Then add them to your crontab:
 
 These scripts check if DB entries and files are older then 24 hours and if they are deletes them.
 
 
 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.
 ## Using SQLite as DB engine
 
 We need to create the SQLite database before it may be used by uguu.


@@ -106,15 +116,15 @@ define('UGUU_DB_PASS', '[stuff]'); ---> define('UGUU_DB_PASS', null);
 
 *NOTE: The directory where the SQLite database is stored, must be writable by the web server user*
 
 
 *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
 
 
 ## Getting help