Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 163 lines (93 sloc) 10.049 kB
f5abbf8 initial version
Jeremy Bornstein authored
1 BASTARD
2 =======
3
4 The purpose of bastard is to serve static content over the web quickly, according to best practices, in a way that is easy to set up, run, and administer. It is implemented as a module intended to be run from within node.js. It may be invoked as part of another server process, serving only URLs with a given set of prefixes, or it may be the entire server all on its own. It will automatically minify and compress data, cache the data on disk, and verify the validity of its cached data on startup. While running, it keeps cached data in memory and does not expire data from the cache. Restarts should be relatively quick and easy because minified/compressed data will be read from the disk cache on the first request for that item.
5
e9574c2 better explanation, mention etag
Jeremy Bornstein authored
6 Additionally, bastard will automatically generate cryptographic fingerprints for all files it serves, and return this fingerprint as the value of the Etag header in its responses. Files are available at fingerprinted URLs so that they can be cached indefinitely by client browsers. You can programmatically ask it for the current fingerprinted URL for a file so that you can use that URL in HTML you generate external to the server. When bastard serves fingerprinted files, they are served with very long cache times because those URLs should always serve the same content.
f5abbf8 initial version
Jeremy Bornstein authored
7
2099a48 handle missing slashes and default filename. virtualhost support seem…
Jeremy Bornstein authored
8 CSS, Javascript, and HTML are minified, including CSS and Javascript inside HTML files. Files of other types are not modified, though they will be compressed for transmission if they're not image files. (Image files are never compressed by this software.) Note that in some rare cases, HTML minification can cause problems. In bastard, the HTML minification is not extremely aggressive and so will probably be fine. You can turn it off with a future config option if you are worried or actually find a problem in practice.
f5abbf8 initial version
Jeremy Bornstein authored
9
10
11 Installing
12 ==========
13
411e7e8 formatting
Jeremy Bornstein authored
14 npm install bastard
f5abbf8 initial version
Jeremy Bornstein authored
15
16
17 Running Standalone
18 ==================
19
20 Configure the settings via npm. There are reasonable defaults but you definitely need to specify the base directory where your files are:
21
411e7e8 formatting
Jeremy Bornstein authored
22 npm config bastard:base /path/with/good/intentions
23 npm start bastard
f5abbf8 initial version
Jeremy Bornstein authored
24
25 If you are running the standalone server and want to programmatically find out the current fingerprint for a file, make a request for the file with an incorrect fingerprint such as "BASTARD". The server's response will contain the valid fingerprint, which you may then parse out and use in your own externally-generated HTML.
26
27
28 Running from your own code
29 ==========================
30
31 1. Create the bastard object:
32
411e7e8 formatting
Jeremy Bornstein authored
33 var bastard = require ('bastard');
34 var Bastard = bastard.Bastard;
35 var bastardObj = new Bastard (config);
f5abbf8 initial version
Jeremy Bornstein authored
36
411e7e8 formatting
Jeremy Bornstein authored
37 // if you want to load every file into the cache before you get started:
38 bastardObj.preload (callback);
f5abbf8 initial version
Jeremy Bornstein authored
39
40 2. Create your own HttpServer object and pass requests to it from within the associated handler:
41
411e7e8 formatting
Jeremy Bornstein authored
42 var handled = bastardObj.possiblyHandleRequest (request, response);
f5abbf8 initial version
Jeremy Bornstein authored
43
fef463b format futzing
Jeremy Bornstein authored
44 If the above function returns true, the request has been handled and you don't need to do anything else. Depending on how you want to structure your server, you can check bastard before or after your own URLs.
f5abbf8 initial version
Jeremy Bornstein authored
45
46
661b6e6 tidy
Jeremy Bornstein authored
47 To find out the current fingerprint of a file
48 ---------------------------------------------
f5abbf8 initial version
Jeremy Bornstein authored
49
9d05241 more
Jeremy Bornstein authored
50 bastardObj.getFingerprint (filePath, basePath, function (err, fingerprint) {});
f5abbf8 initial version
Jeremy Bornstein authored
51
fef463b format futzing
Jeremy Bornstein authored
52 * `filePath`: full path to the file
53 * `basePath`: path to the file within the base directory (may be the same as the URL path for the file)
54 * `callback`: if present, will be called with the first argument being any error (or null) and the second argument being the fingerprint
f5abbf8 initial version
Jeremy Bornstein authored
55
661b6e6 tidy
Jeremy Bornstein authored
56 If callback is not present and the fingerprint is already known, it will be returned immediately as the result of the function call. If callback is not present and the fingerprint is not already known, the fingerprint will be internally calculated and null will be returned from the function call.
f5abbf8 initial version
Jeremy Bornstein authored
57
661b6e6 tidy
Jeremy Bornstein authored
58 You only need to specify one of filePath and basePath.
f5abbf8 initial version
Jeremy Bornstein authored
59
661b6e6 tidy
Jeremy Bornstein authored
60 For an example of how to run bastard from your own code, examine the file start.js in the bastard package.
61
62 To preload the entire base directory
63 ------------------------------------
f5abbf8 initial version
Jeremy Bornstein authored
64
9d05241 more
Jeremy Bornstein authored
65
66 bastardObj.preload (function (err) {});
67
661b6e6 tidy
Jeremy Bornstein authored
68 Calling this function and waiting until the callback is invoked will ensure that all fingerprints have been precalculated before any user requests are seen. It does not load all files into memory, but does load all information about each file, and ensure that each file has been minified (where possible) and compressed (when appropriate).
9d05241 more
Jeremy Bornstein authored
69
f5abbf8 initial version
Jeremy Bornstein authored
70
71 Configuration
72 =============
73
c803b79 clarify and fix
Jeremy Bornstein authored
74 The following configuration variables may be set with `npm config bastard:xxx yyy` where `xxx` is the name of the parameter and `yyy` is the desired value. More help on configuration variables may be obtained via `npm`. These variables also correspond to keys which may be present in single argument to the `Bastard` object's constructor. (In the constructor, however, the URL patterns all default to null--that is, not checked.)
f5abbf8 initial version
Jeremy Bornstein authored
75
c803b79 clarify and fix
Jeremy Bornstein authored
76 Note that there are some not-too-complicated subtleties in URL matching. The raw prefix, if defined, is checked first, followed by the fingerprint prefix (if defined), and then only the regular prefix (if defined)--and the first match is considered to be definitive. This means that with the default values provided in the standalone server, if you have a directory called "raw" in your base directory, those files will never be served except as raw or fingerprinted.
f5abbf8 initial version
Jeremy Bornstein authored
77
78
a972eab clarification and format improvements
Jeremy Bornstein authored
79 `base` Directory where files to be served reside. (Default: empty)
f5abbf8 initial version
Jeremy Bornstein authored
80
2099a48 handle missing slashes and default filename. virtualhost support seem…
Jeremy Bornstein authored
81 `defaultFileName` The name of the default file when a path ending in '/' is specified. (Default: /index.html/)
82
c803b79 clarify and fix
Jeremy Bornstein authored
83 `rawURLPrefix` The prefix for URLs from which raw files should be served. These will be just as they are on disk: not minified, not compressed. (Default: /raw/)
f5abbf8 initial version
Jeremy Bornstein authored
84
c803b79 clarify and fix
Jeremy Bornstein authored
85 `fingerprintURLPrefix` The prefix for URLs from which fingerprinted files should be served. The fingerprint will appear in the URLs after this prefix followed by the relative pathname to the file in the base directory. (Default: /f/)
f5abbf8 initial version
Jeremy Bornstein authored
86
c803b79 clarify and fix
Jeremy Bornstein authored
87 `urlPrefix` The prefix for URLs from which non-fingerprinted files should be served. (Default: /)
83b7461 add new configuration variable to documentation
Jeremy Bornstein authored
88
c803b79 clarify and fix
Jeremy Bornstein authored
89 `workingDir` The location for temporary files to be kept. This includes on-disk copies of minified and compressed files that originate in the base directory. (Default: /tmp/bastard.dat)
f5abbf8 initial version
Jeremy Bornstein authored
90
c803b79 clarify and fix
Jeremy Bornstein authored
91 `debug` If true, turns on some debugging functionality. (Default: false)
92
93 `directories` If true, will generate directory listings. (Not yet implemented.) (Default: false)
a972eab clarification and format improvements
Jeremy Bornstein authored
94
f40ea48 keep track of PID. version bump
Jeremy Bornstein authored
95 `pidFile` The file into which to write the PID of the server. (Default: /var/run/bastard.pid)
96
2099a48 handle missing slashes and default filename. virtualhost support seem…
Jeremy Bornstein authored
97 `virtualHostMode` If true, directories in `base` represent hostnames. Files will be served from the matching directory based on the HTTP 1.1 hostname received. If there is no match, the first compoent (e.g. "www." from "www.example.com") is removed and the match is tried again. If there is still no match, the default directory is used. (See below)
98
99 `defaultHost` The name of the directory to be used when the HTTP 1.1 hostname matches no other directory. Used only when `virtualHostMode` is true.
a972eab clarification and format improvements
Jeremy Bornstein authored
100
c803b79 clarify and fix
Jeremy Bornstein authored
101 Standalone Server
102 -----------------
f5abbf8 initial version
Jeremy Bornstein authored
103
9d05241 more
Jeremy Bornstein authored
104 In addition, the following configuration parameters are used only by the standalone server and do not correspond to constructor arguments:
f5abbf8 initial version
Jeremy Bornstein authored
105
c803b79 clarify and fix
Jeremy Bornstein authored
106 `host` Hostname or IP address at which to listen. If empty, will bind to all available IP addresses. (Default: empty)
107
108 `port` Port number at which to listen. (Default: 80)
109
110 `preload` If true, a cache record will be created for each available file before the server begins. This will not load all data from disk, but will calculate all new fingerprints necessary.
f5abbf8 initial version
Jeremy Bornstein authored
111
112
113
114 Limitations
115 ===========
116
117 If the mime type for a file begins with "image/", it will not be gzipped. All other files will be gzipped if the client indicates that it can understand gzipped data. This may not be the best choice for all file types.
118
119
120 Project Status
121 ==============
122
123 This is a project built by the author for his own use. Contributions are welcomed.
124
b0fce15 update project repository url
Jeremy Bornstein authored
125 The public repository for the project is found at: https://github.com/unprolix/bastard
f5abbf8 initial version
Jeremy Bornstein authored
126
3dba96d Update documentation and bump version
Jeremy Bornstein authored
127 Future features:
128
129 * Ability to use an API, instead of the filesystem, as the source of files to be served. This would allow serving data from (e.g.) key/value stores.
130
a972eab clarification and format improvements
Jeremy Bornstein authored
131 * Ability to use an API to upload processed files from base directory to a key/value store--including fingerprinted URLs. This would allow bastard to front for a CDN.
3dba96d Update documentation and bump version
Jeremy Bornstein authored
132
f5abbf8 initial version
Jeremy Bornstein authored
133
134 License
135 =======
136
137 Copyright 2011, Jeremy Bornstein <jeremy@jeremy.org>
138 All rights reserved.
139
140 Redistribution and use in source and binary forms, with or without
141 modification, are permitted provided that the following conditions are met:
142
143 * Redistributions of source code must retain the above copyright
144 notice, this list of conditions and the following disclaimer.
145
146 * Redistributions in binary form must reproduce the above copyright
147 notice, this list of conditions and the following disclaimer in the
148 documentation and/or other materials provided with the distribution.
149
78e0c03 tidy
Jeremy Bornstein authored
150 * Neither the name of the project nor the names of its contributors may
151 be used to endorse or promote products derived from this software
152 without specific prior written permission.
f5abbf8 initial version
Jeremy Bornstein authored
153
154 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
155 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
156 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
157 DISCLAIMED. IN NO EVENT SHALL JEREMY BORNSTEIN BE LIABLE FOR ANY
158 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
159 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
160 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
161 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
162 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
163 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Something went wrong with that request. Please try again.