Fix json schemas.
[slapos.git] / software / boinc / README.txt
1 BOINC Server
2 ============
3
4 Introduction
5 ------------
6
7 The Berkeley Open Infrastructure for Network Computing (BOINC) is an open 
8 source middleware system for volunteer and grid computing.
9 http://boinc.berkeley.edu/trac/wiki/ProjectMain
10
11 This Software Release is used to deploy an instance of BOINC server on SlapOS
12
13 How it work?
14 ------------
15
16 The following example show how to request an instance of BOINC server.
17
18 BOINC Server Parameters :
19
20 - project: The name of your project. Default is project=boinc_test
21 - full-name: Full name of your project. Default is full-name=Boinc Project SAMPLE
22 - domain: Use this parameter if you want to define by hand the url of your project.
23 Ex: domain = http://myboinc.host-dommain.com
24 - copyright-holder: The name of your compagny. It will be displayed at the footer of
25 your BOINC project website.
26
27 Job Submission Parameters:
28
29 - default-template-result (Default is ${boinc-default:template-result}): Set the
30 default Output Template to use when creating a BOINC work unit.
31 - default-template-wu (Default is ${boinc-default:template-wu}): Set the
32 default Input Template to use when creating a BOINC work unit.
33 - default-extension (Default is ${boinc-default:extension}): For example in windows if 
34 job executable is an .exe, set default-extension=exe
35 - default-platform (Default is ${boinc-default:platform}): Set the default platform
36 for job submission. http://boinc.berkeley.edu/trac/wiki/BoincPlatforms
37 - boinc-app-list: Use this json parameter to submit your job list to BOINC Server.
38 For exemple: 
39
40 boinc-app-list = {"APP_NAME":
41                         {"APP_VERSION":
42                             {"use_default":true, "binary":"PATH/URL_OF_BINARY",
43                             "wu-number":NUM, "input-file":"PATH/URL_OF_INPUT_FILE"},
44                         "APP_VERSION2":
45                             {"use_default":false, "binary":"PATH/URL_OF_BINARY",
46                             "wu-number":NUM, "input-file":"PATH/URL_OF_INPUT_FILE",
47                             "extension":"", "platform":"x86_64-pc-linux-gnu",
48                             "template-result":"PATH/URL_OF_OUTPUT_TEMPLATE",
49                             "template-wu":"PATH/URL_OF_INPUT_TEMPLATE"}
50                   }, ...}
51
52 APP_NAME example: upper_case (without space)
53 APP_VERSION examples: 1.00, 2.10, 1.10
54
55 Request your instance:
56
57 This is a minimal parameter to use:
58 <?xml version="1.0" encoding="utf-8"?>
59 <instance>
60   <parameter id="project">Sample</parameter>
61   <parameter id="full-name">My BOINC project Sample</parameter>
62   <parameter id="copyright-holder">my.compagny.com</parameter>
63   <parameter id="boinc-app-list">JSON-JOB-LIST</parameter>
64 </instance>
65
66 Note: - You can update boinc-app-list anytime, this would allow you to update the 
67 nomber of work unit, or to modify files. For any job modification, APP_NAME and 
68 APP_VERSION is required.
69 - To create another BOINC project, please request another instance on SlapOS.
70
71 Warning: Once your project has been started (and BOINC client is connected on current
72 server), don't change the project name, otherwise this would cause the lost of current project.
73
74
75
76 Connect to your instance
77 ------------------------
78
79 When your instance is ready, SlapOS must provide 3 URL:
80 boinc_home_page  URL_BASE/PROJECT/  (public web page, BOINC Client will use this URL 
81 to connect to your server)
82 boinc_admin_page        URL_BASE/PROJECT_ops/ (administrative web page)
83 boinc_result_url URL_BASE/PROJECT_result/ (result web page, this page will allow
84 you to show job result)
85