README.md

   1 # Uguu
   2 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=nokonoko_Uguu&metric=alert_status)](https://sonarcloud.io/dashboard?id=nokonoko_Uguu)
   3 [![MIT
   4 licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/nokonoko/uguu/master/LICENSE)
   5 [![Documentation Status](https://assets.readthedocs.org/static/projects/badges/passing-flat.svg)](https://docs.uguu.se)
   6
   7
   8 # What is Uguu?
   9
  10 Uguu is a simple lightweight file uploading and sharing platform, with the option for files to expire.
  11
  12 ## Features
  13
  14 - One click uploading, no registration required
  15 - A minimal, modern web interface
  16 - Drag & Drop & Paste supported
  17 - Upload API with multiple response choices
  18   - JSON
  19   - HTML
  20   - Text
  21   - CSV
  22 - Supports [ShareX](https://getsharex.com/) and other screenshot tools
  23
  24 ### Demo
  25
  26 See the real world example at [uguu.se](https://uguu.se).
  27
  28 ## Requirements
  29
  30 Original development environment is Nginx + PHP5.3 + SQLite, but is confirmed to
  31 work with Apache 2.4 and newer PHP versions like PHP7.3 and PHP8.0
  32
  33 Node is used to compile Uguu.
  34
  35 ## Install
  36
  37 **Detailed installation and configuration can be found at [Uguu Documentation](https://docs.uguu.se).**
  38
  39 If you don't need a detailed one just follow the instructions below.
  40
  41 ### Compiling
  42
  43  First you must get a copy of the uguu code.  To do so, clone this git repo.
  44  ```bash
  45  git clone https://github.com/nokonoko/uguu
  46  ```
  47
  48  **Run the following commands to do so, please configure `dist.json` before you compile.**
  49  ```bash
  50  cd uguu/
  51  make
  52  make install
  53  ```
  54  OR
  55  ```bash
  56  make install DESTDIR=/desired/path/for/site
  57  ```
  58  After this, the uguu site is now compressed and set up inside `dist/`, or, if specified, `DESTDIR`.
  59
  60  ## Configuring
  61
  62  Front-end related settings, such as the name of the site, and maximum allowable
  63  file size, are found in `dist.json`.  Changes made here will
  64  only take effect after rebuilding the site pages.  This may be done by running
  65  `make` from the root of the site directory.
  66
  67  **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:**
  68  ```php
  69  define('UGUU_DB_CONN', 'sqlite:/path/to/db/uguu.sq3');
  70  define('UGUU_FILES_ROOT', '/path/to/file/');
  71  define('UGUU_URL', 'https://subdomainforyourfiles.your.site');
  72  ```
  73
  74  **If you intend to allow uploading files larger than 2 MB, you may also need to
  75  increase POST size limits in `php.ini` and webserver configuration. For PHP,
  76  modify `upload_max_filesize` and `post_max_size` values. The configuration
  77  option for nginx webserver is `client_max_body_size`.**
  78
  79  **Edit checkdb.sh and checkfiles.sh to the proper paths:**
  80  ```bash
  81  sqlite3 /path/to/db/uguu.sq3 "DELETE FROM files WHERE date <= strftime('%s', datetime('now', '-1 day'));"
  82  ```
  83  ```bash
  84  find /path/to/files/ -mmin +1440 -exec rm -f {} \;
  85  ```
  86  **Then add them to your crontab:**
  87  ```bash
  88  0,30 * * * * bash /path/to/checkfiles.sh
  89  0,30 * * * * bash /path/to/checkdb.sh
  90  ```
  91
  92  These scripts check if DB entries and files are older then 24 hours and if they are deletes them.
  93
  94  ## MIME/EXT Blocking
  95
  96  **Blocking certain filetypes from being uploaded can be changed by editing the following settings in `includes/settings.inc.php`:**
  97  ```php
  98  define('CONFIG_BLOCKED_EXTENSIONS', serialize(['exe', 'scr', 'com', 'vbs', 'bat', 'cmd', 'htm', 'html', 'jar', 'msi', 'apk', 'phtml', 'svg']));
  99  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']));
 100  ```
 101 By default the most common malicious filetypes are blocked.
 102
 103  ## IP logging
 104  This is turned off by default, but you can enable it by changing:
 105  ```php
 106  define('LOG_IP', 'false');
 107 ```
 108
 109 ## Anti dupe
 110 This is turned off by default, if a user uploads a file already uploaded the link to the already existing file will be returned instead.
 111  ```php
 112  define('ANTI_DUPE', 'false');
 113 ```
 114
 115  ## Using SQLite as DB engine
 116
 117  We need to create the SQLite database before it may be used by uguu.
 118  Fortunately, this is incredibly simple.
 119
 120  First create a directory for the database, e.g. `mkdir /var/db/uguu`.
 121  Then, create a new SQLite database from the schema, e.g. `sqlite3 /var/db/uguu/uguu.sq3 -init /home/uguu/sqlite_schema.sql`.
 122  Then, finally, ensure the permissions are correct, e.g.
 123  ```bash
 124  chown www-data:www-data /var/db/uguu
 125  chmod 0750 /var/db/uguu
 126  chmod 0640 /var/db/uguu/uguu.sq3
 127  ```
 128
 129  Finally, edit `includes/settings.inc.php` to indicate this is the database engine you would like to use.  Make the changes outlined below
 130  ```php
 131  define('UGUU_DB_CONN', '[stuff]'); ---> define('UGUU_DB_CONN', 'sqlite:/var/db/uguu/uguu.sq3');
 132  define('UGUU_DB_USER', '[stuff]'); ---> define('UGUU_DB_USER', null);
 133  define('UGUU_DB_PASS', '[stuff]'); ---> define('UGUU_DB_PASS', null);
 134  ```
 135
 136  *NOTE: The directory where the SQLite database is stored, must be writable by the web server user*
 137
 138 ## API
 139 To upload using curl or make a tool you can post using:
 140 ```
 141 curl -i -F files[]=@yourfile.jpeg https://uguu.se/upload.php (JSON Response)
 142 ```
 143 ```
 144 curl -i -F files[]=@yourfile.jpeg https://uguu.se/upload.php?output=text (Text Response)
 145 ```
 146 ```
 147 curl -i -F files[]=@yourfile.jpeg https://uguu.se/upload.php?output=csv (CSV Response)
 148 ```
 149 ```
 150 curl -i -F files[]=@yourfile.jpeg https://uguu.se/upload.php?output=html (HTML Response)
 151 ```
 152
 153 ## Getting help
 154
 155 Hit me up at [@nekunekus](https://twitter.com/nekunekus) or email me at neku@pomf.se
 156
 157 ## Credits
 158
 159 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.
 160
 161 ## License
 162
 163 Uguu is free software, and is released under the terms of the Expat license. See
 164 `LICENSE`.