Merge pull request #46 from 1265578519/patch-1

[uguu.git] / README.md

diff --git a/README.md b/README.md
index dc02f16098bc13fb4661a31a066f8f7e768c4234..110eda774168cdb6eb981aee63a4fabca0f5bd80 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
 # About
-Temp file sharing application source code, stores files and deletes after X amount of time. Forked from Uguu.se available [here](https://github.com/nokonoko/uguu).
+[Uguu.se](http://uguu.se) source code, stores files and deletes after X amount of time.
 
 # Tested with:
 * Nginx+PHP5-FPM (PHP 5.4) on Debian 7 Wheezy
@@ -9,13 +9,14 @@ Temp file sharing application source code, stores files and deletes after X amou
 
 # Install:
 
-* Deploy base code, for example with `git clone `
+* Deploy base code, for example with `git clone https://github.com/nokonoko/Uguu.git`
 * Modify includes/config.php (copy config.template.php as a starting point) to set up the main options for Uguu.
 * Some file extensions are blocked by default, this can be changed via includes/config.php's CONFIG_BLOCKED_EXTENSIONS value.
-* Execute check.sh regularly with cron to delete old files: `crontab -e` and add `0,15,30,45 * * * * bash /path/to/check.sh` (or adapt if you know how cron works).
+* Copy `rain/template/footer.template.html` as `rain/template/footer.html` and personalize the footer as you wish
+* Execute check.sh regularly with cron to delete old files: `crontab -e` and add `0,15,30,45 * * * * cd /path/to/uguu/includes && bash check.sh` (or adapt if you know how cron works).
 * Make the Uguu/public/files and Uguu/rain/cache directory modifiable by the web server user:
 `chown -R www-data:www-data /path/to/Uguu/public/files` and `chown -R www-data:www-data /path/to/Uguu/rain/cache`
-* Make sure the Uguu/public/files folder is not indexable, you may use a virtual host config similar to this one:
+* Make sure the Uguu/public/files folder is not indexable, you may use a virtual host config similar to this one using Apache:
 
 ```
 <VirtualHost *:80>
@@ -29,14 +30,65 @@ Temp file sharing application source code, stores files and deletes after X amou
 
         Alias "/files" "/var/www/Uguu/public/files/"
         <Directory /var/www/Uguu/public/files/>
-                AllowOverride None
-                Options -Indexes
-                Require all granted
+          <Files *>
+            SetHandler default-handler
+          </Files>
+          AllowOverride None
+          Options -Indexes
+          Require all granted
         </Directory>
 
 </VirtualHost>
 ```
 
+Or something like this using Nginx+PHP-FPM:
+
+uguu.se
+```
+server{
+    listen              104.243.35.197:80;
+    server_name         uguu.se www.uguu.se;
+
+    root                        /home/neku/www/uguu/;
+    autoindex           off;
+    index                       index.html index.php;
+
+    location ~* \.php$ {
+        fastcgi_pass unix:/var/run/php5-fpm.sock;
+        fastcgi_intercept_errors on;
+        fastcgi_index index.php;
+        fastcgi_split_path_info ^(.+\.php)(.*)$;
+        include fastcgi_params;
+        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
+    }
+
+        error_page 404 /404.html;
+        error_page 403 /404.html;
+        location /404.html {
+        root /home/neku/www;
+        }
+}
+```
+
+a.uguu.se (notice that scripts e.g PHP will NOT be executed from this subdomain)
+```
+server{
+    listen          104.243.35.197:80;
+    server_name     a.uguu.se www.a.uguu.se;
+
+    root            /home/neku/www/files;
+    autoindex       off;
+    index           index.html;
+
+        error_page      404 /404.html;
+        error_page      403 /404.html;
+        location /404.html {
+        root /home/neku/www;
+        }
+}
+```
+
+
 # Using the API
 
   * Leaving POST value 'name' empty will cause it to save using the original filename.