2003-08-08 17:59:10 +00:00
|
|
|
<title>Operational tools: applications and versions</title>
|
2002-08-20 23:54:17 +00:00
|
|
|
<body bgcolor=ffffff>
|
2003-08-08 17:59:10 +00:00
|
|
|
<h2>Operational tools: applications and versions</h2>
|
2002-05-24 04:29:10 +00:00
|
|
|
<p>
|
2003-08-08 17:59:10 +00:00
|
|
|
BOINC provides a few tools for creating and operating projects:
|
2002-05-24 04:29:10 +00:00
|
|
|
<ul>
|
2002-08-19 18:43:10 +00:00
|
|
|
<li>
|
|
|
|
Utility programs (such as <b>add</b> and <b>create_work</b>).
|
2003-08-08 17:59:10 +00:00
|
|
|
These can be run manually or invoked from scripts.
|
2002-08-19 18:43:10 +00:00
|
|
|
<li>
|
2003-08-08 17:59:10 +00:00
|
|
|
C++ functions (such as <b>create_work()</b>).
|
2002-08-19 18:43:10 +00:00
|
|
|
<li>
|
2003-08-08 17:59:10 +00:00
|
|
|
Web interfaces (currently these provide only read access).
|
2002-05-24 04:29:10 +00:00
|
|
|
</ul>
|
2002-07-29 19:01:38 +00:00
|
|
|
Projects can create their own tools, either at a low level (e.g.
|
|
|
|
directly accessing the BOINC DB from PHP or Perl scripts) or by using
|
2002-08-20 23:54:17 +00:00
|
|
|
the BOINC DB C++ API (db/db.h).
|
|
|
|
|
2003-08-08 17:59:10 +00:00
|
|
|
<h3>The Add utility program</h3>
|
2002-05-24 04:29:10 +00:00
|
|
|
<p>
|
2003-08-08 17:59:10 +00:00
|
|
|
The program <b>add</b> performs various types of initialization:
|
2002-05-24 04:29:10 +00:00
|
|
|
<dl>
|
2002-08-19 18:43:10 +00:00
|
|
|
<dt>
|
|
|
|
add app -app_name name
|
|
|
|
</dt>
|
|
|
|
<dd>
|
|
|
|
Create a new application (just creates a DB record).
|
|
|
|
<dt>
|
|
|
|
add platform name -platform_name name
|
|
|
|
<dd>
|
|
|
|
Create a platform record (just creates a DB record);
|
|
|
|
<dt>
|
|
|
|
add app_version
|
|
|
|
<dd>
|
|
|
|
-app_name x
|
|
|
|
<dd>
|
|
|
|
-platform_name y
|
|
|
|
<dd>
|
|
|
|
-version a
|
|
|
|
<dd>
|
|
|
|
-download_dir d
|
|
|
|
<dd>
|
2003-08-08 22:30:24 +00:00
|
|
|
-download_url e
|
2002-08-19 18:43:10 +00:00
|
|
|
<dd>
|
|
|
|
-exec_dir b
|
|
|
|
<dd>
|
|
|
|
[ -message x ]
|
|
|
|
<dd>
|
|
|
|
[ -message_priority y ]
|
|
|
|
<dd>
|
|
|
|
[ -code_sign_keyfile x -exec_files file1 file2 ... ]
|
|
|
|
<dd>
|
|
|
|
[ -signed_exec_files file1 sign1 file2 sign2 ... ]
|
|
|
|
<dd>
|
|
|
|
<br>
|
|
|
|
Create an app_version record.
|
|
|
|
Copy the executable file(s) from
|
|
|
|
the compilation directory (-exec_dir) to the download directory.
|
|
|
|
If -exec_files is used, each executable file is signed using the given
|
|
|
|
private key; this should be used only for test/debug purposes.
|
|
|
|
If -signed_exec_files is used, the signatures are passed explicitly; this
|
2002-07-29 19:01:38 +00:00
|
|
|
should be used for production purposes, where the signatures are
|
2002-08-19 18:43:10 +00:00
|
|
|
generated on an offline computer.
|
|
|
|
If -message is used, the version is
|
2002-07-29 19:01:38 +00:00
|
|
|
tagged with the given message and optional priority.
|
2002-08-19 18:43:10 +00:00
|
|
|
<dt>
|
|
|
|
add user -email_addr x -name y -web_password z -authenticator a
|
|
|
|
<dd>
|
|
|
|
Create a user record.
|
|
|
|
<dt>
|
|
|
|
add prefs -email_addr x -prefs_file y
|
|
|
|
<dd>
|
|
|
|
Create a preference set, and make it the default preferences for
|
2002-07-29 19:01:38 +00:00
|
|
|
the given user.
|
2002-05-24 04:29:10 +00:00
|
|
|
</dl>
|
2002-08-19 18:43:10 +00:00
|
|
|
|
2003-08-08 17:59:10 +00:00
|
|
|
Common options:
|
|
|
|
<dl>
|
|
|
|
<dd>
|
|
|
|
-db_name name
|
|
|
|
<dd>
|
|
|
|
-db_passwd password
|
2003-08-08 22:30:24 +00:00
|
|
|
</dl>
|
2003-08-08 17:59:10 +00:00
|
|
|
|
|
|
|
<h3>Web Interfaces</h3>
|
2002-05-24 04:29:10 +00:00
|
|
|
<p>
|
2002-08-19 18:43:10 +00:00
|
|
|
The file <b>show_db.php</b> in the operational web site directory
|
2003-08-08 17:59:10 +00:00
|
|
|
displays the contents of the BOINC DB.
|