README.md

   1 # Uguu
   2
   3 uguu is a simple file uploading and sharing platform.
   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 You will need to recursively clone the repo to get the required PHP submodule,
  35 and the optional user panel submodule.
  36 ```bash
  37 git clone --recursive https://github.com/nokonoko/uguu
  38 ```
  39 If you don't want either of the submodules run the following command,
  40 ```bash
  41 git clone https://github.com/nokonoko/uguu
  42 ```
  43
  44 Assuming you already have Node and NPM working, compilation is easy. If you would like any additional submodules, or to exclude the default PHP submodule, use the `MODULES="..."` variable.
  45
  46 Run the following commands to do so.
  47 ```bash
  48 cd uguu/
  49 make
  50 make install
  51 ```
  52 OR
  53 ```bash
  54 make install DESTDIR=/desired/path/for/site
  55 ```
  56 After this, the uguu site is now compressed and set up inside `dist/`, or, if specified, `DESTDIR`.
  57
  58 ## Configuring
  59
  60 Front-end related settings, such as the name of the site, and maximum allowable
  61 file size, are found in `dist.json`.  Changes made here will
  62 only take effect after rebuilding the site pages.  This may be done by running
  63 `make` from the root of the site directory.
  64
  65 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.
  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 then add them to your crontab:
  73 ```bash
  74 0,30 * * * * bash /path/to/checkfiles.sh
  75 0,30 * * * * bash /path/to/checkdb.sh
  76 ```
  77
  78 These scripts check if DB entries and files are older then 24 hours and if they are deletes them.
  79
  80 Example nginx configs can be found in confs/.
  81
  82 ## Using SQLite as DB engine
  83
  84 We need to create the SQLite database before it may be used by uguu.
  85 Fortunately, this is incredibly simple.
  86
  87 First create a directory for the database, e.g. `mkdir /var/db/uguu`.
  88 Then, create a new SQLite database from the schema, e.g. `sqlite3 /var/db/uguu/uguu.sq3 -init /home/uguu/sqlite_schema.sql`.
  89 Then, finally, ensure the permissions are correct, e.g.
  90 ```bash
  91 chown nginx:nginx /var/db/uguu
  92 chmod 0750 /var/db/uguu
  93 chmod 0640 /var/db/uguu/uguu.sq3
  94 ```
  95
  96 Finally, edit `php/includes/settings.inc.php` to indicate this is the database engine you would like to use.  Make the changes outlined below
  97 ```php
  98 define('UGUU_DB_CONN', '[stuff]'); ---> define('UGUU_DB_CONN', 'sqlite:/var/db/uguu/uguu.sq3');
  99 define('UGUU_DB_USER', '[stuff]'); ---> define('UGUU_DB_USER', null);
 100 define('UGUU_DB_PASS', '[stuff]'); ---> define('UGUU_DB_PASS', null);
 101 ```
 102
 103 *NOTE: The directory where the SQLite database is stored, must be writable by the web server user*
 104
 105 ### Apache
 106
 107 If you are running Apache and want to compress your output when serving files,
 108 add to your `.htaccess` file:
 109
 110     AddOutputFilterByType DEFLATE text/html text/plain text/css application/javascript application/x-javascript application/json
 111
 112 Remember to enable `deflate_module` and `filter_module` modules in your Apache
 113 configuration file.
 114
 115 ## Getting help
 116
 117 Hit me up at [@nekunekus](https://twitter.com/nekunekus) or email me at neku@pomf.se
 118
 119 ## Credits
 120
 121 Uguu is based off [Pomf](http://github.com/pomf/pomf).
 122
 123 ## License
 124
 125 Uguu is free software, and is released under the terms of the Expat license. See
 126 `LICENSE`.