hfs 0.38.3 → 0.40.0

package/README.md

@@ -42,6 +42,7 @@ This is a full rewrite of [the Delphi version](https://github.com/rejetto/hfs2).
 - multi-language front-end
 - virtual hosting (plug-in)
 - anti-brute-force (plug-in)
+- reverse-proxy support
 
 ## Installation
 
@@ -189,8 +190,8 @@ Valid keys in a node are:
     - `false`: no one can.
     - `"*"`: any account can, i.e. anyone who logged in.
     - `[ frank, peter ]`: the list of accounts who can.
-- `can_see`: specify who can see this entry. Even if a user can download you can still make the file not appear in the list.
-  Remember that to see in the list you must also be able to download (read), or else you won't see it anyway. Value is a `WhoCan` descriptor, refer above.
+- `can_see`: specify who can see this element. Even if a user can download you can still make the file not appear in the list.
+  Value is a `WhoCan` descriptor, refer above.
 - `can_upload` specify who can upload. Applies to folders with a source. Default is none. 
 - `can_delete` specify who can delete. Applies to folders with a source. Default is none.
 - `masks`: maps a file mask to a set of properties as the one documented in this section. E.g.
@@ -230,6 +231,30 @@ For each account entries, this is the list of properties you can have:
 - `admin` set `true` if you want to let this account log in to the Admin-panel. Default is `false`.
 - `belongs` an array of usernames of other accounts from which to inherit their permissions. Default is none.
 
+## Reverse proxy
+
+HFS can work behind a reverse proxy. Configuration depends on what software you use, but this is an example using nginx
+exposing HFS under the path `/files/` instead of just `/`. Adjust it to suit your needs. 
+
+```
+location /files/ {
+  proxy_http_version 1.1;
+  keepalive_timeout 30;
+  proxy_buffering off;
+  proxy_redirect off;
+  proxy_max_temp_file_size 0;
+  proxy_set_header        X-Forwarded-For $proxy_add_x_forwarded_for;  # forward IP address
+  proxy_set_header        X-forwarded-prefix "/files"; # the location without final slash
+  client_max_body_size    0;  # disable max size for uploads
+  proxy_pass      http://127.0.0.1:80/;
+}
+```
+
+This is enough, but you may want to configure generated links accordingly:
+- go to Admin-panel > Shared files > Home > Link
+- click the change button (right side of the field)
+- enter the final URL of your proxy including the location
+    
 ## License
 
 [GPLv3](https://github.com/rejetto/hfs/blob/master/LICENSE.txt)