diff --git a/README.markdown b/README.markdown index 4925218f..48ffd31f 100644 --- a/README.markdown +++ b/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": diff --git a/doc/api-config.html b/doc/api-config.html new file mode 100644 index 00000000..c56539f4 --- /dev/null +++ b/doc/api-config.html @@ -0,0 +1,98 @@ + + + Chicago Boss - the MVC that packs a punch (chicagoboss.org) + + + + + + + +
+ Rails Idioms + + Django Templates + + Erlang Power = + Chicago BOSS +
+ +
+ +F.A.Q.   |   +COMPARE   |   +GUIDES   |   +API   |   +DOWNLOAD   |   +COMMUNITY + +
+
+
+ +
+

The Chicago Boss API is mostly stable, but still might change before 1.0.

+
+
+ + Config + +   |   + + BossDB + +   |   + + Models + +   |   + + Web Controllers + +   |   + + Mail + +   |   + + Templates + +   |   + + Tests + +
+
+ +

All configuration takes place in boss.config in your project directory. Valid configuration options are:

+
    +
  • assume_locale - The presumed locale of translatable strings. Defaults to "en".
    • +
  • db_host - The hostname of the database. Defaults to "localhost".
    • +
  • db_port - The port of the database. Defaults to 1978.
    • +
  • db_driver - The database driver to use. Valid values are: +
      +
    • boss_db_driver_tyrant - Tokyo Tyrant
      • +
    • boss_db_driver_mock - In-memory (non-persistent) database, useful for testing
      • +
    • +
  • default_action - The action to call if none is specified. Defaults to "index"
    • +
  • default_actions - A proplist of default actions to call if none is specified, keyed by controller name.
    • +
  • front_page - The {Controller, Action} pair to be used on the home page. Defaults to {"hello", "world"}.
    • +
  • log_dir - Directory in which to keep log files. Location is relative to the project directory. Defaults to "log".
    • +
  • mail_driver - The email delivery driver to use. Valid values are: +
      +
    • boss_mail_driver_smtp_direct - Direct SMTP delivery (i.e. no relay is used)
      • +
    • boss_mail_driver_mock - A black hole, useful for testing.
      • +
    • +
  • port - The port to run the server on. Defaults to 8001.
    • +
  • server - The HTTP server to use. Valid values are: + +
    • + +
+ +
+
+ + diff --git a/doc/api-controller.html b/doc/api-controller.html index 3ed773e6..50f5c21d 100644 --- a/doc/api-controller.html +++ b/doc/api-controller.html @@ -34,6 +34,10 @@
+ Config + +   |   + BossDB   |   @@ -46,7 +50,7 @@   |   - Mail Controller + Mail   |   diff --git a/doc/api-db.html b/doc/api-db.html index 410ee223..eb46f0c9 100644 --- a/doc/api-db.html +++ b/doc/api-db.html @@ -34,6 +34,10 @@
+ Config + +   |   + BossDB   |   @@ -46,7 +50,7 @@   |   - Mail Controller + Mail   |   diff --git a/doc/api-mail-controller.html b/doc/api-mail-controller.html index a0a5bdd8..49799067 100644 --- a/doc/api-mail-controller.html +++ b/doc/api-mail-controller.html @@ -34,6 +34,10 @@
+ Config + +   |   + BossDB   |   @@ -46,7 +50,7 @@   |   - Mail Controller + Mail   |   diff --git a/doc/api-record.html b/doc/api-record.html index 42538685..84fab2ff 100644 --- a/doc/api-record.html +++ b/doc/api-record.html @@ -34,6 +34,10 @@
+ Config + +   |   + BossDB   |   @@ -46,7 +50,7 @@   |   - Mail Controller + Mail   |   diff --git a/doc/api-request.html b/doc/api-request.html index 3e7d6659..9561e1f5 100644 --- a/doc/api-request.html +++ b/doc/api-request.html @@ -34,6 +34,10 @@
+ Config + +   |   + BossDB   |   @@ -46,7 +50,7 @@   |   - Mail Controller + Mail   |   diff --git a/doc/api-test.html b/doc/api-test.html index 3f7c3fb3..8218387f 100644 --- a/doc/api-test.html +++ b/doc/api-test.html @@ -34,6 +34,10 @@
+ Config + +   |   + BossDB   |   @@ -46,7 +50,7 @@   |   - Mail Controller + Mail   |   diff --git a/doc/api-view.html b/doc/api-view.html index cb18655e..b6711f41 100644 --- a/doc/api-view.html +++ b/doc/api-view.html @@ -34,6 +34,10 @@
+ Config + +   |   + BossDB   |   @@ -46,7 +50,7 @@   |   - Mail Controller + Mail   |   diff --git a/doc/api.html b/doc/api.html index 3e7d6659..9561e1f5 100644 --- a/doc/api.html +++ b/doc/api.html @@ -34,6 +34,10 @@
+ Config + +   |   + BossDB   |   @@ -46,7 +50,7 @@   |   - Mail Controller + Mail   |   diff --git a/doc_templates/api-config.html b/doc_templates/api-config.html new file mode 100644 index 00000000..40f9506c --- /dev/null +++ b/doc_templates/api-config.html @@ -0,0 +1,29 @@ +{% extends "api.html" %} +{% block api_content %} +

All configuration takes place in boss.config in your project directory. Valid configuration options are:

+
+ {% ifequal this_page "api-config.html" %} + Config + {% else %} + Config + {% endifequal %} +   |   {% ifequal this_page "api-db.html" %} BossDB {% else %} @@ -40,9 +46,9 @@ {% endifequal %}   |   {% ifequal this_page "api-mail-controller.html" %} - Mail Controller + Mail {% else %} - Mail Controller + Mail {% endifequal %}   |   {% ifequal this_page "api-view.html" %}