Project XML Document

From Unofficial BOINC Wiki

Jump to: navigation, search

[edit] General

Each BOINC Powered Project and Account Manager must provide an XML document at the address:

http://PROJECT_URL.get_project_config.php

The purpose of this document is to present to the Participant, through the BOINC Client Software, a simplified method of Account Creation with one or more BOINC Powered Projects. This particular document is used to encapsulate the information relative to the Project for access by the BOINC Client Software. For additional details see Account Management Systems .

This document should not be confused with the Project Configuration File which contains the internal project configuration information.

This document has the structure:

<project_config>
   <name>Project name</name>
   [ <min_passwd_length>N</min_passwd_length> ]
   [ <account_manager/> ]
   [ <uses_username/> ]
   [ <account_creation_disabled/> ]
   [ <client_account_creation_disabled/> ]
   [ <error_num>N</error_num> ]
</project_config>

The elements are:

name Project name
account_manager If present, this site is an Account Manager, not a BOINC Powered Project.
uses_username If present, this project uses names/alias (rather than email addresses)

as the primary Account Identifier.

account_creation_disabled If present, this project is not allowing creation of new Accounts.
client_account_creation_disabled If present, this project doesn't allow account creation via web RPCs.

Users must visit the Project Web Site to create Accounts.

min_passwd_length Minimum password length (for new account creation).
error_num The project is currently down. An Error Code is returned.


The normal BOINC Source Code Distribution includes a file html/user/sample_get_project_config.php that supplies reasonable default values for most BOINC Powered Projects. To use this, rename it to get_project_config.php


[edit] UCB Source

[edit] Copyright ©

  • 2005 University of California
  • 2005 Paul D. Buck

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation.

Personal tools