Changes between Version 18 and Version 19 of ProjectOptions


Ignore:
Timestamp:
May 28, 2007, 9:01:43 AM (14 years ago)
Author:
davea
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • ProjectOptions

    v18 v19  
    8080        Project has permanently ended.  Tell clients so user can be notified.
    8181
     82== Client control ==
     83{{{
     84[ <verify_files_on_app_start/> ]
     85[ <symstore>URL</symstore> ]
     86[ <min_core_client_version_announced> N </min_core_client_version_announced> ]
     87[ <min_core_client_upgrade_deadline> N </min_core_client_upgrade_deadline> ]
     88[ <msg_to_host/> ]
     89[ <non_cpu_intensive> 0|1 </non_cpu_intensive> ]
     90}}}
     91 '''verify_files_on_app_start'''::
     92        Before starting or restarting an app, check contents of input files and app version files by either MD5 or digital signature check. Detects user tampering with file (but doesn't really increase security, since user could also change MD5s or signatures in client state file).
     93 '''symstore'''::
     94        URL of your project's symbol store, used for debugging Windows applications.
     95 '''min_core_client_version_announced'''::
     96        Announce a new version of the BOINC core client, which in the future will be the minimum required version. In conjunction with the next tag, you can warn users with version below this to upgrade by a specified deadline. Example value: 419.
     97 '''min_core_client_upgrade_deadline'''::
     98        Use in conjunction with the previous tag. The value given here is the Unix epoch returned by time(2) until which hosts can update their core client. After this time, they may be shut out of the project. Before this time, they will receive messages warning them to upgrade.
     99 '''msg_to_host'''::
     100        If present, check the msg_to_host table on each RPC, and send the client any messages queued for it.
     101 '''non_cpu_intensive'''::
     102        If this flag is present, the project will be treated specially by the client:
     103
     104 * The client will download one result at a time.
     105 * This result will be executed whenever computation is enabled (bypassing the normal scheduling mechanism).
     106
     107This is intended for [NonCpuIntensive applications that use little CPU time], e.g. that do network or host measurements.
     108
     109== Server logging ==
     110{{{
     111[ <sched_debug_level> N </sched_debug_level> ]
     112[ <fuh_debug_level> N </fuh_debug_level> ]
     113}}}
     114 '''sched_debug_level'''::
     115        Verbosity level for scheduler log output. 1=minimal, 2=normal (default), 3=verbose.
     116 '''fuh_debug_level'''::
     117        Verbosity level for file upload handler log output. 1=minimal, 2=normal (default), 3=verbose.
     118
     119== Credit ==
     120(See also the command-line options of the [ValidationIntro validator]).
     121{{{
     122[ <fp_benchmark_weight> X </fp_benchmark_weight> ]
     123}}}
     124 '''fp_benchmark_weight'''::
     125        The weighting given to the Whetstone benchmark in the calculation of claimed credit. Must be in [0 .. 1]. Projects whose applications are floating-point intensive should use 1; pure integer applications, 0. Choosing an appropriate value will reduce the disparity in claimed credit between hosts. The script html/ops/credit_study.php, run against the database of a running project, will suggest what value to use.
     126
     127== File deletion policy ==
     128{{{
     129[ <delete_delay_hours>X</delete_delay_hours> ]
     130}}}
     131 '''delete_delay_hours'''::
     132 Wait X hours before deleting files.
     133 This provides a 'grace period' during which late results will still get credit.
     134
     135== Server status page options ==
     136{{{
     137[ <www_host>hostname</www_host> ]
     138[ <sched_host>hostname</sched_host> ]
     139[ <sched_pid>path</sched_pid> ]
     140[ <uldl_host>hostname</uldl_host> ]
     141[ <uldl_pid>path</uldl_pid> ]
     142[ <ssh_exe>path</ssh_exe> ]
     143[ <ps_exe>path</ps_exe> ]
     144}}}
     145 '''www_host'''::       Host name of web server
     146 '''sched_host'''::     Host name of scheduling server
     147 '''sched_pid'''::      pid file of scheduling server (default: `/etc/httpd/run/httpd.pid`)
     148 '''uldl_host'''::      Host name of upload/download server
     149 '''uldl_pid'''::       pid file of upload/download server (default: `/etc/httpd/run/httpd.pid`)
     150 '''ssh_exe'''::        path to `ssh` (default: `/usr/bin/ssh`)
     151 '''ps_exe'''::         path to `ps` (which supports "w" flag) (default: `/bin/ps`)
     152
     153
     154== Web site features ==
     155{{{
     156[ <profile_screening/> ]
     157[ <show_results/> ]
     158[ <no_forum_rating/> ]
     159[ <akismet_key> 1234567890ab </akismet_key> ]
     160}}}
     161 '''profile_screening'''::
     162        If present, don't show profile pictures until they've been screened and approved by project admins.
     163 '''show_results'''::
     164        Enable web site features that show results (per user, host, etc.)
     165 '''no_forum_rating'''::
     166        Disable forum post rating.
     167 '''akismet_key'''::
     168        If set, akismet.com is used to check post contents to protect forums from spam. See [ProtectionFromSpam Protecting message boards from spam] for more information.
     169
     170== Miscellaneous ==
     171{{{
     172[ <disable_account_creation/> ]
     173[ <min_passwd_length> N </min_passwd_length> ]
     174}}}
     175 '''disable_account_creation'''::
     176        If present, disallow account creation
     177 '''min_passwd_length'''::
     178        Minimum length of user passwords. Default is 6.
     179
     180
    82181== Hosts, directories, and URLs ==
    83182
     
    135234        Enables scheduler locking (recommended) and specifies directory where scheduler lockfiles are stored. Must be writable to the Apache user.
    136235
    137 == Web site features ==
    138 {{{
    139 [ <profile_screening/> ]
    140 [ <show_results/> ]
    141 [ <no_forum_rating/> ]
    142 [ <akismet_key> 1234567890ab </akismet_key> ]
    143 }}}
    144  '''profile_screening'''::
    145         If present, don't show profile pictures until they've been screened and approved by project admins.
    146  '''show_results'''::
    147         Enable web site features that show results (per user, host, etc.)
    148  '''no_forum_rating'''::
    149         Disable forum post rating.
    150  '''akismet_key'''::
    151         If set, akismet.com is used to check post contents to protect forums from spam. See [ProtectionFromSpam Protecting message boards from spam] for more information.
    152 
    153 == Miscellaneous ==
    154 {{{
    155 [ <disable_account_creation/> ]
    156 [ <min_passwd_length> N </min_passwd_length> ]
    157 }}}
    158  '''disable_account_creation'''::
    159         If present, disallow account creation
    160  '''min_passwd_length'''::
    161         Minimum length of user passwords. Default is 6.
    162 
    163 == Client control ==
    164 {{{
    165 [ <verify_files_on_app_start/> ]
    166 [ <symstore>URL</symstore> ]
    167 [ <min_core_client_version_announced> N </min_core_client_version_announced> ]
    168 [ <min_core_client_upgrade_deadline> N </min_core_client_upgrade_deadline> ]
    169 [ <msg_to_host/> ]
    170 [ <non_cpu_intensive> 0|1 </non_cpu_intensive> ]
    171 }}}
    172  '''verify_files_on_app_start'''::
    173         Before starting or restarting an app, check contents of input files and app version files by either MD5 or digital signature check. Detects user tampering with file (but doesn't really increase security, since user could also change MD5s or signatures in client state file).
    174  '''symstore'''::
    175         URL of your project's symbol store, used for debugging Windows applications.
    176  '''min_core_client_version_announced'''::
    177         Announce a new version of the BOINC core client, which in the future will be the minimum required version. In conjunction with the next tag, you can warn users with version below this to upgrade by a specified deadline. Example value: 419.
    178  '''min_core_client_upgrade_deadline'''::
    179         Use in conjunction with the previous tag. The value given here is the Unix epoch returned by time(2) until which hosts can update their core client. After this time, they may be shut out of the project. Before this time, they will receive messages warning them to upgrade.
    180  '''msg_to_host'''::
    181         If present, check the msg_to_host table on each RPC, and send the client any messages queued for it.
    182  '''non_cpu_intensive'''::
    183         If this flag is present, the project will be treated specially by the client:
    184 
    185  * The client will download one result at a time.
    186  * This result will be executed whenever computation is enabled (bypassing the normal scheduling mechanism).
    187 
    188 This is intended for [NonCpuIntensive applications that use little CPU time], e.g. that do network or host measurements.
    189 
    190 == Server logging ==
    191 {{{
    192 [ <sched_debug_level> N </sched_debug_level> ]
    193 [ <fuh_debug_level> N </fuh_debug_level> ]
    194 }}}
    195  '''sched_debug_level'''::
    196         Verbosity level for scheduler log output. 1=minimal, 2=normal (default), 3=verbose.
    197  '''fuh_debug_level'''::
    198         Verbosity level for file upload handler log output. 1=minimal, 2=normal (default), 3=verbose.
    199 
    200 == Credit ==
    201 (See also the command-line options of the [ValidationIntro validator]).
    202 {{{
    203 [ <fp_benchmark_weight> X </fp_benchmark_weight> ]
    204 }}}
    205  '''fp_benchmark_weight'''::
    206         The weighting given to the Whetstone benchmark in the calculation of claimed credit. Must be in [0 .. 1]. Projects whose applications are floating-point intensive should use 1; pure integer applications, 0. Choosing an appropriate value will reduce the disparity in claimed credit between hosts. The script html/ops/credit_study.php, run against the database of a running project, will suggest what value to use.
    207 
    208 
    209 
    210 == File deletion policy ==
    211 {{{
    212 [ <delete_delay_hours>X</delete_delay_hours> ]
    213 }}}
    214  '''delete_delay_hours'''::
    215  Wait X hours before deleting files.
    216  This provides a 'grace period' during which late results will still get credit.
    217 
    218 == Server status page options ==
    219 {{{
    220 [ <www_host>hostname</www_host> ]
    221 [ <sched_host>hostname</sched_host> ]
    222 [ <sched_pid>path</sched_pid> ]
    223 [ <uldl_host>hostname</uldl_host> ]
    224 [ <uldl_pid>path</uldl_pid> ]
    225 [ <ssh_exe>path</ssh_exe> ]
    226 [ <ps_exe>path</ps_exe> ]
    227 }}}
    228  '''www_host'''::       Host name of web server
    229  '''sched_host'''::     Host name of scheduling server
    230  '''sched_pid'''::      pid file of scheduling server (default: `/etc/httpd/run/httpd.pid`)
    231  '''uldl_host'''::      Host name of upload/download server
    232  '''uldl_pid'''::       pid file of upload/download server (default: `/etc/httpd/run/httpd.pid`)
    233  '''ssh_exe'''::        path to `ssh` (default: `/usr/bin/ssh`)
    234  '''ps_exe'''::         path to `ps` (which supports "w" flag) (default: `/bin/ps`)
    235 
    236236= Parsing project options =
    237237