3 uguu is a simple file uploading and sharing platform.
7 - One click uploading, no registration required
8 - A minimal, modern web interface
9 - Drag & drop supported
10 - Upload API with multiple response choices
15 - Supports
[ShareX](https://getsharex.com/) and other screenshot tools
19 See the real world example at
[uguu.se](https://uguu.se).
23 Original development environment is Nginx + PHP7.3 + SQLite, but is confirmed to
24 work with Apache
2.4 and newer PHP versions.
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.
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.
37 git clone --recursive https://github.com/nokonoko/uguu
39 If you don't want either of the submodules run the following command,
41 git clone https://github.com/nokonoko/uguu
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.
46 Run the following commands to do so.
54 make install DESTDIR=/desired/path/for/site
56 After this, the uguu site is now compressed and set up inside
`dist/`, or, if specified,
`DESTDIR`.
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.
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.
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`.
72 Example nginx configs can be found in confs/.
74 ## Using SQLite as DB engine
76 We need to create the SQLite database before it may be used by uguu.
77 Fortunately, this is incredibly simple.
79 First create a directory for the database, e.g.
`mkdir /var/db/uguu`.
80 Then, create a new SQLite database from the schema, e.g.
`sqlite3 /var/db/uguu/uguu.sq3 -init /home/uguu/sqlite_schema.sql`.
81 Then, finally, ensure the permissions are correct, e.g.
83 chown nginx:nginx /var/db/uguu
84 chmod 0750 /var/db/uguu
85 chmod 0640 /var/db/uguu/uguu.sq3
88 Finally, edit
`php/includes/settings.inc.php` to indicate this is the database engine you would like to use. Make the changes outlined below
90 define('UGUU_DB_CONN', '[stuff]'); ---> define('UGUU_DB_CONN', 'sqlite:/var/db/uguu/uguu.sq3');
91 define('UGUU_DB_USER', '[stuff]'); ---> define('UGUU_DB_USER', null);
92 define('UGUU_DB_PASS', '[stuff]'); ---> define('UGUU_DB_PASS', null);
95 *NOTE: The directory where the SQLite database is stored, must be writable by the web server user*
99 If you are running Apache and want to compress your output when serving files,
100 add to your
`.htaccess` file:
102 AddOutputFilterByType DEFLATE text/html text/plain text/css application/javascript application/x-javascript application/json
104 Remember to enable
`deflate_module` and
`filter_module` modules in your Apache
109 Hit me up at
[@nekunekus](https://twitter.com/nekunekus) or email me at neku@pomf.se
113 Uguu is based off
[Pomf](http://github.com/pomf/pomf).
117 Uguu is free software, and is released under the terms of the Expat license. See