forked from farhadi/SmartOptimizer
/
README
58 lines (46 loc) · 2.84 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
SmartOptimizer v1.8.1 alpha
------------------------
Author: Ben Charlton (https://github.com/Narimm)
@Depreciated Original Author: Ali Farhadi (http://farhadi.ir/)
Released under the terms of the GNU Public License.
See the GPL for details (http://www.gnu.org/licenses/gpl.html).
What is SmartOptimizer?
-----------------------
SmartOptimizer is a php program that enhances your website performance using
techniques such as minifying, compression, caching, concatenation and embedding.
The idea is based on yahoo performace rules (http://developer.yahoo.com/performance/rules.html).
SmartOptimizer Features
-----------------------
* SmartOptimizer Increases your website download speed by reducing the size of JavaScript and
CSS files approximately up to 80% or even higher.
* Reduces count of http requests by combining js/css files together.
* Also reduces count of http requests by embedding css images inside css files.
* SmartOptimizer generates minified, compressed, combined and embedded files on the
first request and caches them on the server and uses the cache on future requests.
* It doesn't embed duplicated urls (i.e. css sprites) in css files for better performance.
* It also knows to regenerate already cached files if the originals have been changed.
* SmartOptimizer handles browsers that doesn't support gzip encoding and sends them non-gzipped content.
* It also forces the browser to cache the files optionally forever or until they have not changed.
* SmartOptimizer removes Etag headers. (for better performance on clustered servers).
* It is easy to install, since it requires no code modifications whatsoever. (other than .htaccess)
* All the features is configurable using config file.
Installation Requirements
-------------------------
* PHP 4.3.0 or higher.
* Apache with mod_rewrite enabled.
Installation Instructions
------------------------
1. Upload smartoptimizer folder to your website.
2. "smartoptimizer/cache" folder should be writable (in most cases 777 permission is needed).
3. Upload htaccess-smartoptimizer.txt file on the folder that smartoptimizer folder is placed, if there is no another .htaccess file currently rename it to .htaccess
Otherwise, Copy content of htaccess-smartoptimizer.txt and paste it inside your current htaccess at the beginning of the file.
4. Access your site as normal to check everything works
5 ../Smartoptimizer/config.php has settings you can tweak and change.
Bug reports
-----------
SmartOptimizer is in beta stage and needs a large scale testing specially for its css and js minifiers.
So any feedback is greatly appreciated.
Use the issue tracker at github for bug reports:
https://github.com/Narimm/SmartOptimizer/issues
Please ensure your reports include the site you are working on and any errors reported -
this program is not intended for live production sites as it is only in Beta and needs more testing.