]>
Commit | Line | Data |
---|---|---|
295794b7 | 1 | # What is Uguu? |
d8c46ff7 | 2 | |
6f1e3747 | 3 | Uguu is a simple lightweight file uploading and sharing platform, with the option for files to expire. |
d8c46ff7 GJ |
4 | |
5 | ## Features | |
6 | ||
7 | - One click uploading, no registration required | |
8 | - A minimal, modern web interface | |
13a9292f | 9 | - Drag & Drop & Paste supported |
d8c46ff7 GJ |
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 | 23 | Original development environment is Nginx + PHP5.3 + SQLite, but is confirmed to |
03a91b2a | 24 | work with Apache 2.4 and newer PHP versions like PHP7.3 and PHP8.0 |
d8c46ff7 | 25 | |
d3f3618d GJ |
26 | Node is used to compile Uguu. |
27 | ||
d8c46ff7 GJ |
28 | ## Install |
29 | ||
d3aa5eb9 | 30 | **Detailed installation and configuration can be found at [Uguu Documentation](https://docs.uguu.se).** |
a51784b6 GJ |
31 | |
32 | If you don't need a detailed one just follow the instructions below. | |
33 | ||
34 | ### Compiling | |
35 | ||
36 | First you must get a copy of the uguu code. To do so, clone this git repo. | |
37 | ```bash | |
38 | git clone https://github.com/nokonoko/uguu | |
39 | ``` | |
40 | ||
a51784b6 GJ |
41 | **Run the following commands to do so, please configure `dist.json` before you compile.** |
42 | ```bash | |
43 | cd uguu/ | |
44 | make | |
45 | make install | |
46 | ``` | |
47 | OR | |
48 | ```bash | |
49 | make install DESTDIR=/desired/path/for/site | |
50 | ``` | |
51 | After this, the uguu site is now compressed and set up inside `dist/`, or, if specified, `DESTDIR`. | |
52 | ||
53 | ## Configuring | |
54 | ||
55 | Front-end related settings, such as the name of the site, and maximum allowable | |
56 | file size, are found in `dist.json`. Changes made here will | |
57 | only take effect after rebuilding the site pages. This may be done by running | |
58 | `make` from the root of the site directory. | |
59 | ||
60 | **Back-end related settings, such as database configuration, and path for uploaded files, are found in `includes/settings.inc.php`. Changes made here take effect immediately. Change the following settings:** | |
61 | ```php | |
62 | define('UGUU_DB_CONN', 'sqlite:/path/to/db/uguu.sq3'); | |
63 | define('UGUU_FILES_ROOT', '/path/to/file/'); | |
64 | define('UGUU_URL', 'https://subdomainforyourfiles.your.site'); | |
65 | ``` | |
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:** | |
73 | ```bash | |
74 | sqlite3 /path/to/db/uguu.sq3 "DELETE FROM files WHERE date <= strftime('%s', datetime('now', '-1 day'));" | |
75 | ``` | |
76 | ```bash | |
77 | find /path/to/files/ -mmin +1440 -exec rm -f {} \; | |
78 | ``` | |
79 | **Then add them to your crontab:** | |
80 | ```bash | |
81 | 0,30 * * * * bash /path/to/checkfiles.sh | |
82 | 0,30 * * * * bash /path/to/checkdb.sh | |
83 | ``` | |
84 | ||
85 | These scripts check if DB entries and files are older then 24 hours and if they are deletes them. | |
86 | ||
87 | ## MIME/EXT Blocking | |
88 | ||
89 | **Blocking certain filetypes from being uploaded can be changed by editing the following settings in `includes/settings.inc.php`:** | |
90 | ```php | |
91 | define('CONFIG_BLOCKED_EXTENSIONS', serialize(['exe', 'scr', 'com', 'vbs', 'bat', 'cmd', 'htm', 'html', 'jar', 'msi', 'apk', 'phtml', 'svg'])); | |
92 | define('CONFIG_BLOCKED_MIME', serialize(['application/msword', 'text/html', 'application/x-dosexec', 'application/java', 'application/java-archive', 'application/x-executable', 'application/x-mach-binary', 'image/svg+xml'])); | |
93 | ``` | |
c05fb5b7 | 94 | By default the most common malicious filetypes are blocked. |
a51784b6 | 95 | |
c05fb5b7 GJ |
96 | ## IP logging |
97 | This is turned off by default, but you can enable it by changing: | |
98 | ```php | |
99 | define('LOG_IP', 'false'); | |
100 | ``` | |
101 | ||
102 | ## Anti dupe | |
103 | This is turned off by default, if a user uploads a file already uploaded the link to the already existing file will be returned instead. | |
104 | ```php | |
105 | define('ANTI_DUPE', 'false'); | |
106 | ``` | |
a51784b6 GJ |
107 | |
108 | ## Using SQLite as DB engine | |
109 | ||
110 | We need to create the SQLite database before it may be used by uguu. | |
111 | Fortunately, this is incredibly simple. | |
112 | ||
113 | First create a directory for the database, e.g. `mkdir /var/db/uguu`. | |
114 | Then, create a new SQLite database from the schema, e.g. `sqlite3 /var/db/uguu/uguu.sq3 -init /home/uguu/sqlite_schema.sql`. | |
115 | Then, finally, ensure the permissions are correct, e.g. | |
116 | ```bash | |
117 | chown www-data:www-data /var/db/uguu | |
118 | chmod 0750 /var/db/uguu | |
119 | chmod 0640 /var/db/uguu/uguu.sq3 | |
120 | ``` | |
121 | ||
122 | Finally, edit `includes/settings.inc.php` to indicate this is the database engine you would like to use. Make the changes outlined below | |
123 | ```php | |
124 | define('UGUU_DB_CONN', '[stuff]'); ---> define('UGUU_DB_CONN', 'sqlite:/var/db/uguu/uguu.sq3'); | |
125 | define('UGUU_DB_USER', '[stuff]'); ---> define('UGUU_DB_USER', null); | |
126 | define('UGUU_DB_PASS', '[stuff]'); ---> define('UGUU_DB_PASS', null); | |
127 | ``` | |
128 | ||
129 | *NOTE: The directory where the SQLite database is stored, must be writable by the web server user* | |
d8c46ff7 | 130 | |
d501210d GJ |
131 | ## API |
132 | To upload using curl or make a tool you can post using: | |
36cfd3b8 GJ |
133 | ``` |
134 | curl -i -F files[]=@yourfile.jpeg https://uguu.se/upload.php (JSON Response) | |
135 | ``` | |
7c935615 GJ |
136 | ``` |
137 | curl -i -F files[]=@yourfile.jpeg https://uguu.se/upload.php?output=text (Text Response) | |
138 | ``` | |
139 | ``` | |
140 | curl -i -F files[]=@yourfile.jpeg https://uguu.se/upload.php?output=csv (CSV Response) | |
141 | ``` | |
142 | ``` | |
143 | curl -i -F files[]=@yourfile.jpeg https://uguu.se/upload.php?output=html (HTML Response) | |
144 | ``` | |
d501210d | 145 | |
d8c46ff7 GJ |
146 | ## Getting help |
147 | ||
63cfe4f6 | 148 | Hit me up at [@nekunekus](https://twitter.com/nekunekus) or email me at neku@pomf.se |
e3fe8ee9 | 149 | |
d8c46ff7 | 150 | ## Credits |
67a54d5c | 151 | |
0c9a152f | 152 | Uguu is based on [Pomf](http://github.com/pomf/pomf) which was written by Emma Lejack & Eric Johansson (nekunekus) and with help from the open source community. |
2239bd05 | 153 | |
d8c46ff7 | 154 | ## License |
2239bd05 | 155 | |
d8c46ff7 | 156 | Uguu is free software, and is released under the terms of the Expat license. See |
60d12367 | 157 | `LICENSE`. |