Changes between Version 7 and Version 8 of WebRpc

Timestamp:

Jul 19, 2007, 8:52:55 PM (17 years ago)

Author:

davea

Comment:

--

WebRpc

@@ -56 +56 @@
 == Project configuration ==
 
-Each BOINC project exports some configuration items relevant to attaching and creating accounts. This RPC is documented [ProjectConfigRpc here].
+Each BOINC project exports some configuration items relevant to attaching and creating accounts. 
+= Project configuration web RPC =
+
+Each BOINC project and account manager exports a few configuration items via a web RPC; namely, it must provide an XML document at the address
+{{{
+http://PROJECT_URL/get_project_config.php
+}}}
+
+This file is created by [MakeProject make_project], and in most cases you don't have to change it.
+
+This document has this structure:
+
+{{{
+<project_config>
+    <name>Project name</name>
+    <master_url>URL</master_url>
+    [ <local_revision>12345</local_revision> ]
+    [ <web_stopped>0|1</web_stopped> ]
+    [ <account_creation_disabled/> ]
+    [ <client_account_creation_disabled/> ]
+    [ <min_passwd_length>N</min_passwd_length> ]
+    [ <account_manager/> ]
+    [ <uses_username/> ]
+    [ <rpc_prefix>URL</rpc_prefix> ]
+    [ <error_num>N</error_num> ]
+    [
+      <platforms>
+        <platform>
+          <platform_name>i686-apple-darwin</platform_name>
+          <user_friendly_name>Mac OS X (Intel)</user_friendly_name>
+        </platform>
+        <platform>
+          <platform_name>i686-pc-linux-gnu</platform_name>
+          <user_friendly_name>Linux/x86</user_friendly_name>
+        </platform>
+        ...
+      </platforms>
+    ]
+    [
+      <system_requirements>
+        [ <p_fpops>N</p_fpops> ]
+        [ <p_iops>N</p_iops> ]
+        [ <p_membw>N</p_membw> ]
+        [ <m_nbytes>N</m_nbytes> ]
+        [ <m_swap>N</m_swap> ]
+        [ <d_free>N</d_free> ]
+        [ <bwup>N</bwup> ]
+        [ <bwdown>N</bwdown> ]
+      </system_requirements>
+    ]
+</project_config>
+}}}
+
+The elements are:
+
+ '''name'''::
+        Project name
+ '''master_url'''::
+        Master URL
+ '''local_revision'''
+        The SVN changeset number of the project's server software.
+ '''web_stopped'''
+        Nonzero if the project's database is down, so data-driven web pages turned off.
+ '''account_creation_disabled'''::
+        If present, this project is not allowing creation of new accounts
+ '''min_passwd_length'''::
+        Minimum password length (for new account creation)
+ '''account_manager'''::
+        If present, this is an account manager, not a BOINC project
+ '''uses_username'''::
+        If present, this project uses names (rather than email addresses)     as the primary account identifier
+ '''client_account_creation_disabled'''::
+        If present, new accounts can be created only via the web (not via the client software).
+ '''rpc_prefix'''::
+        Prefix to use for web RPCs, instead of the master URL.
+ '''error_num'''::
+        The project is currently down. A BOINC error number is returned.
+ '''platforms'''::
+        A list of platforms for which the project has application versions.
+ '''system_requirements'''::
+        Hardware requirements for participating in this project. If a computer doesn't meet these requirements it may not get sent any work by the project. All requirements are 'net'; e.g. the CPU requirements     are after factors like [ClientSched on-fraction, active-fraction],     and resource share have been taken into consideration. NOT IMPLEMENTED YET.
+
 
 == Create account ==