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 **Detailed installation and configuration can be found at [Uguu/Pomf Documentation](https://blog.yeet.nu/blog/uguu-docs).**
  29
  30 If you don't need a detailed one just follow the instructions below.
  31
  32 ### Compiling
  33
  34  First you must get a copy of the uguu code.  To do so, clone this git repo.
  35  ```bash
  36  git clone https://github.com/nokonoko/uguu
  37  ```
  38
  39  Assuming you already have Node working, compilation is easy.
  40
  41  **Run the following commands to do so, please configure `dist.json` before you compile.**
  42  ```bash
  43  cd uguu/
  44  make
  45  make install
  46  ```
  47  OR
  48  ```bash
  49  make install DESTDIR=/desired/path/for/site
  50  ```
  51  After this, the uguu site is now compressed and set up inside `dist/`, or, if specified, `DESTDIR`.
  52
  53  ## Configuring
  54
  55  Front-end related settings, such as the name of the site, and maximum allowable
  56  file size, are found in `dist.json`.  Changes made here will
  57  only take effect after rebuilding the site pages.  This may be done by running
  58  `make` from the root of the site directory.
  59
  60  **Back-end related settings, such as database configuration, and path for uploaded files, are found in `includes/settings.inc.php`.  Changes made here take effect immediately. Change the following settings:**
  61  ```php
  62  define('UGUU_DB_CONN', 'sqlite:/path/to/db/uguu.sq3');
  63  define('UGUU_FILES_ROOT', '/path/to/file/');
  64  define('UGUU_URL', 'https://subdomainforyourfiles.your.site');
  65  ```
  66
  67  **If you intend to allow uploading files larger than 2 MB, you may also need to
  68  increase POST size limits in `php.ini` and webserver configuration. For PHP,
  69  modify `upload_max_filesize` and `post_max_size` values. The configuration
  70  option for nginx webserver is `client_max_body_size`.**
  71
  72  **Edit checkdb.sh and checkfiles.sh to the proper paths:**
  73  ```bash
  74  sqlite3 /path/to/db/uguu.sq3 "DELETE FROM files WHERE date <= strftime('%s', datetime('now', '-1 day'));"
  75  ```
  76  ```bash
  77  find /path/to/files/ -mmin +1440 -exec rm -f {} \;
  78  ```
  79  **Then add them to your crontab:**
  80  ```bash
  81  0,30 * * * * bash /path/to/checkfiles.sh
  82  0,30 * * * * bash /path/to/checkdb.sh
  83  ```
  84
  85  These scripts check if DB entries and files are older then 24 hours and if they are deletes them.
  86
  87  ## MIME/EXT Blocking
  88
  89  **Blocking certain filetypes from being uploaded can be changed by editing the following settings in `includes/settings.inc.php`:**
  90  ```php
  91  define('CONFIG_BLOCKED_EXTENSIONS', serialize(['exe', 'scr', 'com', 'vbs', 'bat', 'cmd', 'htm', 'html', 'jar', 'msi', 'apk', 'phtml', 'svg']));
  92  define('CONFIG_BLOCKED_MIME', serialize(['application/msword', 'text/html', 'application/x-dosexec', 'application/java', 'application/java-archive', 'application/x-executable', 'application/x-mach-binary', 'image/svg+xml']));
  93  ```
  94
  95  By default the most common malicious filetypes are blocked.
  96
  97  ## Using SQLite as DB engine
  98
  99  We need to create the SQLite database before it may be used by uguu.
 100  Fortunately, this is incredibly simple.
 101
 102  First create a directory for the database, e.g. `mkdir /var/db/uguu`.
 103  Then, create a new SQLite database from the schema, e.g. `sqlite3 /var/db/uguu/uguu.sq3 -init /home/uguu/sqlite_schema.sql`.
 104  Then, finally, ensure the permissions are correct, e.g.
 105  ```bash
 106  chown www-data:www-data /var/db/uguu
 107  chmod 0750 /var/db/uguu
 108  chmod 0640 /var/db/uguu/uguu.sq3
 109  ```
 110
 111  Finally, edit `includes/settings.inc.php` to indicate this is the database engine you would like to use.  Make the changes outlined below
 112  ```php
 113  define('UGUU_DB_CONN', '[stuff]'); ---> define('UGUU_DB_CONN', 'sqlite:/var/db/uguu/uguu.sq3');
 114  define('UGUU_DB_USER', '[stuff]'); ---> define('UGUU_DB_USER', null);
 115  define('UGUU_DB_PASS', '[stuff]'); ---> define('UGUU_DB_PASS', null);
 116  ```
 117
 118  *NOTE: The directory where the SQLite database is stored, must be writable by the web server user*
 119
 120 ## API
 121 To upload using curl or make a tool you can post using:
 122 ```
 123 curl -i -F files[]=@yourfile.jpeg https://uguu.se/upload.php (JSON Response)
 124 ```
 125 ```
 126 curl -i -F files[]=@yourfile.jpeg https://uguu.se/upload.php?output=text (Text Response)
 127 ```
 128 ```
 129 curl -i -F files[]=@yourfile.jpeg https://uguu.se/upload.php?output=csv (CSV Response)
 130 ```
 131 ```
 132 curl -i -F files[]=@yourfile.jpeg https://uguu.se/upload.php?output=html (HTML Response)
 133 ```
 134
 135 ## Getting help
 136
 137 Hit me up at [@nekunekus](https://twitter.com/nekunekus) or email me at neku@pomf.se
 138
 139 ## Credits
 140
 141 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.
 142
 143 ## License
 144
 145 Uguu is free software, and is released under the terms of the Expat license. See
 146 `LICENSE`.
 147
 148 ## To do in release v1.1.0
 149 * Mod feature and interface
 150 * Blacklist DB (already exists on Uguu.se, but not in this code)
 151 * Code cleanup