README.md

   1 # Uguu
   2
   3 Uguu is a simple temporary file uploading and sharing platform where files get deleted after 24 hours.
   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 + PHP7.3 + SQLite, but is confirmed to
  24 work with Apache 2.4 and newer PHP versions.
  25
  26 ## Install
  27
  28 For the purposes of this guide, we won't cover setting up Nginx, PHP, SQLite,
  29 Node, or NPM. So we'll just assume you already have them all running well.
  30
  31 ### Compiling
  32
  33 First you must get a copy of the uguu code.  To do so, clone this git repo.
  34 ```bash
  35 git clone https://github.com/nokonoko/uguu
  36 ```
  37
  38 Assuming you already have Node and NPM working, compilation is easy.
  39
  40 Run the following commands to do so, please configure `dist.json` before you compile.
  41 ```bash
  42 cd uguu/
  43 make
  44 make install
  45 ```
  46 OR
  47 ```bash
  48 make install DESTDIR=/desired/path/for/site
  49 ```
  50 After this, the uguu site is now compressed and set up inside `dist/`, or, if specified, `DESTDIR`.
  51
  52 ## Configuring
  53
  54 Front-end related settings, such as the name of the site, and maximum allowable
  55 file size, are found in `dist.json`.  Changes made here will
  56 only take effect after rebuilding the site pages.  This may be done by running
  57 `make` from the root of the site directory.
  58
  59 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:
  60 ```php
  61 define('UGUU_DB_CONN', 'sqlite:/path/to/db/uguu.sq3');
  62 define('UGUU_FILES_ROOT', '/path/to/file/');
  63 define('UGUU_URL', 'https://subdomainforyourfiles.your.site');
  64 ```
  65
  66 If you intend to allow uploading files larger than 2 MB, you may also need to
  67 increase POST size limits in `php.ini` and webserver configuration. For PHP,
  68 modify `upload_max_filesize` and `post_max_size` values. The configuration
  69 option for nginx webserver is `client_max_body_size`.
  70
  71 Edit checkdb.sh and checkfiles.sh to the proper paths:
  72 ```bash
  73 sqlite3 /path/to/db/uguu.sq3 "DELETE FROM files WHERE date <= strftime('%s', datetime('now', '-1 day'));"
  74 ```
  75 ```bash
  76 find /path/to/files/ -mmin +1440 -exec rm -f {} \;
  77 ```
  78 Then add them to your crontab:
  79 ```bash
  80 0,30 * * * * bash /path/to/checkfiles.sh
  81 0,30 * * * * bash /path/to/checkdb.sh
  82 ```
  83
  84 These scripts check if DB entries and files are older then 24 hours and if they are deletes them.
  85
  86 ## Using SQLite as DB engine
  87
  88 We need to create the SQLite database before it may be used by uguu.
  89 Fortunately, this is incredibly simple.
  90
  91 First create a directory for the database, e.g. `mkdir /var/db/uguu`.
  92 Then, create a new SQLite database from the schema, e.g. `sqlite3 /var/db/uguu/uguu.sq3 -init /home/uguu/sqlite_schema.sql`.
  93 Then, finally, ensure the permissions are correct, e.g.
  94 ```bash
  95 chown www-data:www-data /var/db/uguu
  96 chmod 0750 /var/db/uguu
  97 chmod 0640 /var/db/uguu/uguu.sq3
  98 ```
  99
 100 Finally, edit `php/includes/settings.inc.php` to indicate this is the database engine you would like to use.  Make the changes outlined below
 101 ```php
 102 define('UGUU_DB_CONN', '[stuff]'); ---> define('UGUU_DB_CONN', 'sqlite:/var/db/uguu/uguu.sq3');
 103 define('UGUU_DB_USER', '[stuff]'); ---> define('UGUU_DB_USER', null);
 104 define('UGUU_DB_PASS', '[stuff]'); ---> define('UGUU_DB_PASS', null);
 105 ```
 106
 107 *NOTE: The directory where the SQLite database is stored, must be writable by the web server user*
 108
 109 ### Apache
 110
 111 If you are running Apache and want to compress your output when serving files,
 112 add to your `.htaccess` file:
 113
 114     AddOutputFilterByType DEFLATE text/html text/plain text/css application/javascript application/x-javascript application/json
 115
 116 Remember to enable `deflate_module` and `filter_module` modules in your Apache
 117 configuration file.
 118
 119 ## Getting help
 120
 121 Hit me up at [@nekunekus](https://twitter.com/nekunekus) or email me at neku@pomf.se
 122
 123 ## Credits
 124
 125 Uguu is based off [Pomf](http://github.com/pomf/pomf).
 126
 127 ## License
 128
 129 Uguu is free software, and is released under the terms of the Expat license. See
 130 `LICENSE`.