import repository from arizona
[raven.git] / webpage / docfiles.html
1 <html>
2 <head>
3 <title> Stork Project </title>
4 <LINK href="stork.css" rel="stylesheet" type="text/css">
5
6 </head>
7
8 <body>
9
10
11 <div class="display" align="center">
12         <table border="0">
13         <tr>
14                 <td width="170" valign="top">
15
16                                 <br/>
17                                 <table cellpadding="3" width="170" id="links" class="links">
18                                         <tr>
19                                                 <td align="right">
20
21                                                         <ul class="links">
22
23                                                                 <a href = "index.html"><h3>Stork</h3></a>
24                                                                 <li class="links"><a href="tutmain.html">Stork Tutorial</a></li>
25
26                                                                 <li class="links"><a href="advanced.html">Advanced Usage</a></li>
27                                                                 <li class="links"><a href="arch.html">Stork Architecture</a></li>
28                                                                 <li class="links"><a href="filelist.html">Stork File List</a></li>
29                                                                 <li class="links"><a href="about.html">About Us</a></li>
30                                                                 <li class="links"><a href="apps.html">Related Links</a></li>
31                                                                 <li class="links"><a href="contact.html">Contact Stork</a></li>
32                                                                 <h4>Links</h4>
33                                                                 <li class="links"><a href="http://appmanager.berkeley.intel-research.net/plcontrol/apps.php?appid=1029">
34                                                                 Slice Status</a></li>
35                                                                 <li class="links"><a href="https://stork-repository.cs.arizona.edu">Stork Repository</a></li>
36                                                         </ul>
37
38                                                  </td>
39                                         </tr>
40                                 </table>
41                                 <br/>
42                 </td>
43
44                 <td valign="top">
45                 <table class="info" cellpadding="0" width="700" >
46                 <tr  height="75"><td colspan="3"><img style="margin-left: -0px;" src="images/stork-header.png" alt="stork logo"/></td></tr>
47                 <tr  bgcolor="#444444" class="headerrow" width="100%" height="2">
48
49                         <th colspan="2"> Stork Documentation </th>
50
51                 </tr>
52                 <tr valign="top" align="left">
53
54                         <td>
55                                 <table cellpadding="8" id="content" class="content">
56                                         <tr>
57                                                 <td>
58
59                                                         <h1><a name = "top"></a>Stork Documentation: Identities, Config Files</h1>
60
61                                                         <a name="genpair"><h3>Creating an Identity</h3></a>
62                                                         <p>To start using Stork's enduser utilities, you will first need to
63                                                         create an identity. You can do this using the 'genpair' function. This
64                                                         will create a private key and a public key, which will identify you and the
65                                                         software you wish to distribute. The privatekey is used to sign the files
66                                                         that Stork uses to install your software, so be sure to keep it safe. The
67                                                         public key is distributed to all your nodes (and all others that wish to use
68                                                         your software). Note that Stork will generate an error if you attempt to use
69                                                         it before creating a pair of keys and setting it as your default identity.
70                                                         <p>To create your keys, just run the command:
71
72                                                         <br><code><b>./storkutil.py genpair USERNAME</b></code>
73                                                         <br>where USERNAME is any username you desire. The username exists
74                                                         so that users can recognize each other without having to base interaction
75                                                         solely on public and private keys. After running the genpair command,
76                                                         Stork will ask you if you want this to be your default identity; if this is
77                                                         your first time using Stork, it is best to set this key as your default. If
78                                                         you've already created keys and would like to use those, you can use the
79                                                         'storkutil.py setdefault USERNAME' command.
80
81 <p><table width=400 height=150 cellspacing=0 cellpadding=5 border=5 bordercolor="orange"><tr>
82 <td width="100%" align="left" valign="top" bgcolor="teal">
83 <span style="color: white">
84 <code><b>./storkutil.py genpair foo</b>
85 <br>Generated foo.privatekey...
86 <br>Extracted foo.publickey...
87 <br>Would you like to make 'foo' your default identity? (y/n) > <b>y</b>
88 <br>'foo' is now your default identity
89 <br>
90 <br><b>./storkutil.py genpair foo</b>
91 <br>Error: Key files for 'foo' already exist
92 </code>
93 </span></td></tr></table>
94
95 <p>or, if you have already created foo.privatekey and foo.publickey:
96
97 <p><table width=400 height=60 cellspacing=0 cellpadding=5 border=5 bordercolor="orange"><tr>
98 <td width="100%" align="left" valign="top" bgcolor="teal">
99 <span style="color: white">
100 <code><b>./storkutil.py setdefault foo</b>
101 <br>Previous Identity: someguy
102 <br>'foo' is now your default identity</code>
103 </span></td></tr></table>
104                                                         <p>Be sure that the privatekey and publickey are in your current directory
105                                                         while using storkutil. The publickey can be distributed to all your nodes
106                                                         through the <a href="https://stork-repository.cs.arizona.edu">upload website</a>.
107                                                         Also, note that your public key is embedded in your TPFile filename, such that
108                                                         the filename should be <i>*publickey*Username.tpfile</i>, without the *.
109                                                         <p><img src="blkfade.gif" width="100%"></img>
110                                                         <br>
111                                                         <a name = "config"><h3>Configuration File</h3></a>
112                                                         You will need to change the stork configuration file included in the
113                                                         Storkutil tarball to match the
114                                                         identity you created. Simply open up the file which should be named
115                                                         <i>sample-stork.conf</i> and change the 'username = ' line
116                                                         to match the username you chose for your keys. You will also need to modify the
117                                                         'publickeyfile = ' line, to match the location of your publickey. By default, this should be
118                                                         "publickeyfile = /usr/local/stork/var/keys/&lt;username&gt;.publickey", where &lt;username&gt; is the
119                                                         name you generated your keys for.
120                                                         You will need to distribute this
121                                                         configuration file to all your
122                                                         nodes through the <a href="https://stork-repository.cs.arizona.edu">upload website</a>.
123                                                         <i><p>Note!</i> The stork configuration file is different from the storkutil
124                                                         configuration file. The <code>setdefault</code> command will appropriately change
125                                                         the storkutil configuration file, but you will still need to change and distribute
126                                                         the Stork configuration file manually.
127                                                         <p><img src="blkfade.gif" width="100%"></img>
128
129
130                                                         <p>Return to the <a href="docmain.html">documentation contents.</a>
131
132                                                         <center><a href = "index.html">Home</a>     <a href = "#top">Top</a></center>
133
134
135                                                 </td>
136                                         </tr>
137                                 </table>
138                         </td>
139                 </tr>
140
141        </table>
142        </td>
143
144      </tr>
145      <tr>
146         <td></td>
147         <td>
148                 <a href="http://www.planet-lab.org"><img style="border: 0px; border-style: none;" src="images/powered_by_pl_grey.png" alt="powered by planetlab"></a>
149
150                                         <a href="http://www.cs.arizona.edu"><img style="position:relative; left: 20px; border: 0px; border-style: none;" src="images/template_logo_small_grey.png" alt="University of Arizona, Computer Science logo"></a>
151
152
153
154
155
156         </td>
157      </tr>
158
159 </table>
160
161 </div>
162
163
164 <script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
165 </script>
166 <script type="text/javascript">
167 _uacct = "UA-1868232-1";
168 urchinTracker();
169 </script>
170 </body>
171 </html>