PageRenderTime 53ms CodeModel.GetById 22ms RepoModel.GetById 0ms app.codeStats 0ms

/askbot-0.7.40/askbot/doc/build/html/management-commands.html

#
HTML | 305 lines | 295 code | 10 blank | 0 comment | 0 complexity | 01e19ac0e492a0d6b3ced8d5cbfa5cea MD5 | raw file
Possible License(s): GPL-3.0 
    

  1. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    3. 

  3.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    4. 

  4. 

  5. <html xmlns="http://www.w3.org/1999/xhtml">
    6. 

  6.   <head>
    7. 

  7.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    8. 

  8.     
    9. 

  9.     <title>Askbot management commands &mdash; Askbot v0.7.36 documentation</title>
    10. 

  10.     <link rel="stylesheet" href="_static/traditional.css" type="text/css" />
    11. 

  11.     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    12. 

  12.     <script type="text/javascript">
    13. 

  13.       var DOCUMENTATION_OPTIONS = {
    14. 

  14.         URL_ROOT:    '',
    15. 

  15.         VERSION:     '0.7.36',
    16. 

  16.         COLLAPSE_INDEX: false,
    17. 

  17.         FILE_SUFFIX: '.html',
    18. 

  18.         HAS_SOURCE:  true
    19. 

  19.       };
    20. 

  20.     </script>
    21. 

  21.     <script type="text/javascript" src="_static/jquery.js"></script>
    22. 

  22.     <script type="text/javascript" src="_static/underscore.js"></script>
    23. 

  23.     <script type="text/javascript" src="_static/doctools.js"></script>
    24. 

  24.     <link rel="author" title="About these documents" href="about.html" />
    25. 

  25.     <link rel="top" title="Askbot v0.7.36 documentation" href="index.html" />
    26. 

  26.     <link rel="next" title="Sending email to askbot" href="sending-email-to-askbot.html" />
    27. 

  27.     <link rel="prev" title="Import other forums into Askbot" href="import-data.html" /> 
    28. 

  28.   </head>
    29. 

  29.   <body>
    30. 

  30. <div class="logo">
    31. 

  31.   <a href="/doc/index.html"><h1>Askbot Project Documentation</h1></a>
    32. 

  32.   <div class="topnav">
    33. 

  33.     <a href="http://twitter.com/askbot7" alt="Follow us on twitter"><img src="_static/twitter.png"/></a>
    34. 

  34.     <a href="https://www.facebook.com/pages/Askbot/128297183877495" alt="like us on Facebook"><img src="_static/facebook.png"/></a>
    35. 

  35.   </div>
    36. 

  36. </div>
    37. 

  37. <div class="ab-proj-header">
    38. 

  38.         <a href="/">Home</a> | 
    39. 

  39.         <a href="/en/questions/" title="Ask Questions">Ask Questions</a> | 
    40. 

  40.         <a href="/hire-us" alt='Hire Us'>Hire Us</a> |
    41. 

  41.         <a href="/doc/index.html" alt="Documentation">Documentation</a> | 
    42. 

  42.         <a href="/contribute" alt='Contribute'>Contribute</a> | 
    43. 

  43.         <a href="/feedback/" alt='contact'>Contact</a>
    44. 

  44. </div>
    45. 

  45.   
    46. 

  46. 

  47.     <div class="document">
    48. 

  48.       <div class="documentwrapper">
    49. 

  49.         <div class="bodywrapper">
    50. 

  50.           <div class="body">
    51. 

  51.             
    52. 

  52.   <div class="section" id="askbot-management-commands">
    53. 

  53. <h1>Askbot management commands<a class="headerlink" href="#askbot-management-commands" title="Permalink to this headline">ś</a></h1>
    54. 

  54. <p>There are a number of command line utilities help the forum administrator
    55. 

  55. perform a range of tasks such as add or revoke administration privileges, back up and restore
    56. 

  56. the forum data, fix database errors if such occur, etc.</p>
    57. 

  57. <p>To run these commands there is a general pattern:</p>
    58. 

  58. <div class="highlight-python"><pre>cd project_directory
    59. 

  59. python manage.py some_command [possible arguments and parameters]</pre>
    60. 

  60. </div>
    61. 

  61. <p>I.e. the commands are generally run from the project directory (the same
    62. 

  62. one that contains your settings.py file) and they may use additional parameters and options.</p>
    63. 

  63. <div class="section" id="data-and-user-administration-commands">
    64. 

  64. <h2>Data and User administration commands<a class="headerlink" href="#data-and-user-administration-commands" title="Permalink to this headline">ś</a></h2>
    65. 

  65. <p>The bulk of the management commands fall into this group and will probably be the most frequently used.</p>
    66. 

  66. <table border="1" class="docutils">
    67. 

  67. <colgroup>
    68. 

  68. <col width="35%" />
    69. 

  69. <col width="65%" />
    70. 

  70. </colgroup>
    71. 

  71. <thead valign="bottom">
    72. 

  72. <tr><th class="head">command</th>
    73. 

  73. <th class="head">purpose</th>
    74. 

  74. </tr>
    75. 

  75. </thead>
    76. 

  76. <tbody valign="top">
    77. 

  77. <tr><td><cite>add_admin &lt;user_id&gt;</cite></td>
    78. 

  78. <td>Turn user into an administrator
    79. 

  79. <cite>&lt;user_id&gt;</cite> is a numeric user id of the account</td>
    80. 

  80. </tr>
    81. 

  81. <tr><td><cite>remove_admin &lt;user_id&gt;</cite></td>
    82. 

  82. <td>Remove admin status from a user account - the opposite of
    83. 

  83. the <cite>add_admin</cite> command</td>
    84. 

  84. </tr>
    85. 

  85. <tr><td><cite>add_askbot_user &#8211;user-name
    86. 

  86. &#8211;email [&#8211;password]</cite></td>
    87. 

  87. <td>Create a user account. If password is not given, an
    88. 

  88. unusable password will be set.
    89. 

  89. The command does not create associations with
    90. 

  90. any of the external login providers.</td>
    91. 

  91. </tr>
    92. 

  92. <tr><td><cite>merge_users &lt;from_id&gt;
    93. 

  93. &lt;to_id&gt;</cite></td>
    94. 

  94. <td>Merges user accounts and all related data from one user
    95. 

  95. to another, the &#8220;from user&#8221; account is deleted.</td>
    96. 

  96. </tr>
    97. 

  97. <tr><td><cite>dump_forum [&#8211;dump-name
    98. 

  98. some_name]</cite></td>
    99. 

  99. <td>Save forum contents into a file. <cite>&#8211;dump-name</cite> parameter is
    100. 

  100. optional</td>
    101. 

  101. </tr>
    102. 

  102. <tr><td><cite>get_tag_stats [-u|-t] [-e]</cite></td>
    103. 

  103. <td>Print tag subscription statistics, per tag (option -t)
    104. 

  104. or per user (option -u), if option -e is given, empty
    105. 

  105. records will be shown too (longer versions of the options
    106. 

  106. are: &#8211;per-tag-subscription-counts for -t,
    107. 

  107. &#8211;per-user-tag-subscription-counts for -u, and &#8211;print-empty
    108. 

  108. for -e).</td>
    109. 

  109. </tr>
    110. 

  110. <tr><td><cite>load_forum &lt;file_name&gt;</cite></td>
    111. 

  111. <td>Load forum data from a file saved by the <cite>dump_forum</cite>
    112. 

  112. command</td>
    113. 

  113. </tr>
    114. 

  114. <tr><td><cite>load_stackexchange &lt;file.zip&gt;</cite></td>
    115. 

  115. <td>Load SackExchange dump into Askbot. It is best to run this
    116. 

  116. command on empty database. Also - before running, make sure
    117. 

  117. that <cite>askbot.importers.stackexchange</cite> is in the list of
    118. 

  118. installed apps within your settings.py file (it might also
    119. 

  119. be necessary to run <cite>syncdb</cite> command to initiate the
    120. 

  120. SE importer tables).</td>
    121. 

  121. </tr>
    122. 

  122. <tr><td><cite>rename_tags &#8211;from &lt;from_tags&gt;
    123. 

  123. &#8211;to &lt;to_tags&gt; &#8211;user-id
    124. 

  124. &lt;user_id&gt;</cite></td>
    125. 

  125. <td>Rename, merge or split tags. User ID is the id of the user
    126. 

  126. who will be assigned as the performer of the retag action.
    127. 

  127. If more than is in the <cite>&#8211;from</cite> or the <cite>&#8211;to</cite> parameters
    128. 

  128. then that parameter quoted, e.g. <a href="#id1"><span class="problematic" id="id2">`</span></a>&#8211;to &#8220;tag1 tag2&#8221;.
    129. 

  129. If user id is not given, the administrator with the smallest
    130. 

  130. id number will be automatically assigned.</td>
    131. 

  131. </tr>
    132. 

  132. <tr><td><cite>rename_tags_id &#8211;from
    133. 

  133. &lt;from_tag_ids&gt; &#8211;to
    134. 

  134. &lt;to_tag_ids&gt; &#8211;user_id
    135. 

  135. &lt;user_id&gt;</cite></td>
    136. 

  136. <td>This command is the same as <cite>rename_tags</cite>, but takes the tag
    137. 

  137. id&#8217;s as arguments.</td>
    138. 

  138. </tr>
    139. 

  139. <tr><td><cite>delete_unused_tags</cite></td>
    140. 

  140. <td>Permanently deletes tags that do not appear in any questions
    141. 

  141. , including the questions that are themselves
    142. 

  142. marked as deleted.</td>
    143. 

  143. </tr>
    144. 

  144. <tr><td><cite>update_avatar_data</cite></td>
    145. 

  145. <td>Set values of avatar types for all users;
    146. 

  146. this command may take up to 2s per user, because it makes
    147. 

  147. up to one http request per user to gravatar.com.
    148. 

  148. This data is used to display preferentially real faces
    149. 

  149. on the main page.</td>
    150. 

  150. </tr>
    151. 

  151. </tbody>
    152. 

  152. </table>
    153. 

  153. </div>
    154. 

  154. <div class="section" id="email-related-commands">
    155. 

  155. <span id="id3"></span><h2>Email-related commands<a class="headerlink" href="#email-related-commands" title="Permalink to this headline">ś</a></h2>
    156. 

  156. <p>These commands deal with the periodic tasks related to sending and receiving email by askbot.
    157. 

  157. A UNIX program called <cite>cron</cite> can run these commands at the specified times
    158. 

  158. (please look up futher information about <cite>cron</cite> elsewhere).</p>
    159. 

  159. <p>Any configurable options, related to these commands are accessible via &#8220;Email&#8221; section of the
    160. 

  160. <a class="reference internal" href="live-settings.html#live-settings"><em>live settings</em></a>.</p>
    161. 

  161. <table border="1" class="docutils">
    162. 

  162. <colgroup>
    163. 

  163. <col width="38%" />
    164. 

  164. <col width="62%" />
    165. 

  165. </colgroup>
    166. 

  166. <thead valign="bottom">
    167. 

  167. <tr><th class="head">command</th>
    168. 

  168. <th class="head">purpose</th>
    169. 

  169. </tr>
    170. 

  170. </thead>
    171. 

  171. <tbody valign="top">
    172. 

  172. <tr><td><cite>send_email_alerts</cite></td>
    173. 

  173. <td>Dispatches email alerts to the users according to
    174. 

  174. their subscription settings. This command does not
    175. 

  175. send instant&#8221; alerts because those are sent automatically
    176. 

  176. and do not require a separate command.
    177. 

  177. The most frequent alert setting that can be served by this
    178. 

  178. command is &#8220;daily&#8221;, therefore running <cite>send_email_alerts</cite>
    179. 

  179. more than twice a day is not necessary.</td>
    180. 

  180. </tr>
    181. 

  181. <tr><td><cite>post_emailed_questions</cite></td>
    182. 

  182. <td>(experimental feature) posts questions sent by email
    183. 

  183. to enable this feature - please follow the instructions
    184. 

  184. on <a class="reference internal" href="sending-email-to-askbot.html"><em>sending email to askbot</em></a>.
    185. 

  185. This command uses <a class="reference internal" href="live-settings.html#live-settings"><em>live settings</em></a>
    186. 

  186. &#8220;allow posting by email&#8221; and &#8220;replace spaces in tags
    187. 

  187. with dash&#8221;.</td>
    188. 

  188. </tr>
    189. 

  189. <tr><td><cite>send_unanswered_question_reminders</cite></td>
    190. 

  190. <td>Sends periodic reminders about unanswered questions.
    191. 

  191. This command may be disabled from the &#8220;email&#8221; section
    192. 

  192. of <a class="reference internal" href="live-settings.html#live-settings"><em>live settings</em></a>, as well as
    193. 

  193. an initial wait period and the recurrence delay may be set.</td>
    194. 

  194. </tr>
    195. 

  195. <tr><td><cite>send_accept_answer_reminders</cite></td>
    196. 

  196. <td>Sends periodic reminders about accepting best answers.
    197. 

  197. This command may be disabled from the &#8220;email&#8221; section
    198. 

  198. of the live settings, as well as the appropriate delay
    199. 

  199. parameters may be set.</td>
    200. 

  200. </tr>
    201. 

  201. </tbody>
    202. 

  202. </table>
    203. 

  203. </div>
    204. 

  204. <div class="section" id="data-repair-commands">
    205. 

  205. <h2>Data repair commands<a class="headerlink" href="#data-repair-commands" title="Permalink to this headline">ś</a></h2>
    206. 

  206. <p>Under certain circumstances (especially when using MySQL database with MyISAM
    207. 

  207. storage engine or when venturing to adapt the software to your needs) some
    208. 

  208. records in the database tables may become internally inconsistent.
    209. 

  209. The commands from this section will help fix those issues.</p>
    210. 

  210. <div class="admonition note">
    211. 

  211. <p class="first admonition-title">Note</p>
    212. 

  212. <p class="last">Data inconsistency in the Askbot project is considered as a critical error and as a matter of
    213. 

  213. the project policy is addressed on the day of reporting. If you discover such issue - please
    214. 

  214. report it at the forum or by email at <cite>admin&#64;askbot.org</cite></p>
    215. 

  215. </div>
    216. 

  216. <table border="1" class="docutils">
    217. 

  217. <colgroup>
    218. 

  218. <col width="34%" />
    219. 

  219. <col width="66%" />
    220. 

  220. </colgroup>
    221. 

  221. <thead valign="bottom">
    222. 

  222. <tr><th class="head">command</th>
    223. 

  223. <th class="head">purpose</th>
    224. 

  224. </tr>
    225. 

  225. </thead>
    226. 

  226. <tbody valign="top">
    227. 

  227. <tr><td><cite>add_missing_subscriptions</cite></td>
    228. 

  228. <td>adds default values of email subscription settings to users
    229. 

  229. that lack them</td>
    230. 

  230. </tr>
    231. 

  231. <tr><td><cite>fix_answer_counts</cite></td>
    232. 

  232. <td>recalculates answer counts for all questions</td>
    233. 

  233. </tr>
    234. 

  234. <tr><td><cite>fix_inbox_counts</cite></td>
    235. 

  235. <td>recalculates response counts in the user inboxes</td>
    236. 

  236. </tr>
    237. 

  237. <tr><td><cite>fix_revisionless_posts</cite></td>
    238. 

  238. <td>adds a revision record to posts that lack them</td>
    239. 

  239. </tr>
    240. 

  240. <tr><td><cite>fix_question_tags</cite></td>
    241. 

  241. <td>takes tag names from the record on the question table
    242. 

  242. and stores them in the tag table. This defect may show when
    243. 

  243. the server process is interrupted after the question was
    244. 

  244. saved, but tags were not updated, and the symptom is that
    245. 

  245. the question cannot be found via the tag search.</td>
    246. 

  246. </tr>
    247. 

  247. </tbody>
    248. 

  248. </table>
    249. 

  249. <p>The above commands are safe to run at any time, also they do not require
    250. 

  250. additional parameters. In the future all these will be replaced with just one simple command.</p>
    251. 

  251. </div>
    252. 

  252. <div class="section" id="developer-commands">
    253. 

  253. <h2>Developer commands<a class="headerlink" href="#developer-commands" title="Permalink to this headline">ś</a></h2>
    254. 

  254. <p>Besides the commands designed to help run the forum, there are several aiming to help
    255. 

  255. the developers of the Askbot project:</p>
    256. 

  256. </div>
    257. 

  257. </div>
    258. 

    259. 

    260. 

  260.           </div>
    261. 

  261.         </div>
    262. 

  262.       </div>
    263. 

  263.       <div class="sphinxsidebar">
    264. 

  264.         <div class="sphinxsidebarwrapper">
    265. 

  265.   <h3><a href="index.html">Table Of Contents</a></h3>
    266. 

  266.   <ul>
    267. 

  267. <li><a class="reference internal" href="#">Askbot management commands</a><ul>
    268. 

  268. <li><a class="reference internal" href="#data-and-user-administration-commands">Data and User administration commands</a></li>
    269. 

  269. <li><a class="reference internal" href="#email-related-commands">Email-related commands</a></li>
    270. 

  270. <li><a class="reference internal" href="#data-repair-commands">Data repair commands</a></li>
    271. 

  271. <li><a class="reference internal" href="#developer-commands">Developer commands</a></li>
    272. 

  272. </ul>
    273. 

  273. </li>
    274. 

  274. </ul>
    275. 

    276. 

  276.   <h4>Previous topic</h4>
    277. 

  277.   <p class="topless"><a href="import-data.html"
    278. 

  278.                         title="previous chapter">Import other forums into Askbot</a></p>
    279. 

  279.   <h4>Next topic</h4>
    280. 

  280.   <p class="topless"><a href="sending-email-to-askbot.html"
    281. 

  281.                         title="next chapter">Sending email to askbot</a></p>
    282. 

  282. <div id="searchbox" style="display: none">
    283. 

  283.   <h3>Quick search</h3>
    284. 

  284.     <form class="search" action="search.html" method="get">
    285. 

  285.       <input type="text" name="q" size="18" />
    286. 

  286.       <input type="submit" value="Go" />
    287. 

  287.       <input type="hidden" name="check_keywords" value="yes" />
    288. 

  288.       <input type="hidden" name="area" value="default" />
    289. 

  289.     </form>
    290. 

  290.     <p class="searchtip" style="font-size: 90%">
    291. 

  291.     Enter search terms or a module, class or function name.
    292. 

  292.     </p>
    293. 

  293. </div>
    294. 

  294. <script type="text/javascript">$('#searchbox').show(0);</script>
    295. 

  295.         </div>
    296. 

  296.       </div>
    297. 

  297.       <div class="clearer"></div>
    298. 

  298.     </div>
    299. 

    300. 

  300.     <div class="footer">
    301. 

  301.         &copy; Copyright 2011, Askbot Project.
    302. 

  302.       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
    303. 

  303.     </div>
    304. 

  304.   </body>
    305. 

  305. </html>
    306.