Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Documentation for the config file

  • Loading branch information...
commit 92aa3227f5e59d0e24e98c0d2778ad0b952c5b8f 1 parent d6347a0
@evanmiller evanmiller authored
View
14 README.markdown
@@ -1,6 +1,9 @@
Getting Started With Chicago Boss
=================================
+Quickstart
+----------
+
Dependencies:
* Erlang R13A or later -
@@ -25,8 +28,15 @@ directly with the running server. Next, point your browser to:
http://localhost:8001/
-If all is well you will see "Hello, World!" Now you can get busy. See the FAQ
-and API files located in doc/.
+If all is well you will see "Hello, World!" Now you can get busy.
+
+
+Documentation
+-------------
+
+See the FAQ and API files located at
+
+ http://www.chicagoboss.org/
If you need help getting started, check out "An Evening With Chicago Boss":
View
98 doc/api-config.html
@@ -0,0 +1,98 @@
+<html>
+ <head>
+ <title>Chicago Boss - the MVC that packs a punch (chicagoboss.org)</title>
+ <link rel="stylesheet" type="text/css" href="boss.css" />
+
+ <style type="text/css">
+ </style>
+
+ </head>
+ <body>
+
+ <div class="equation">
+ <span style="background-color: #B80009;">Rails Idioms</span> +
+ <span style="background-color: #004B00;">Django Templates</span> +
+ <span style="background-color: #0D0075;">Erlang Power</span> =
+ <em>Chicago</em> <strong>BOSS</strong>
+ </div>
+
+ <div class="nav">
+
+<a href="index.html">F.A.Q.</a> &nbsp; | &nbsp;
+<a href="compare.html">COMPARE</a> &nbsp; | &nbsp;
+<a href="guide.html">GUIDES</a> &nbsp; | &nbsp;
+<strong>API</strong> &nbsp; | &nbsp;
+<a href="download.html">DOWNLOAD</a> &nbsp; | &nbsp;
+<a href="forum.html">COMMUNITY</a>
+
+ </div>
+ <div style="position: relative;">
+ <div class="content">
+
+<div style="text-align: center; font-style: italic;">
+<p>The Chicago Boss API is mostly stable, but still might change before 1.0.</p>
+</div>
+<div class="subnav">
+
+ <strong>Config</strong>
+
+ &nbsp; | &nbsp;
+
+ <a href="api-db.html">BossDB</a>
+
+ &nbsp; | &nbsp;
+
+ <a href="api-record.html">Models</a>
+
+ &nbsp; | &nbsp;
+
+ <a href="api-controller.html">Web Controllers</a>
+
+ &nbsp; | &nbsp;
+
+ <a href="api-mail-controller.html">Mail</a>
+
+ &nbsp; | &nbsp;
+
+ <a href="api-view.html">Templates</a>
+
+ &nbsp; | &nbsp;
+
+ <a href="api-test.html">Tests</a>
+
+</div>
+<div style="padding-top: 20px;">
+
+<p>All configuration takes place in <code>boss.config</code> in your project directory. Valid configuration options are:</p>
+<ul>
+ <li><code>assume_locale</code> - The presumed locale of translatable strings. Defaults to "en".</li>
+ <li><code>db_host</code> - The hostname of the database. Defaults to "localhost".</li>
+ <li><code>db_port</code> - The port of the database. Defaults to 1978.</li>
+ <li><code>db_driver</code> - The database driver to use. Valid values are:
+ <ul>
+ <li><code>boss_db_driver_tyrant</code> - Tokyo Tyrant</li>
+ <li><code>boss_db_driver_mock</code> - In-memory (non-persistent) database, useful for testing</li>
+ </ul></li>
+ <li><code>default_action</code> - The action to call if none is specified. Defaults to "index"</li>
+ <li><code>default_actions</code> - A proplist of default actions to call if none is specified, keyed by controller name.</li>
+ <li><code>front_page</code> - The {Controller, Action} pair to be used on the home page. Defaults to <code>{"hello", "world"}</code>.</li>
+ <li><code>log_dir</code> - Directory in which to keep log files. Location is relative to the project directory. Defaults to "log".</li>
+ <li><code>mail_driver</code> - The email delivery driver to use. Valid values are:
+ <ul>
+ <li><code>boss_mail_driver_smtp_direct</code> - Direct SMTP delivery (i.e. no relay is used)</li>
+ <li><code>boss_mail_driver_mock</code> - A black hole, useful for testing.</li>
+ </ul></li>
+ <li><code>port</code> - The port to run the server on. Defaults to 8001.</li>
+ <li><code>server</code> - The HTTP server to use. Valid values are:
+ <ul>
+ <li><code>mochiweb</code> - The <a href="http://code.google.com/p/mochiweb/">Mochiweb</a> Web Server</li>
+ <li><code>misultin</code> - The <a href="http://code.google.com/p/misultin/">Misultin</a> Web Server</li>
+ </ul>
+ </li>
+
+</div>
+
+ </div>
+ </div>
+ </body>
+</html>
View
6 doc/api-controller.html
@@ -34,6 +34,10 @@
</div>
<div class="subnav">
+ <a href="api-config.html">Config</a>
+
+ &nbsp; | &nbsp;
+
<a href="api-db.html">BossDB</a>
&nbsp; | &nbsp;
@@ -46,7 +50,7 @@
&nbsp; | &nbsp;
- <a href="api-mail-controller.html">Mail Controller</a>
+ <a href="api-mail-controller.html">Mail</a>
&nbsp; | &nbsp;
View
6 doc/api-db.html
@@ -34,6 +34,10 @@
</div>
<div class="subnav">
+ <a href="api-config.html">Config</a>
+
+ &nbsp; | &nbsp;
+
<strong>BossDB</strong>
&nbsp; | &nbsp;
@@ -46,7 +50,7 @@
&nbsp; | &nbsp;
- <a href="api-mail-controller.html">Mail Controller</a>
+ <a href="api-mail-controller.html">Mail</a>
&nbsp; | &nbsp;
View
6 doc/api-mail-controller.html
@@ -34,6 +34,10 @@
</div>
<div class="subnav">
+ <a href="api-config.html">Config</a>
+
+ &nbsp; | &nbsp;
+
<a href="api-db.html">BossDB</a>
&nbsp; | &nbsp;
@@ -46,7 +50,7 @@
&nbsp; | &nbsp;
- <strong>Mail Controller</strong>
+ <strong>Mail</strong>
&nbsp; | &nbsp;
View
6 doc/api-record.html
@@ -34,6 +34,10 @@
</div>
<div class="subnav">
+ <a href="api-config.html">Config</a>
+
+ &nbsp; | &nbsp;
+
<a href="api-db.html">BossDB</a>
&nbsp; | &nbsp;
@@ -46,7 +50,7 @@
&nbsp; | &nbsp;
- <a href="api-mail-controller.html">Mail Controller</a>
+ <a href="api-mail-controller.html">Mail</a>
&nbsp; | &nbsp;
View
6 doc/api-request.html
@@ -34,6 +34,10 @@
</div>
<div class="subnav">
+ <a href="api-config.html">Config</a>
+
+ &nbsp; | &nbsp;
+
<a href="api-db.html">BossDB</a>
&nbsp; | &nbsp;
@@ -46,7 +50,7 @@
&nbsp; | &nbsp;
- <a href="api-mail-controller.html">Mail Controller</a>
+ <a href="api-mail-controller.html">Mail</a>
&nbsp; | &nbsp;
View
6 doc/api-test.html
@@ -34,6 +34,10 @@
</div>
<div class="subnav">
+ <a href="api-config.html">Config</a>
+
+ &nbsp; | &nbsp;
+
<a href="api-db.html">BossDB</a>
&nbsp; | &nbsp;
@@ -46,7 +50,7 @@
&nbsp; | &nbsp;
- <a href="api-mail-controller.html">Mail Controller</a>
+ <a href="api-mail-controller.html">Mail</a>
&nbsp; | &nbsp;
View
6 doc/api-view.html
@@ -34,6 +34,10 @@
</div>
<div class="subnav">
+ <a href="api-config.html">Config</a>
+
+ &nbsp; | &nbsp;
+
<a href="api-db.html">BossDB</a>
&nbsp; | &nbsp;
@@ -46,7 +50,7 @@
&nbsp; | &nbsp;
- <a href="api-mail-controller.html">Mail Controller</a>
+ <a href="api-mail-controller.html">Mail</a>
&nbsp; | &nbsp;
View
6 doc/api.html
@@ -34,6 +34,10 @@
</div>
<div class="subnav">
+ <a href="api-config.html">Config</a>
+
+ &nbsp; | &nbsp;
+
<a href="api-db.html">BossDB</a>
&nbsp; | &nbsp;
@@ -46,7 +50,7 @@
&nbsp; | &nbsp;
- <a href="api-mail-controller.html">Mail Controller</a>
+ <a href="api-mail-controller.html">Mail</a>
&nbsp; | &nbsp;
View
29 doc_templates/api-config.html
@@ -0,0 +1,29 @@
+{% extends "api.html" %}
+{% block api_content %}
+<p>All configuration takes place in <code>boss.config</code> in your project directory. Valid configuration options are:</p>
+<ul>
+ <li><code>assume_locale</code> - The presumed locale of translatable strings. Defaults to "en".</li>
+ <li><code>db_host</code> - The hostname of the database. Defaults to "localhost".</li>
+ <li><code>db_port</code> - The port of the database. Defaults to 1978.</li>
+ <li><code>db_driver</code> - The database driver to use. Valid values are:
+ <ul>
+ <li><code>boss_db_driver_tyrant</code> - Tokyo Tyrant</li>
+ <li><code>boss_db_driver_mock</code> - In-memory (non-persistent) database, useful for testing</li>
+ </ul></li>
+ <li><code>default_action</code> - The action to call if none is specified. Defaults to "index"</li>
+ <li><code>default_actions</code> - A proplist of default actions to call if none is specified, keyed by controller name.</li>
+ <li><code>front_page</code> - The {Controller, Action} pair to be used on the home page. Defaults to <code>{"hello", "world"}</code>.</li>
+ <li><code>log_dir</code> - Directory in which to keep log files. Location is relative to the project directory. Defaults to "log".</li>
+ <li><code>mail_driver</code> - The email delivery driver to use. Valid values are:
+ <ul>
+ <li><code>boss_mail_driver_smtp_direct</code> - Direct SMTP delivery (i.e. no relay is used)</li>
+ <li><code>boss_mail_driver_mock</code> - A black hole, useful for testing.</li>
+ </ul></li>
+ <li><code>port</code> - The port to run the server on. Defaults to 8001.</li>
+ <li><code>server</code> - The HTTP server to use. Valid values are:
+ <ul>
+ <li><code>mochiweb</code> - The <a href="http://code.google.com/p/mochiweb/">Mochiweb</a> Web Server</li>
+ <li><code>misultin</code> - The <a href="http://code.google.com/p/misultin/">Misultin</a> Web Server</li>
+ </ul>
+ </li>
+{% endblock %}
View
10 doc_templates/api.html
@@ -21,6 +21,12 @@
<p>The Chicago Boss API is mostly stable, but still might change before 1.0.</p>
</div>
<div class="subnav">
+ {% ifequal this_page "api-config.html" %}
+ <strong>Config</strong>
+ {% else %}
+ <a href="api-config.html">Config</a>
+ {% endifequal %}
+ &nbsp; | &nbsp;
{% ifequal this_page "api-db.html" %}
<strong>BossDB</strong>
{% else %}
@@ -40,9 +46,9 @@
{% endifequal %}
&nbsp; | &nbsp;
{% ifequal this_page "api-mail-controller.html" %}
- <strong>Mail Controller</strong>
+ <strong>Mail</strong>
{% else %}
- <a href="api-mail-controller.html">Mail Controller</a>
+ <a href="api-mail-controller.html">Mail</a>
{% endifequal %}
&nbsp; | &nbsp;
{% ifequal this_page "api-view.html" %}
Please sign in to comment.
Something went wrong with that request. Please try again.