Issue #1014466 by greggles: followup, code style cleanup
[project/stage_file_proxy.git] / INSTALL.txt
1 STEPS TO INSTALL:
2 =========
3 1. Enable the module.
4
5 2. Add variables to $conf in settings.php:
6
7 REQUIRED:
8 =========
9
10 The origin website.
11
12 $conf['stage_file_proxy_origin'] = 'http://example.com'; // no trailing slash
13
14 If the site is using HTTP Basic Authentication (the browser popup for username
15 and password) you can embed those in the url. Be sure to URL encode any
16 special characters:
17
18 For example, setting a user name of "myusername" and password as, "letme&in" the
19 configuration would be the following:
20
21 $conf['stage_file_proxy_origin'] = 'http://myusername:letme%26in@example.com';
22
23 OPTIONAL
24 ========
25 $conf['stage_file_proxy_use_imagecache_root'] = TRUE;
26
27 Default is TRUE.
28
29 If this is true (default) then Stage File Proxy will look for /imagecache/ in
30 the URL and determine the original file and request that rather than the
31 processed file, then send a header to the browser to refresh the image and let
32 imagecache handle it. This will speed up future imagecache requests for the
33 same original file.
34
35 $conf['stage_file_proxy_hotlink'] = FALSE;
36
37 Default is FALSE.
38
39 If this is true then Stage File Proxy will not transfer the remote file to the
40 local machine, it will just serve a 301 to the remote file and let the origin
41 webserver handle it.
42
43 $conf['stage_file_proxy_origin_dir'] = 'sites/default/files';
44
45 Default is 'sites/default/files';
46
47 If this is set then Stage File Proxy will use a different path for the remote
48 files. This is useful for multisite installations where the sites directory
49 contains different names for each url. If this is not set, it defaults to the
50 same path as the local site (sites/default/files).
51
52 $conf['stage_file_proxy_sslversion'] = 3;
53
54 Default is 3.
55
56 CURL will try to figure out which ssl version to use, but if it fails to do that
57 properly it can lead to getting an empty file and a 0 status code. The default
58 is 3 which seems relatively common, but if you get 0 byte files you can try
59 changing it to 2.
60
61 DRUSH USERS
62 ===========
63
64 To automatically enable stage_file_proxy on your dev machine after sql-sync,
65 add the following to your dev site alias file:
66
67   $aliases['dev'] = array (
68     'root' => '/path/to/drupalroot',
69     'uri' => 'http://example.org',
70     'target-command-specific' => array(
71       'sql-sync' => array(
72         'enable' => array('stage_file_proxy'),
73       ),
74     ),
75   );
76
77 In order for this to work, you must copy the file
78 drush/examples/sync_enable.drush.inc to your ~/.drush folder.
79 For more information, see:
80
81 http://drupalcode.org/project/drush.git/blob/HEAD:/examples/sync_enable.drush.inc