Browse files

update documentation

  • Loading branch information...
1 parent b8e409b commit 4d21531959154c444f80501ad3f86e78eef9dddc @gnufied committed Oct 14, 2008
Showing with 53 additions and 2 deletions.
  1. +1 −0 .gitignore
  2. +5 −1 doc/content/content.txt
  3. +41 −0 doc/content/faq/faq.txt
  4. +5 −0 doc/content/faq/faq.yaml
  5. +1 −1 doc/layouts/default/default.erb
@@ -7,6 +7,7 @@ doc/output/manual
@@ -55,7 +55,11 @@ Above Command does following things :
*(content_list) Creates a config file @backgroundrb.yml@ in config directory of your rails application.
* Creates @RAILS_ROOT/lib/workers@ directory for keeping BackgrounDRb workers in one place.
* Creates @RAILS_ROOT/test/bdrb_test_helper.rb@ as a test helper for your workers
-* Creates table required for use as persistent job queue.
+* Creates migration required for creating persistent job queue table.
+After above make sure, that generated migration is ran using:
+<pre class="boxed">rake db:migrate </pre>
p(sub-title). Configuration Options
@@ -0,0 +1,41 @@
+<div id="content">
+%(entry-title)<a name="faq"> Frequently asked Questions </a>%
+*(content_list) *How does it work with ActiveRecord in multi-threaded environment?*<br/>
+You can use _BackgrounDRb_'s inbuilt thread pool for executing tasks
+concurrently. We are using @allow_concurrency = true@ for @ActiveRecord@
+models, which is known to create problem with Oracle database adapters, if
+you are using Oracle db, you can turn it off, by removing @allow_concurrency = true@.
+* *Whats the deal with persistent job queues?*<br />
+Well, its used for persisting tasks to the table, so as later
+then can be inspected for status and results. Before using this feature.You should
+run @rake backgroundrb:setup@ and run @rake db:migrate@ for creation of required
+* *My worker dies silently*<br />
+First,make sure you have logging enabled (Meaning, you are not using @:debug_log false@
+in your config file).Second, if a worker dies, the backtrace should be written to the
+file @RAILS_ROOT/log/backgroundrb_debug_xxxx.log@. Third, You should not pass
+entire @ActiveRecord@ model's around, this could cause hard to debug problems.AR objects
+don't serialize well across tcp sockets. If none of this helps, hit us on the mailing list.
+* *Master server died silently*<br/>
+If _BackgrounDRb_ master server dies, its definetely a bug in _BackgrounDRb_, exception
+should be still logged in same @RAILS_ROOT/log/backgroundrb_debug_xxxx.log@ file. Copy
+the exception and file a bug report.
+* *Where do I file bug reports?* <br />
+You can submit bug reports at: "":
+* *Result caching is not working properly* <br />
+Switch to memcache for storing results. More information "here:"http://localhost:3000/workers/#result_caching.
+* *Dynamically started workers through @new_worker@ are not working* <br />
+Use, the worker key that was used for accessing dynamically started workers.
+* *BackgrounDRb server is not starting*<br />
+Make sure, you have latest version of chronic and packet gems installed.After
+that, clone the git repository (or download a snapshot from github) and run
+@rake backgroundrb:setup@. If you are upgrading make sure, that older
+autogenerated scripts namely, @load_worker_env.rb@ and @backgroundrb@
+are removed from script directory of your rails application before running
+rake task.If you are upgrading to 1.1, check if @scheduled_at@ column
+is there in @bdrb_job_queues@ table.
@@ -0,0 +1,5 @@
+# Built-in
+filters_pre: [ "redcloth" ]
+# Custom
+title: "FAQs"
+sidebar_items: [["Trac", "#trac"], ["KnownBugs", "#known_bugs"]]
@@ -22,7 +22,7 @@
<li><a href="/advanced/"> Advanced </a></li>
<li><a href="/manual/index.html"> Manual </a></li>
<li><a href="/community/"> Community </a></li>
- <li><a href="/bugs/"> Bugs </a></li>
+ <li><a href="/faq"> FAQs </a></li>

0 comments on commit 4d21531

Please sign in to comment.