Commits

Zachary Voase  committed de1a6b0

More documentation changes.

  • Participants
  • Parent commits c3dd9cb

Comments (0)

Files changed (4)

File docs/_static/media/css/layout.css

 body, html {
-	background-color: #bfbfbf;
+	background-color: #f6f6f6;
 	margin: 0;
 	padding: 0;
 }
 
 div#breadcrumbs {
-	border-bottom: 4px dashed #bfbfbf;
+	border-bottom: 4px dashed #f6f6f6;
 	margin: 0 -1.2em;
 	padding: 0.3em 1.4em 0.3em 1.4em;
 }
 }
 
 h1 {
-	border-bottom: 1px solid #bfbfbf;
-	margin: 0.3em 0 0.5em 0;
+	margin: 0.3em 0;
 	padding: 0.1em 0;
 }
 
 }
 
 p#footer {
-	border-top: 1px solid #bfbfbf;
-	padding-top: 0.9em;
+	border-top: 1px solid #999;
+	padding: 0.7em 0;
 	font-size: 0.7em;
 	text-align: center;
 	margin-bottom: 0;
 	
 }
 
-p > code,
-dd > code,
-dl > code,
-li > code,
-h1 > code,
-h2 > code,
-h3 > code,
-h4 > code,
-h5 > code,
-h6 > code {
-	background-color: #bfbfbf;
-	border: 1px solid #aaa;
+code {
+	background-color: #f6f6f6;
+	border: 1px solid #999;
+	border-left: none;
+	border-right: none;
 	padding-left: 4px;
 	padding-right: 4px;
 	white-space: nowrap;
+	margin-left: 1px;
+	margin-right: 1px;
 }
 
 a {
 	padding: 0 0.2em 0.1em 0.2em;
 }
 
-a code, a:hover code {
+a code {
 	background: none;
 	border: none;
-	padding: none;
-	margin: none;
+	padding: 0;
+	margin: 0;
 	text-decoration: inherit;
 }
 
 pre, blockquote {
 	background-color: #f6f6f6;
 	border: 1px solid #999;
-	border-left-width: 3px;
+	border-left: none;
+	border-right: none;
 	line-height: 1.5em;
 	margin-left: 1.2em;
 	margin-right: 1em;
 	padding: 0.5em;
+	padding-left: 1em;
 }
 
 pre {

File docs/index.md

 
 Django-in-a-Box currently only runs on UNIX-based systems. That means Mac OS X, *BSD, GNU/Linux and a few others. Unfortunately, I have neither the time, the resources nor the inclination to work around the issues which Windows presents; if you want to fork the project and add support yourself, go ahead.
 
+## Prerequisites
+
+To run Django-in-a-Box, you’ll need to install a couple of applications. Most of the necessary Python libraries are automatically installed by DiaB, but in order to run the bootstrap the process, you’ll need:
+
+* Python (included with almost every UNIX system today)
+* Paver (`easy_install Paver`)
+* virtualenv (`easy_install virtualenv`)
+* lighttpd (see its page in the [tools documentation](/tools/lighttpd))
+
 ## Version Control
 
 Django-in-a-Box was built to work well with Version Control Systems. There are just a couple of things to remember:

File docs/tools/lighttpd.md

 
 [lighttpd][lighttpd] (pronounced ‘lighty’) is a small, lightweight, fully-featured HTTP web server. From its web page:
 
-> Security, speed, compliance, and flexibility — all of these describe lighttpd (pron. lighty) which is rapidly redefining efficiency of a webserver; as it is designed and optimized for high performance environments. With a small memory footprint compared to other web-servers, effective management of the cpu-load, and advanced feature set (FastCGI, SCGI, Auth, Output-Compression, URL-Rewriting and many more) lighttpd is the perfect solution for every server that is suffering load problems.
+> Security, speed, compliance, and flexibility — all of these describe lighttpd (pronounced lighty) which is rapidly redefining efficiency of a webserver; as it is designed and optimized for high performance environments. With a small memory footprint compared to other web-servers, effective management of the CPU load, and advanced feature set (FastCGI, SCGI, Auth, Output-Compression, URL-Rewriting and many more) lighttpd is the perfect solution for every server that is suffering load problems.
 
 lighttpd comes with FastCGI baked in, so you won’t need to install any additional modules. It also uses a very simple configuration file syntax, that you can understand and edit without having to take a 4-week course.
 
+## Installation
+
+Most variants of UNIX have their own package management system: `apt-get` on Debian, `rpm` on Red Hat and Fedora, `emerge` on Gentoo, `port` on FreeBSD, et cetera. If this is the case for your system, the package manager will definitely be the quickest and easiest way of installing lighttpd.
+
+## Compilation (including Mac OS X)
+
+On Mac OS X, lighttpd must be compiled, since there are no official OS X binaries. You can use a system like MacPorts if you wish (perhaps the most convenient method). Instructions on compilation and installation can be found on [HiveLogic][osx-install]. That post uses the 1.4.11 release of lighttpd, but you’ll want to use the latest stable version available.
+
+lighttpd uses the standard autoconf routine: `./configure && make && make install`. The only external dependency is the PCRE (Perl-compatible Regular Expressions) library, which can be found at <http://www.pcre.org/>.
+
 [lighttpd]: http://www.lighttpd.net/
+[osx-install]: http://hivelogic.com/articles/ruby_rails_lighttpd_mysql_tiger

File docs/tools/supervisor.md

 
 [Supervisor][Supervisor] is a tool for starting, stopping and managing processes. It is used in Django-in-a-Box to manage the lighttpd and FastCGI processes. You can also run daemons like task queues and various workers.
 
-By default, Supervisor is configured with a program called `memmon` which will kill any runaway processes (by default, those with a memory consumption greater than 300MB). For more information on configuring the `memmon` command, consult the documentation at the [Superlance PyPI page][Superlance].
+In the initial DiaB setup, Supervisor is configured with a program called `memmon` which will kill any runaway processes (by default, those with a memory consumption greater than 300MB). For more information on configuring the `memmon` command, consult the documentation at the [Superlance PyPI page][Superlance].
 
 The [Supervisor Manual][svd-manual] provides far better documentation than I can hope to provide here. I can, however, offer some good recipes for Django-in-a-Box:
 
     
     socket.error: [Errno 61] Connection refused
 
-That's usually a signal that Supervisor is not running. Check the `site_dir/log/supervisord.log` file for more information if this persists after running `supervisord` again.
+That usually means that Supervisor is not running. Check the `site_dir/log/supervisord.log` file for more information if this error persists.
 
 [Supervisor]: http://supervisord.org/
 [Superlance]: http://pypi.python.org/pypi/superlance