]>
Commit | Line | Data |
---|---|---|
d8c46ff7 GJ |
1 | # Uguu |
2 | ||
ae78095a | 3 | Uguu is a simple temporary file uploading and sharing platform where files get deleted after 24 hours. |
d8c46ff7 GJ |
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). | |
67a54d5c | 20 | |
d8c46ff7 | 21 | ## Requirements |
e3fe8ee9 | 22 | |
c54fa84e GJ |
23 | Original development environment is Nginx + PHP5.3 + SQLite, but is confirmed to |
24 | work with Apache 2.4 and newer PHP versions like PHP7.3. | |
d8c46ff7 GJ |
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. | |
d8c46ff7 GJ |
34 | ```bash |
35 | git clone https://github.com/nokonoko/uguu | |
e3fe8ee9 GJ |
36 | ``` |
37 | ||
92417970 | 38 | Assuming you already have Node and NPM working, compilation is easy. |
d8c46ff7 | 39 | |
b1aeae2c | 40 | Run the following commands to do so, please configure `dist.json` before you compile. |
d8c46ff7 GJ |
41 | ```bash |
42 | cd uguu/ | |
43 | make | |
d8c46ff7 | 44 | make install |
e3fe8ee9 | 45 | ``` |
d8c46ff7 GJ |
46 | OR |
47 | ```bash | |
48 | make install DESTDIR=/desired/path/for/site | |
e3fe8ee9 | 49 | ``` |
d8c46ff7 GJ |
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. | |
e3fe8ee9 | 58 | |
4e2b7d35 GJ |
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 | ``` | |
d8c46ff7 GJ |
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 | ||
29a5df75 GJ |
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: | |
3ffab18a GJ |
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 | ||
1f71d46c GJ |
86 | ## MIME/EXT Blocking |
87 | ||
88 | Blocking certain filetypes from being uploaded can be changed by editing the following settings in `static/php/includes/settings.inc.php`: | |
89 | ```php | |
90 | define('CONFIG_BLOCKED_EXTENSIONS', serialize(['exe', 'scr', 'com', 'vbs', 'bat', 'cmd', 'htm', 'html', 'jar', 'msi', 'apk', 'phtml'])); | |
91 | define('CONFIG_BLOCKED_MIME', serialize(['application/msword', 'text/html', 'application/x-dosexec', 'application/java', 'application/java-archive', 'application/x-executable', 'application/x-mach-binary'])); | |
92 | ``` | |
93 | ||
94 | By default the most common malicious filetypes are blocked. | |
95 | ||
d8c46ff7 GJ |
96 | ## Using SQLite as DB engine |
97 | ||
98 | We need to create the SQLite database before it may be used by uguu. | |
99 | Fortunately, this is incredibly simple. | |
100 | ||
101 | First create a directory for the database, e.g. `mkdir /var/db/uguu`. | |
102 | Then, create a new SQLite database from the schema, e.g. `sqlite3 /var/db/uguu/uguu.sq3 -init /home/uguu/sqlite_schema.sql`. | |
103 | Then, finally, ensure the permissions are correct, e.g. | |
104 | ```bash | |
853b7680 | 105 | chown www-data:www-data /var/db/uguu |
d8c46ff7 GJ |
106 | chmod 0750 /var/db/uguu |
107 | chmod 0640 /var/db/uguu/uguu.sq3 | |
a405e92a | 108 | ``` |
d8c46ff7 GJ |
109 | |
110 | Finally, edit `php/includes/settings.inc.php` to indicate this is the database engine you would like to use. Make the changes outlined below | |
111 | ```php | |
112 | define('UGUU_DB_CONN', '[stuff]'); ---> define('UGUU_DB_CONN', 'sqlite:/var/db/uguu/uguu.sq3'); | |
113 | define('UGUU_DB_USER', '[stuff]'); ---> define('UGUU_DB_USER', null); | |
114 | define('UGUU_DB_PASS', '[stuff]'); ---> define('UGUU_DB_PASS', null); | |
a405e92a | 115 | ``` |
116 | ||
d8c46ff7 GJ |
117 | *NOTE: The directory where the SQLite database is stored, must be writable by the web server user* |
118 | ||
0dfed8b6 | 119 | ### Nginx/Apache |
d8c46ff7 | 120 | |
0dfed8b6 | 121 | I won't cover settings everything up, however do NOT allow PHP scripts to be executed on your subdomain serving the files or someone will just upload a PHP shell and PwN you. |
d8c46ff7 GJ |
122 | |
123 | ## Getting help | |
124 | ||
63cfe4f6 | 125 | Hit me up at [@nekunekus](https://twitter.com/nekunekus) or email me at neku@pomf.se |
e3fe8ee9 | 126 | |
d8c46ff7 | 127 | ## Credits |
67a54d5c | 128 | |
d8c46ff7 | 129 | Uguu is based off [Pomf](http://github.com/pomf/pomf). |
2239bd05 | 130 | |
d8c46ff7 | 131 | ## License |
2239bd05 | 132 | |
d8c46ff7 GJ |
133 | Uguu is free software, and is released under the terms of the Expat license. See |
134 | `LICENSE`. |