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 # alternatively
  51 make MODULES="" # compile no submodules; exclude the default php backend module
  52 make MODULES="php" # compile the php submodule
  53 #
  54 make install
  55 ```
  56 OR
  57 ```bash
  58 make install DESTDIR=/desired/path/for/site
  59 ```
  60 After this, the uguu site is now compressed and set up inside `dist/`, or, if specified, `DESTDIR`.
  61
  62 ## Configuring
  63
  64 Front-end related settings, such as the name of the site, and maximum allowable
  65 file size, are found in `dist.json`.  Changes made here will
  66 only take effect after rebuilding the site pages.  This may be done by running
  67 `make` from the root of the site directory.
  68
  69 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.
  70
  71 If you intend to allow uploading files larger than 2 MB, you may also need to
  72 increase POST size limits in `php.ini` and webserver configuration. For PHP,
  73 modify `upload_max_filesize` and `post_max_size` values. The configuration
  74 option for nginx webserver is `client_max_body_size`.
  75
  76 Example nginx configs can be found in confs/.
  77
  78 ## Using SQLite as DB engine
  79
  80 We need to create the SQLite database before it may be used by uguu.
  81 Fortunately, this is incredibly simple.
  82
  83 First create a directory for the database, e.g. `mkdir /var/db/uguu`.
  84 Then, create a new SQLite database from the schema, e.g. `sqlite3 /var/db/uguu/uguu.sq3 -init /home/uguu/sqlite_schema.sql`.
  85 Then, finally, ensure the permissions are correct, e.g.
  86 ```bash
  87 chown nginx:nginx /var/db/uguu
  88 chmod 0750 /var/db/uguu
  89 chmod 0640 /var/db/uguu/uguu.sq3
  90 ```
  91
  92 Finally, edit `php/includes/settings.inc.php` to indicate this is the database engine you would like to use.  Make the changes outlined below
  93 ```php
  94 define('UGUU_DB_CONN', '[stuff]'); ---> define('UGUU_DB_CONN', 'sqlite:/var/db/uguu/uguu.sq3');
  95 define('UGUU_DB_USER', '[stuff]'); ---> define('UGUU_DB_USER', null);
  96 define('UGUU_DB_PASS', '[stuff]'); ---> define('UGUU_DB_PASS', null);
  97 ```
  98
  99 *NOTE: The directory where the SQLite database is stored, must be writable by the web server user*
 100
 101 ### Apache
 102
 103 If you are running Apache and want to compress your output when serving files,
 104 add to your `.htaccess` file:
 105
 106     AddOutputFilterByType DEFLATE text/html text/plain text/css application/javascript application/x-javascript application/json
 107
 108 Remember to enable `deflate_module` and `filter_module` modules in your Apache
 109 configuration file.
 110
 111 ## Getting help
 112
 113 Hit me up at twitter or email me.
 114
 115 ## Credits
 116
 117 Uguu is based off [Pomf](http://github.com/pomf/pomf).
 118
 119 ## License
 120
 121 Uguu is free software, and is released under the terms of the Expat license. See
 122 `LICENSE`.