modules/cdn/README.txt

// $Id: README.txt,v 1.2 2008/01/05 13:47:08 wimleers Exp $

Applying the Drupal core patch
------------------------------

You *must* apply this patch!

First, change the directory to the Drupal root directory.

You can apply the included Drupal core patch like this:
  patch -p0 < drupal_core_cdn_integration.patch

To undo the patch:
  patch -p0 -R < drupal_core_cdn_integration.patch


Applying the theme patch
------------------------

You *must* apply this patch to *every* theme that's being used on your website!

Repeat this process for every theme: first, change the directory to the
directory of the theme. Applying the patch is identical to the example above,
only with a different filename.


Setting up CDN sync filters
---------------------------
- paths: This is an array of paths (each path being relative to the Drupal
         root directory) on which this filter should be applied.
- pattern: A regular expression that will be used to filter the files in each
           directory. Like the $mask parameter in file_scan_directory().
- ignored_dirs: An array of directories that should be ignored in each
                directory. Like the $nomask parameter in file_scan_directory().
- unique: Determines how the uniqueness will be applied. You can set it to
          'filename', which will alter the filename, or 'common parent
          directory', which will alter the path of the file. The latter is
          strongly recommended for themes, since it will not break URLs in
          CSS files.
- unique_method: The method that should be used to generate unique filenames.
                 Currently supported: 'mtime' (the file's mtime property), 
                 'md5' (md5 hash of the file) or 'md5 of mtimes' (md5 hash of
                 the concatenated mtimes of a set of files). This last option
                 is only available if you have set the unique property to
                 'common parent directory'.


Configuring the $conf array in settings.php
-------------------------------------------

This is my configuration:

$conf = array(
  'cdn_url' => 'http://wimleers.cachefly.com/wimleers.com',
  'cdn_sync_filters' => array(
  'cdn_sync_filters' => array(
    0 => array(
      'paths' => array('misc', 'profiles', 'modules', 'sites/all/modules', 'sites/default/modules'),
      'pattern' => '.*\.(js|css|gif|png|jpg|jpeg|svg|swf)$',
      'ignored_dirs' => array('CVS'),
      'unique' => 'filename',
      'unique_method' => 'mtime',
    ),
    1 => array(
      'paths' => array('sites/wimleers.com/files'),
      'pattern' => '.*',
      'ignored_dirs' => array('CVS', 'css'),
      'unique' => 'filename',
      'unique_method' => 'mtime',
    ),

    2 => array(
      'paths' => array('sites/wimleers.com/files/css'),
      'pattern' => '.*',
      'ignored_dirs' => array('CVS'),
      'unique' => 'filename',
      'unique_method' => 'mtime',
      'update_urls_in_files' => TRUE,
    ),
    3 => array(
      'paths' => array('sites/default/themes/garland-customized'),
      'pattern' => '.*\.(js|css|gif|png|jpg|jpeg|otf)$',
      'ignored_dirs' => array('CVS'),
      'unique' => 'common parent directory',
      'unique_method' => 'md5 of mtimes',
    ),
  ),
  'cdn_sync_method' => 'ftp',
  'cdn_sync_method_settings' => array(
    'host' => 'ftp.cachefly.com',
    'remote_path' => 'wimleers.com',
    'port' => 21,
    'user' => 'user',
    'pass' => 'pass',
  ),
);
1	// $Id: README.txt,v 1.2 2008/01/05 13:47:08 wimleers Exp $
2
3	Applying the Drupal core patch
4	------------------------------
5
6	You must apply this patch!
7
8	First, change the directory to the Drupal root directory.
9
10	You can apply the included Drupal core patch like this:
11	patch -p0 < drupal_core_cdn_integration.patch
12
13	To undo the patch:
14	patch -p0 -R < drupal_core_cdn_integration.patch
15
16
17	Applying the theme patch
18	------------------------
19
20	You must apply this patch to every theme that's being used on your website!
21
22	Repeat this process for every theme: first, change the directory to the
23	directory of the theme. Applying the patch is identical to the example above,
24	only with a different filename.
25
26
27	Setting up CDN sync filters
28	---------------------------
29	- paths: This is an array of paths (each path being relative to the Drupal
30	root directory) on which this filter should be applied.
31	- pattern: A regular expression that will be used to filter the files in each
32	directory. Like the $mask parameter in file_scan_directory().
33	- ignored_dirs: An array of directories that should be ignored in each
34	directory. Like the $nomask parameter in file_scan_directory().
35	- unique: Determines how the uniqueness will be applied. You can set it to
36	'filename', which will alter the filename, or 'common parent
37	directory', which will alter the path of the file. The latter is
38	strongly recommended for themes, since it will not break URLs in
39	CSS files.
40	- unique_method: The method that should be used to generate unique filenames.
41	Currently supported: 'mtime' (the file's mtime property),
42	'md5' (md5 hash of the file) or 'md5 of mtimes' (md5 hash of
43	the concatenated mtimes of a set of files). This last option
44	is only available if you have set the unique property to
45	'common parent directory'.
46
47
48	Configuring the $conf array in settings.php
49	-------------------------------------------
50
51	This is my configuration:
52
53	$conf = array(
54	'cdn_url' => 'http://wimleers.cachefly.com/wimleers.com',
55	'cdn_sync_filters' => array(
56	'cdn_sync_filters' => array(
57	0 => array(
58	'paths' => array('misc', 'profiles', 'modules', 'sites/all/modules', 'sites/default/modules'),
59	'pattern' => '.*\.(js\|css\|gif\|png\|jpg\|jpeg\|svg\|swf)$',
60	'ignored_dirs' => array('CVS'),
61	'unique' => 'filename',
62	'unique_method' => 'mtime',
63	),
64	1 => array(
65	'paths' => array('sites/wimleers.com/files'),
66	'pattern' => '.*',
67	'ignored_dirs' => array('CVS', 'css'),
68	'unique' => 'filename',
69	'unique_method' => 'mtime',
70	),
71
72	2 => array(
73	'paths' => array('sites/wimleers.com/files/css'),
74	'pattern' => '.*',
75	'ignored_dirs' => array('CVS'),
76	'unique' => 'filename',
77	'unique_method' => 'mtime',
78	'update_urls_in_files' => TRUE,
79	),
80	3 => array(
81	'paths' => array('sites/default/themes/garland-customized'),
82	'pattern' => '.*\.(js\|css\|gif\|png\|jpg\|jpeg\|otf)$',
83	'ignored_dirs' => array('CVS'),
84	'unique' => 'common parent directory',
85	'unique_method' => 'md5 of mtimes',
86	),
87	),
88	'cdn_sync_method' => 'ftp',
89	'cdn_sync_method_settings' => array(
90	'host' => 'ftp.cachefly.com',
91	'remote_path' => 'wimleers.com',
92	'port' => 21,
93	'user' => 'user',
94	'pass' => 'pass',
95	),
96	);