Changes between Version 17 and Version 18 of ProjectOptions


Ignore:
Timestamp:
May 28, 2007, 8:53:59 AM (14 years ago)
Author:
davea
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • ProjectOptions

    v17 v18  
    44
    55The following elements in the `<config>` section of your [ProjectConfigFile config.xml] file control various aspects of your project.
    6 == Hosts, directories, and URLs ==
    7 
    8 (These are created by make_project; normally you don't need to change them.)
    9 {{{
    10 <master_url>            URL                   </master_url>
    11 <long_name>             name                  </long_name>
    12 <host>                  project.hostname.ip   </host>
    13 <db_name>               databasename          </db_name>
    14 <db_host>               database.host.ip      </db_host>
    15 <db_user>               database_user_name    </db_user>
    16 <db_passwd>             database_password     </db_passwd>
    17 <shmem_key>             shared_memory_key     </shmem_key>
    18 <download_url>          http://A/URL          </download_url>
    19 <download_dir>          /path/to/directory    </download_dir>
    20 <uldl_dir_fanout>       N                     </uldl_dir_fanout>
    21 <upload_url>            http://A/URL          </upload_url>
    22 <upload_dir>            /path/to/directory    </upload_dir>
    23 <cgi_url>               http://A/URL          </cgi_url>
    24 <log_dir>               /path/to/directory    </log_dir>
    25 <!-- optional; defaults as indicated: -->
    26     <bin_dir>      bin      </bin_dir>      <!-- relative to project_dir -->
    27     <cgi_bin_dir>  cgi-bin  </cgi_dir>      <!-- relative to project_dir -->
    28 [ <sched_lockfile_dir> path </sched_lockfile_dir> ]
    29 }}}
    30  '''host'''::
    31         name of project's main host, as given by Python's `socket.hostname()`. Daemons and tasks run on this host by default.
    32  '''db_name'''::
    33         Database name
    34  '''db_host'''::
    35         Database host machine
    36  '''db_user'''::
    37         Database user name
    38  '''db_passwd'''::
    39         Database password
    40  '''shmem_key'''::
    41         ID of scheduler shared memory. Must be unique on host.
    42  '''download_url'''::
    43         URL of data server for download
    44  '''download_dir'''::
    45         absolute path of download directory
    46  '''download_dir_alt'''::
    47         absolute path of old download directory (see [DirHierarchy upload/download directories])
    48  '''upload_url'''::
    49         URL of file upload handler
    50  '''uldl_dir_fanout'''::
    51         fan-out factor of upload and download directories (see [DirHierarchy Hierarchical upload/download directories])
    52  '''upload_dir'''::
    53         absolute path of upload directory
    54  '''cgi_urlv::
    55         URL of scheduling server
    56  '''log_dir'''::
    57         absolute path of logfile directory
    58  '''sched_lockfile_dir'''::
    59         Enables scheduler locking (recommended) and specifies directory where scheduler lockfiles are stored. Must be writable to the Apache user.
    60 
    61 == Web site features ==
    62 {{{
    63 [ <profile_screening/> ]
    64 [ <show_results/> ]
    65 [ <no_forum_rating/> ]
    66 [ <akismet_key> 1234567890ab </akismet_key> ]
    67 }}}
    68  '''profile_screening'''::
    69         If present, don't show profile pictures until they've been screened and approved by project admins.
    70  '''show_results'''::
    71         Enable web site features that show results (per user, host, etc.)
    72  '''no_forum_rating'''::
    73         Disable forum post rating.
    74  '''akismet_key'''::
    75         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.
    76 
    77 == Miscellaneous ==
    78 {{{
    79 [ <disable_account_creation/> ]
    80 [ <min_passwd_length> N </min_passwd_length> ]
    81 }}}
    82  '''disable_account_creation'''::
    83         If present, disallow account creation
    84  '''min_passwd_length'''::
    85         Minimum length of user passwords. Default is 6.
    86 
    87 == Client control ==
    88 {{{
    89 [ <verify_files_on_app_start/> ]
    90 [ <symstore>URL</symstore> ]
    91 [ <min_core_client_version_announced> N </min_core_client_version_announced> ]
    92 [ <min_core_client_upgrade_deadline> N </min_core_client_upgrade_deadline> ]
    93 [ <msg_to_host/> ]
    94 [ <non_cpu_intensive> 0|1 </non_cpu_intensive> ]
    95 }}}
    96  '''verify_files_on_app_start'''::
    97         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).
    98  '''symstore'''::
    99         URL of your project's symbol store, used for debugging Windows applications.
    100  '''min_core_client_version_announced'''::
    101         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.
    102  '''min_core_client_upgrade_deadline'''::
    103         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.
    104  '''msg_to_host'''::
    105         If present, check the msg_to_host table on each RPC, and send the client any messages queued for it.
    106  '''non_cpu_intensive'''::
    107         If this flag is present, the project will be treated specially by the client:
    108 
    109  * The client will download one result at a time.
    110  * This result will be executed whenever computation is enabled (bypassing the normal scheduling mechanism).
    111 
    112 This is intended for [NonCpuIntensive applications that use little CPU time], e.g. that do network or host measurements.
    113 
    114 == Server logging ==
    115 {{{
    116 [ <sched_debug_level> N </sched_debug_level> ]
    117 [ <fuh_debug_level> N </fuh_debug_level> ]
    118 }}}
    119  '''sched_debug_level'''::
    120         Verbosity level for scheduler log output. 1=minimal, 2=normal (default), 3=verbose.
    121  '''fuh_debug_level'''::
    122         Verbosity level for file upload handler log output. 1=minimal, 2=normal (default), 3=verbose.
    123 
    124 == Credit ==
    125 (See also the command-line options of the [ValidationIntro validator]).
    126 {{{
    127 [ <fp_benchmark_weight> X </fp_benchmark_weight> ]
    128 }}}
    129  '''fp_benchmark_weight'''::
    130         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.
    1316
    1327== Scheduling options and parameters ==
     
    20580        Project has permanently ended.  Tell clients so user can be notified.
    20681
     82== Hosts, directories, and URLs ==
     83
     84(These are created by make_project; normally you don't need to change them.)
     85{{{
     86<master_url>            URL                   </master_url>
     87<long_name>             name                  </long_name>
     88<host>                  project.hostname.ip   </host>
     89<db_name>               databasename          </db_name>
     90<db_host>               database.host.ip      </db_host>
     91<db_user>               database_user_name    </db_user>
     92<db_passwd>             database_password     </db_passwd>
     93<shmem_key>             shared_memory_key     </shmem_key>
     94<download_url>          http://A/URL          </download_url>
     95<download_dir>          /path/to/directory    </download_dir>
     96<uldl_dir_fanout>       N                     </uldl_dir_fanout>
     97<upload_url>            http://A/URL          </upload_url>
     98<upload_dir>            /path/to/directory    </upload_dir>
     99<cgi_url>               http://A/URL          </cgi_url>
     100<log_dir>               /path/to/directory    </log_dir>
     101<!-- optional; defaults as indicated: -->
     102    <bin_dir>      bin      </bin_dir>      <!-- relative to project_dir -->
     103    <cgi_bin_dir>  cgi-bin  </cgi_dir>      <!-- relative to project_dir -->
     104[ <sched_lockfile_dir> path </sched_lockfile_dir> ]
     105}}}
     106 '''host'''::
     107        name of project's main host, as given by Python's `socket.hostname()`. Daemons and tasks run on this host by default.
     108 '''db_name'''::
     109        Database name
     110 '''db_host'''::
     111        Database host machine
     112 '''db_user'''::
     113        Database user name
     114 '''db_passwd'''::
     115        Database password
     116 '''shmem_key'''::
     117        ID of scheduler shared memory. Must be unique on host.
     118 '''download_url'''::
     119        URL of data server for download
     120 '''download_dir'''::
     121        absolute path of download directory
     122 '''download_dir_alt'''::
     123        absolute path of old download directory (see [DirHierarchy upload/download directories])
     124 '''upload_url'''::
     125        URL of file upload handler
     126 '''uldl_dir_fanout'''::
     127        fan-out factor of upload and download directories (see [DirHierarchy Hierarchical upload/download directories])
     128 '''upload_dir'''::
     129        absolute path of upload directory
     130 '''cgi_urlv::
     131        URL of scheduling server
     132 '''log_dir'''::
     133        absolute path of logfile directory
     134 '''sched_lockfile_dir'''::
     135        Enables scheduler locking (recommended) and specifies directory where scheduler lockfiles are stored. Must be writable to the Apache user.
     136
     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
     188This 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
    207210== File deletion policy ==
    208211{{{