Fixed DNS issues with ubuntu-9.10
[people/pravin/BKO.git] / Developer.html
1 <html>
2   <head>
3   <link rel="stylesheet" type="text/css" href="BKOStylesteet.css" />
4  
5     <title>boot.kernel.org(BKO)</title>
6   </head>
7   <body>
8     <div id="logo">
9     <table border="0" width="100%" cellpadding="0" cellspacing="0">
10     <tr>
11       <td valign="middle" align="center">
12         <img src="boot.png" width="367" height="261">
13       </td>
14       <td valign="middle" align="left">
15         <span id="logotext">
16         <p>
17         boot.kernel.org(BKO) : Booting your machine over HTTP
18         </p>
19         </span>
20       </td>
21     </tr>
22     </table>
23     </div>
24     <div id="menubox">
25
26       <span id="menulink">
27         <a href="index.html">Home</a>
28       </span>
29       <span id="menulink">
30         <a href="index.html#download">Downloads</a>
31       </span>
32       <span id="menulink">
33         <a href="index.html#screenshots">Screenshots</a>
34       </span>
35       <span id="menulink">
36         <a href="index.html#howtouse">How to Use</a>
37       </span>
38       <span id="menuact">
39         Developer
40       </span>
41       <span id="menulink">
42         <a href="faq.html">FAQ</a>      
43       </span>
44       <span id="menulink">
45       <a href="Troubleshooting.html">Troubleshooting</a>
46       </span>
47       <span id="menulink">
48         <a href="index.html#contactus">Contact US</a>
49       </span>
50     </div>
51
52     <center><h1>Developer's cornor</h1></center>
53 <div>
54 <h2>How to replicate the BKO setup on your machine?</h2>
55
56 <ol>
57 <li>
58 You can get the code from following git repository.<br/> 
59 <a href="http://git.etherboot.org/?p=people/pravin/BKO.git;a=summary">git://git.etherboot.org/scm/people/pravin/BKO.git</a><br/>
60 You need to initiate submodules using following instructions before proceeding further
61 <pre>
62 git submodule init
63 git submodule update
64 </pre>
65 Or you can download and run <a href="install_help/setup.sh">setup.sh</a> which will do above for you.
66 </li>
67 <li>
68 Edit the <strong>config</strong> to suit your needs.  It can be done with any text editor
69 <pre>
70 vi BKO/configure
71 </pre>
72 Make sure that you provide proper values for atleast <strong>BASE_URL</strong> which is the http URL where BKO will be kept
73 on your machine.
74 Other entries are optional, you can leave them untouched. Please refer bellow for more details on the meaning of the configuration variables.
75 </li>
76 <li>
77 Follow the following instructions
78 <pre>
79 make
80 cd install_help
81 ./configure_BKO.sh
82 ./download_initramfs_images_http.sh
83 </pre>
84 and optionally you need to download the ISO images, or you can point to images on etherboot server or kernel.org server.
85 <pre>
86 ./download_ISO.sh
87 </pre>
88
89 </li>
90 </ol>
91 <hr/>
92 </div>
93 <a name="parameters">
94 <div>
95 <h3>Details about configuration parameters</h3>
96 <p>
97   <ol>
98     <li>
99         <strong>BASE_URL</strong>: gpxe will contact this URL for initial boot.  
100         and it must be HTTP URL and not linux path.
101     </li>
102     <li>
103         <strong>ISO_LOCATION_LOCAL</strong> : The HTTP path where all ISOs will be kept. the script <i>download_ISO.sh</i> will download them in folder
104         named <i>ISO</i> in the same location where <i>setup.sh</i> was executed. For example, if you have executed setup.sh in topmost directory (ie var/www/)
105         then BASE_URL=http://your-ip-address/BKO/ and ISO_LOCATION_LOCAL=http://your-ip-address/ISO/
106     </li>
107   </ol>
108 </p>
109 </div>
110
111 <div>
112 <h3>Details about installation help scripts</h3>
113 <p>
114   <ol>
115     <li>
116         <strong>setup.sh</strong> : It is the first script that user will need.  It clones and initiate the git repository which can be used for local 
117         deployment. 
118     </li>
119     <li>
120         <strong>configure_BKO.sh</strong> : BKO menus are presented with help from configuration files.  These configuration files <em>.conf</em>
121         also includes so deployment specific information like <em>ISO_LOCATION_LOCAL</em>.  This script genenates all these configuration 
122         files with correct information.<br/>
123         <em>Note : </em> Soon this script will be executed automatically from <em>Makefile</em>.
124     </li>
125     <li>
126         <strong>deploy_BKO.sh</strong> : This script is responsible for generation of all the initramfs files, needed by all 
127         supported distributions. This script do require <em>root privileges</em> for initramfs generation.  This script uses
128         <em>sudo</em> whenever it need root privileges, so user may have to enter the password more than once.  User can also 
129         execute entire script as root.  In case you do not have such privilages, you can use <em>download_initramfs_images_http.sh</em>
130         which will download these initramfs images from server for you.
131     </li>
132     <li>
133         <strong>download_initramfs_images_http.sh</strong> : Downloads the modified initramfs images which supports httpfs booting.
134         These initramfs images are downloaded from <em>Etherboot server</em>.  The default value for this variable
135         will be correct one, so users dont need to temper with it.
136     </li>
137     <li>
138         <strong>download_ISO.sh</strong> : BKO depends on ISO images of various distributions for its work.  This script download those
139         ISO's on your behalf. 
140     </li>
141   </ol>
142 </p>
143 </div>
144
145 <hr/>
146 </body>
147 </html>