Differences

This shows you the differences between two versions of the page.

--- litespeed_wiki:config:internal-redirect [2017/04/21 13:04]
Michael Alegre [Internal Redirect via LiteSpeed]
+++ litespeed_wiki:config:internal-redirect [2018/09/27 21:13]
Jackson Zhang
@@ Line 1: / Line 1: @@
 ====== Internal Redirect ======
+Web server internal redirect via backend response header, aka X-Sendfile or X-Accel-Redirect, is a feature used by some web backend developers and popularized by Ruby on Rails. LSWS and OLS use a simple header "Location" or "X-LiteSpeed-Location" to achieve the same goal.
-===== Introduction =====
+===== What is this internal redirect via response header? =====
-Web server internal redirect via backend response header, aka X-Sendfile or X-Accel-Redirect, is a feature used by some web backend developers and popularized by Ruby on Rails.
-=== What is this internal redirect via response header? ===
 The backend process, instead of returning a full HTTP page response back, return only a pointer to a local path.
@@ Line 14: / Line 11: @@
 The end user is not aware of this internal redirection and the data returns appears from the original url.
+===== Implemente internal redirect on LiteSpeed through header =====
+To get this to work on LiteSpeed, just use a simple header "X-LiteSpeed-Location" in your php script.
+==== Method 1: Set header "Location" in your php script ====
+Set "**Location**" header pointing to a URL without ''<nowiki>http://domain</nowiki>'', just the URL without the hostname part. Do not set a "**Status**" header in response. Make sure no "Status" header is returned. PHP always adds "**Status**" header automatically when a "**Location**" header was set.
+  <?php
+  header('Location: /php-icon.png');
+  ?>
+==== Method 2: Set header "X-LiteSpeed-Location" in your php script ====
+Add a special header "**X-LiteSpeed-Location**" starting from LSWS 3.0.2 to address this, just use it in the same way as a "**Location**" header and it is the recommended way to implement Internal Redirect on LSWS.
+For example, put a line like below to the php script:
-===== Internal Redirect via LiteSpeed =====
+  header('X-LiteSpeed-Location: /path/to/file_to_be_redirected');
-To get this to work on LiteSpeed, just use a simple header "X-LiteSpeed-Location".
+**Note:** "/path/to/file_to_be_redirected" should be URL without http://domain but with "/", such as: **test.php** in document root. LSWS only supports "URL" instead of "file path".
+  <?php
+  header('X-LiteSpeed-Location: /img/php-icon.png');
+  ?>
-=== Details ===
+That's it, folks. LiteSpeed will take over the rest, perform an internal redirect, and send back the file with sendfile() support if the URL points to a static file.
-In the return response, follow the directions below:
+Run a test through
+  http://yourdomain.com/test.php
-  - Return a normal "**Location**" header without ''<nowiki>http://domain</nowiki>'', just the URL without the hostname part.
+It will return the php-icon.png image.
-  - Do not set a "**Status**" header in response. Make sure no "Status" header is returned.
-  - PHP always adds "**Status**" header automatically when a "**Location**" header was set, we added a special header "**X-LiteSpeed-Location**" in 3.0.2 to address this, just use it in the same way as a "**Location**" header. For example, just put a line like below to the php script:
-    X-LiteSpeed-Location: /path/to/file_to_be_redirected
+==== How to download file instead of showing in browser? ====
+If you want to download file instead of showing in browser, you can add extra header "Content-Disposition" like the following:
-That's it folks. LiteSpeed will take over the the rest, perform an internal redirect, and send back the file with sendfile() support if the url points to a static file.
+  <?php
+  header('Content-Disposition: attachment; filename = php-icon.png');
+  header('X-LiteSpeed-Location: /img/php-icon.png');
+  ?>
+then run http://yourdomain.com/test.php will download php-icon.png instead of showing in browser.
-=== Ruby-on-Rails===
+==== LiteSpeed uses a "URL" instead of "file path" ====
-A short example on how to use Internal Redirect for sending files within a RoR Controller.  Below is a sendfile function that can be attached to any action.
-  def sendfile
-    @name = session[:filename]                 # a session variable set in a view or other function
-    filename = "public/download/" + @name      # create the URI, must be under /public
-    headers["Location"] = filename             # set the 'Location header
-    redirect_to(filename)                      # redirect
-  end
-=== Security Consideration ===
 Unlike X-Sendfile or X-Accel-Redirect implementation in other web servers, LiteSpeed uses a URL instead of file path for security reasons. In this way, only file under document root of a virtual host or a Context can be returned, otherwise, it could be a huge security issue if for some reason, either tricked or intentionally, the script sent back a header "X-Sendfile: /../etc/./passwd%00" or something like that, user accounts on your server is no longer a secret. 8-)
-=== Protecting file from direct access ===
+==== Protecting file from direct access ====
 If you want to prevent user from access the file directly, just use a hard to guess URL like "/you_never_know/where_file_is_stored/...", or you can use a rewrite rule (in httpd.conf) to deny direct access to the directory holding the files, something like
@@ Line 68: / Line 70: @@
 Another advantage of our internal redirect implementation is that it does not limited to sending static files, it can be used to pass the request to another script for further processing. :-)
+===== Ruby-on-Rails=====
+A short example on how to use Internal Redirect for sending files within a RoR Controller.  Below is a sendfile function that can be attached to any action.
+  def sendfile
+    @name = session[:filename]                 # a session variable set in a view or other function
+    filename = "public/download/" + @name      # create the URI, must be under /public
+    headers["Location"] = filename             # set the 'Location header
+    redirect_to(filename)                      # redirect
+  end