Ticket #1227: html-doc-replacement.patch

File html-doc-replacement.patch, 57.1 KB (added by p-static, at 2010-12-04T08:36:41Z)

replace HTML docs with versions generated from rST

  • docs/about.html 

    diff --git a/docs/about.html b/docs/about.html
index ae5a38a..fb0100b 100644
    a b  
    1 <!DOCtype HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html lang="en">
    2   <head>
    3     <title>Welcome To Tahoe-LAFS</title>
    4     <link rev="made" class="mailto" href="mailto:zooko[at]zooko[dot]com">
    5     <meta name="description" content="welcome to Tahoe-LAFS">
    6     <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    7     <meta name="keywords" content="tahoe-lafs secure decentralized filesystem cloud storage">
    8   </head>
    9 
    10   <body>
    11     <h1>Welcome to Tahoe-LAFS</h1>
    12     <p>Welcome to <a href="http://tahoe-lafs.org">Tahoe-LAFS</a>, the first decentralized storage system with <cite>provider-independent security</cite>.</p>
    13 
    14     <h2>what is "provider-independent security"?</h2>
    15     <p>Every seller of cloud storage services will tell you that their service is "secure".  But what they mean by that is something fundamentally different from what we mean.  What they mean by "secure" is that after you've given them the power to read and modify your data, they try really hard not to let this power be abused.  This turns out to be difficult!  Bugs, misconfigurations, or operator error can accidentally expose your data to another customer or to the public, or can corrupt your data.  Criminals routinely gain illicit access to corporate servers.  Even more insidious is the fact that the employees themselves sometimes violate customer privacy out of carelessness, avarice, or mere curiousity.  The most conscientious of these service providers spend considerable effort and expense trying to mitigate these risks.</p>
    16     <p>What we mean by "security" is something different.  <em>The service provider never has the ability to read or modify your data in the first place -- never.</em>  If you use Tahoe-LAFS, then all of the threats described above are non-issues to you.  Not only is it easy and inexpensive for the service provider to maintain the security of your data, but in fact they couldn't violate its security if they tried.  This is what we call <em>provider-independent security</em>.</p>
    17     <p>This guarantee is integrated naturally into the Tahoe-LAFS storage system and doesn't require you to perform a manual pre-encryption step or cumbersome key management.  (After all, having to do cumbersome manual operations when storing or accessing your data would nullify one of the primary benefits of using cloud storage in the first place -- convenience.)</p>
    18     <p>Here's how it works.</p>
    19 
    20     <img src="http://tahoe-lafs.org/~zooko/network-and-reliance-topology.png"></img>
    21 
    22 <!--    <p>(See also <a href="http://testgrid.allmydata.org:3567/file/URI:CHK:4rd7ous7b5xgbmpan6mmdbx3za:2jywqfnobreondkanwnekugmxv3cyuzdv34fpyazkb5htjmokdta:3:10:102761/@@named=/network-and-reliance-topology-paranoid.png">Tahoe-LAFS for Paranoids</a> and <a href="http://testgrid.allmydata.org:3567/file/URI:CHK:mpa737uu7suao7lva2axhbtgw4:5rpemho4d3cqsgvgsqmg3hbn2mzeibsbdpthmpyo5jwnj7f2fqfa:3:10:114022/@@named=/network-and-reliance-topology-corporate.png">Tahoe-LAFS for Corporates</a>.)</p> -->
    23 
    24     <p>A "storage grid" is made up of a number of storage servers.  A storage server has direct attached storage (typically one or more hard disks).  A "gateway" uses the storage servers and provides access to the filesystem over HTTP(S) or (S)FTP.</p>
    25     <p>Users do not rely on storage servers to provide <i>confidentiality</i> nor <i>integrity</i> for their data -- instead all of the data is encrypted and integrity-checked by the gateway, so that the servers can neither read nor modify the contents of the files.</p>
    26     <p>Users do rely on storage servers for <i>availability</i>.  The ciphertext is erasure-coded and distributed across <cite>N</cite> storage servers (the default value for <cite>N</cite> is 10) so that it can be recovered from any <cite>K</cite> of these servers (the default value of <cite>K</cite> is 3).  Therefore only the simultaneous failure of <cite>N-K+1</cite> (with the defaults, 8) servers can make the data unavailable.</p>
    27     <p>In the typical deployment mode each user runs her own gateway on her own machine.  This way she relies on her own machine for the confidentiality and integrity of the data.</p>
    28     <p>An alternate deployment mode is that the gateway runs on a remote machine and the user connects to it over HTTPS or SFTP.  This means that the operator of the gateway can view and modify the user's data (the user <i>relies on</i> the gateway for confidentiality and integrity), but the advantage is that the user can access the filesystem with a client that doesn't have the gateway software installed, such as an Internet kiosk or cell phone.</p>
    29 
    30     <h2>Access control</h2>
    31     <p>There are two kinds of files: immutable and mutable.  Immutable files have the property that once they have been uploaded to the storage grid they can't be modified.  Mutable ones can be modified.  A user can have read-write access to a mutable file or read-only access to it (or no access to it at all).</p>
    32     <p>A user who has read-write access to a mutable file or directory can give another user read-write access to that file or directory, or they can give read-only access to that file or directory.  A user who has read-only access to a file or directory can give another user read-only access to it.</p>
    33     <p>When linking a file or directory into a parent directory, you can use a read-write link or a read-only link.  If you use a read-write link, then anyone who has read-write access to the parent directory can gain read-write access to the child, and anyone who has read-only access to the parent directory can gain read-only access to the child.  If you use a read-only link, then anyone who has either read-write or read-only access to the parent directory can gain read-only access to the child.</p>
    34     <p>For more technical detail, please see the <a href="http://tahoe-lafs.org/trac/tahoe-lafs/wiki/Doc">The Doc Page</a> on the Wiki.</p>
    35 
    36     <h2>Get Started</h2>
    37     <p>To use Tahoe-LAFS, please see <a href="quickstart.html">quickstart.html</a>.</p>
    38 
    39     <h2>Licence</h2>
    40     <p>You may use this package under the GNU General Public License, version 2 or, at your option, any later version.  See the file <a href="../COPYING.GPL">COPYING.GPL</a> for the terms of the GNU General Public License, version 2.</p>
    41     <p>You may use this package under the Transitive Grace Period Public Licence, version 1 or, at your option, any later version.  The Transitive Grace Period Public Licence has requirements similar to the GPL except that it allows you to wait for up to twelve months after you redistribute a derived work before releasing the source code of your derived work. See the file <a href="../COPYING.TGPPL.html">COPYING.TGPPL.html</a> for the terms of the Transitive Grace Period Public Licence, version 1.</p>
    42     <p>(You may choose to use this package under the terms of either licence, at your option.)</p>
    43 
    44   </body>
     1<?xml version="1.0" encoding="utf-8" ?>
     2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
     3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
     4<head>
     5<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     6<meta name="generator" content="Docutils 0.6: http://docutils.sourceforge.net/" />
     7<title>Welcome to Tahoe-LAFS!</title>
     8<style type="text/css">
     9
     10/*
     11:Author: David Goodger (goodger@python.org)
     12:Id: $Id: html4css1.css 5951 2009-05-18 18:03:10Z milde $
     13:Copyright: This stylesheet has been placed in the public domain.
     14
     15Default cascading style sheet for the HTML output of Docutils.
     16
     17See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
     18customize this style sheet.
     19*/
     20
     21/* used to remove borders from tables and images */
     22.borderless, table.borderless td, table.borderless th {
     23  border: 0 }
     24
     25table.borderless td, table.borderless th {
     26  /* Override padding for "table.docutils td" with "! important".
     27     The right padding separates the table cells. */
     28  padding: 0 0.5em 0 0 ! important }
     29
     30.first {
     31  /* Override more specific margin styles with "! important". */
     32  margin-top: 0 ! important }
     33
     34.last, .with-subtitle {
     35  margin-bottom: 0 ! important }
     36
     37.hidden {
     38  display: none }
     39
     40a.toc-backref {
     41  text-decoration: none ;
     42  color: black }
     43
     44blockquote.epigraph {
     45  margin: 2em 5em ; }
     46
     47dl.docutils dd {
     48  margin-bottom: 0.5em }
     49
     50/* Uncomment (and remove this text!) to get bold-faced definition list terms
     51dl.docutils dt {
     52  font-weight: bold }
     53*/
     54
     55div.abstract {
     56  margin: 2em 5em }
     57
     58div.abstract p.topic-title {
     59  font-weight: bold ;
     60  text-align: center }
     61
     62div.admonition, div.attention, div.caution, div.danger, div.error,
     63div.hint, div.important, div.note, div.tip, div.warning {
     64  margin: 2em ;
     65  border: medium outset ;
     66  padding: 1em }
     67
     68div.admonition p.admonition-title, div.hint p.admonition-title,
     69div.important p.admonition-title, div.note p.admonition-title,
     70div.tip p.admonition-title {
     71  font-weight: bold ;
     72  font-family: sans-serif }
     73
     74div.attention p.admonition-title, div.caution p.admonition-title,
     75div.danger p.admonition-title, div.error p.admonition-title,
     76div.warning p.admonition-title {
     77  color: red ;
     78  font-weight: bold ;
     79  font-family: sans-serif }
     80
     81/* Uncomment (and remove this text!) to get reduced vertical space in
     82   compound paragraphs.
     83div.compound .compound-first, div.compound .compound-middle {
     84  margin-bottom: 0.5em }
     85
     86div.compound .compound-last, div.compound .compound-middle {
     87  margin-top: 0.5em }
     88*/
     89
     90div.dedication {
     91  margin: 2em 5em ;
     92  text-align: center ;
     93  font-style: italic }
     94
     95div.dedication p.topic-title {
     96  font-weight: bold ;
     97  font-style: normal }
     98
     99div.figure {
     100  margin-left: 2em ;
     101  margin-right: 2em }
     102
     103div.footer, div.header {
     104  clear: both;
     105  font-size: smaller }
     106
     107div.line-block {
     108  display: block ;
     109  margin-top: 1em ;
     110  margin-bottom: 1em }
     111
     112div.line-block div.line-block {
     113  margin-top: 0 ;
     114  margin-bottom: 0 ;
     115  margin-left: 1.5em }
     116
     117div.sidebar {
     118  margin: 0 0 0.5em 1em ;
     119  border: medium outset ;
     120  padding: 1em ;
     121  background-color: #ffffee ;
     122  width: 40% ;
     123  float: right ;
     124  clear: right }
     125
     126div.sidebar p.rubric {
     127  font-family: sans-serif ;
     128  font-size: medium }
     129
     130div.system-messages {
     131  margin: 5em }
     132
     133div.system-messages h1 {
     134  color: red }
     135
     136div.system-message {
     137  border: medium outset ;
     138  padding: 1em }
     139
     140div.system-message p.system-message-title {
     141  color: red ;
     142  font-weight: bold }
     143
     144div.topic {
     145  margin: 2em }
     146
     147h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
     148h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
     149  margin-top: 0.4em }
     150
     151h1.title {
     152  text-align: center }
     153
     154h2.subtitle {
     155  text-align: center }
     156
     157hr.docutils {
     158  width: 75% }
     159
     160img.align-left, .figure.align-left{
     161  clear: left ;
     162  float: left ;
     163  margin-right: 1em }
     164
     165img.align-right, .figure.align-right {
     166  clear: right ;
     167  float: right ;
     168  margin-left: 1em }
     169
     170.align-left {
     171  text-align: left }
     172
     173.align-center {
     174  clear: both ;
     175  text-align: center }
     176
     177.align-right {
     178  text-align: right }
     179
     180/* reset inner alignment in figures */
     181div.align-right {
     182  text-align: left }
     183
     184/* div.align-center * { */
     185/*   text-align: left } */
     186
     187ol.simple, ul.simple {
     188  margin-bottom: 1em }
     189
     190ol.arabic {
     191  list-style: decimal }
     192
     193ol.loweralpha {
     194  list-style: lower-alpha }
     195
     196ol.upperalpha {
     197  list-style: upper-alpha }
     198
     199ol.lowerroman {
     200  list-style: lower-roman }
     201
     202ol.upperroman {
     203  list-style: upper-roman }
     204
     205p.attribution {
     206  text-align: right ;
     207  margin-left: 50% }
     208
     209p.caption {
     210  font-style: italic }
     211
     212p.credits {
     213  font-style: italic ;
     214  font-size: smaller }
     215
     216p.label {
     217  white-space: nowrap }
     218
     219p.rubric {
     220  font-weight: bold ;
     221  font-size: larger ;
     222  color: maroon ;
     223  text-align: center }
     224
     225p.sidebar-title {
     226  font-family: sans-serif ;
     227  font-weight: bold ;
     228  font-size: larger }
     229
     230p.sidebar-subtitle {
     231  font-family: sans-serif ;
     232  font-weight: bold }
     233
     234p.topic-title {
     235  font-weight: bold }
     236
     237pre.address {
     238  margin-bottom: 0 ;
     239  margin-top: 0 ;
     240  font: inherit }
     241
     242pre.literal-block, pre.doctest-block {
     243  margin-left: 2em ;
     244  margin-right: 2em }
     245
     246span.classifier {
     247  font-family: sans-serif ;
     248  font-style: oblique }
     249
     250span.classifier-delimiter {
     251  font-family: sans-serif ;
     252  font-weight: bold }
     253
     254span.interpreted {
     255  font-family: sans-serif }
     256
     257span.option {
     258  white-space: nowrap }
     259
     260span.pre {
     261  white-space: pre }
     262
     263span.problematic {
     264  color: red }
     265
     266span.section-subtitle {
     267  /* font-size relative to parent (h1..h6 element) */
     268  font-size: 80% }
     269
     270table.citation {
     271  border-left: solid 1px gray;
     272  margin-left: 1px }
     273
     274table.docinfo {
     275  margin: 2em 4em }
     276
     277table.docutils {
     278  margin-top: 0.5em ;
     279  margin-bottom: 0.5em }
     280
     281table.footnote {
     282  border-left: solid 1px black;
     283  margin-left: 1px }
     284
     285table.docutils td, table.docutils th,
     286table.docinfo td, table.docinfo th {
     287  padding-left: 0.5em ;
     288  padding-right: 0.5em ;
     289  vertical-align: top }
     290
     291table.docutils th.field-name, table.docinfo th.docinfo-name {
     292  font-weight: bold ;
     293  text-align: left ;
     294  white-space: nowrap ;
     295  padding-left: 0 }
     296
     297h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
     298h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
     299  font-size: 100% }
     300
     301ul.auto-toc {
     302  list-style-type: none }
     303
     304</style>
     305</head>
     306<body>
     307<div class="document" id="welcome-to-tahoe-lafs">
     308<h1 class="title">Welcome to Tahoe-LAFS!</h1>
     309
     310<p>Welcome to <a class="reference external" href="http://tahoe-lafs.org">Tahoe-LAFS</a>, the first
     311decentralized storage system with <em>provider-independent security</em>.</p>
     312<div class="section" id="what-is-provider-independent-security">
     313<h1>What is &quot;provider-independent security&quot;?</h1>
     314<p>Every seller of cloud storage services will tell you that their service
     315is &quot;secure&quot;.  But what they mean by that is something fundamentally
     316different from what we mean.  What they mean by &quot;secure&quot; is that after
     317you've given them the power to read and modify your data, they try
     318really hard not to let this power be abused.  This turns out to be
     319difficult!  Bugs, misconfigurations, or operator error can accidentally
     320expose your data to another customer or to the public, or can corrupt
     321your data.  Criminals routinely gain illicit access to corporate
     322servers.  Even more insidious is the fact that the employees themselves
     323sometimes violate customer privacy out of carelessness, avarice, or
     324mere curiousity.  The most conscientious of these service providers
     325spend considerable effort and expense trying to mitigate these risks.</p>
     326<p>What we mean by &quot;security&quot; is something different.  <em>The service
     327provider never has the ability to read or modify your data in the first
     328place -- never.</em>  If you use Tahoe-LAFS, then all of the threats
     329described above are non-issues to you.  Not only is it easy and
     330inexpensive for the service provider to maintain the security of your
     331data, but in fact they couldn't violate its security if they tried.
     332This is what we call <em>provider-independent security</em>.</p>
     333<p>This guarantee is integrated naturally into the Tahoe-LAFS storage
     334system and doesn't require you to perform a manual pre-encryption step
     335or cumbersome key management.  (After all, having to do cumbersome
     336manual operations when storing or accessing your data would nullify one
     337of the primary benefits of using cloud storage in the first place --
     338convenience.)</p>
     339<p>Here's how it works:</p>
     340<img alt="http://tahoe-lafs.org/~zooko/network-and-reliance-topology.png" src="http://tahoe-lafs.org/~zooko/network-and-reliance-topology.png" />
     341<p>A &quot;storage grid&quot; is made up of a number of storage servers.  A storage
     342server has direct attached storage (typically one or more hard disks).
     343A &quot;gateway&quot; uses the storage servers and provides access to the
     344filesystem over HTTP(S) or (S)FTP.</p>
     345<p>Users do not rely on storage servers to provide <em>confidentiality</em> nor
     346<em>integrity</em> for their data -- instead all of the data is encrypted and
     347integrity-checked by the gateway, so that the servers can neither read
     348nor modify the contents of the files.</p>
     349<p>Users do rely on storage servers for <em>availability</em>.  The ciphertext is
     350erasure-coded and distributed across <tt class="docutils literal">N</tt> storage servers (the default
     351value for <tt class="docutils literal">N</tt> is 10) so that it can be recovered from any <tt class="docutils literal">K</tt> of
     352these servers (the default value of <tt class="docutils literal">K</tt> is 3).  Therefore only the
     353simultaneous failure of <tt class="docutils literal"><span class="pre">N-K+1</span></tt> (with the defaults, 8) servers can
     354make the data unavailable.</p>
     355<p>In the typical deployment mode each user runs her own gateway on her
     356own machine.  This way she relies on her own machine for the
     357confidentiality and integrity of the data.</p>
     358<p>An alternate deployment mode is that the gateway runs on a remote
     359machine and the user connects to it over HTTPS or SFTP.  This means
     360that the operator of the gateway can view and modify the user's data
     361(the user <em>relies on</em> the gateway for confidentiality and integrity),
     362but the advantage is that the user can access the filesystem with a
     363client that doesn't have the gateway software installed, such as an
     364Internet kiosk or cell phone.</p>
     365</div>
     366<div class="section" id="access-control">
     367<h1>Access Control</h1>
     368<p>There are two kinds of files: immutable and mutable.  Immutable files
     369have the property that once they have been uploaded to the storage grid
     370they can't be modified.  Mutable ones can be modified.  A user can have
     371read-write access to a mutable file or read-only access to it (or no
     372access to it at all).</p>
     373<p>A user who has read-write access to a mutable file or directory can
     374give another user read-write access to that file or directory, or they
     375can give read-only access to that file or directory.  A user who has
     376read-only access to a file or directory can give another user read-only
     377access to it.</p>
     378<p>When linking a file or directory into a parent directory, you can use a
     379read-write link or a read-only link.  If you use a read-write link,
     380then anyone who has read-write access to the parent directory can gain
     381read-write access to the child, and anyone who has read-only access to
     382the parent directory can gain read-only access to the child.  If you
     383use a read-only link, then anyone who has either read-write or
     384read-only access to the parent directory can gain read-only access to
     385the child.</p>
     386<p>For more technical detail, please see the <a class="reference external" href="http://tahoe-lafs.org/trac/tahoe-lafs/wiki/Doc">the doc page</a> on the Wiki.</p>
     387</div>
     388<div class="section" id="get-started">
     389<h1>Get Started</h1>
     390<p>To use Tahoe-LAFS, please see <a class="reference external" href="quickstart.rst">quickstart.rst</a>.</p>
     391</div>
     392<div class="section" id="license">
     393<h1>License</h1>
     394<p>You may use this package under the GNU General Public License, version
     3952 or, at your option, any later version.  See the file <a class="reference external" href="../COPYING.GPL">COPYING.GPL</a> for the terms of the GNU General Public License,
     396version 2.</p>
     397<p>You may use this package under the Transitive Grace Period Public
     398Licence, version 1 or, at your option, any later version.  The
     399Transitive Grace Period Public Licence has requirements similar to the
     400GPL except that it allows you to wait for up to twelve months after you
     401redistribute a derived work before releasing the source code of your
     402derived work. See the file <a class="reference external" href="../COPYING.TGPPL.html">COPYING.TGGPL</a> for
     403the terms of the Transitive Grace Period Public Licence, version 1.</p>
     404<p>(You may choose to use this package under the terms of either licence,
     405at your option.)</p>
     406</div>
     407</div>
     408</body>
    45409</html>

  • docs/quickstart.html 

    diff --git a/docs/quickstart.html b/docs/quickstart.html
index 87ff477..ad2b644 100644
    a b  
    1 <!DOCtype HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
    2 <html lang="en">
    3   <head>
    4     <title>Getting Tahoe-LAFS</title>
    5     <link rev="made" class="mailto" href="mailto:zooko[at]zooko[dot]com">
    6     <meta name="description" content="how to get Tahoe-LAFS">
    7     <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    8     <meta name="keywords" content="tahoe-lafs secure decentralized filesystem installation">
    9   </head>
     1<?xml version="1.0" encoding="utf-8" ?>
     2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
     3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
     4<head>
     5<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     6<meta name="generator" content="Docutils 0.6: http://docutils.sourceforge.net/" />
     7<title>Getting Tahoe-LAFS</title>
     8<style type="text/css">
    109
    11   <body>
    12     <h1>About Tahoe-LAFS</h1>
    13     <p>Welcome to <a href="http://tahoe-lafs.org">the Tahoe-LAFS project</a>, a secure, decentralized, fault-tolerant storage system. <a href="about.html">About Tahoe-LAFS.</a>
     10/*
     11:Author: David Goodger (goodger@python.org)
     12:Id: $Id: html4css1.css 5951 2009-05-18 18:03:10Z milde $
     13:Copyright: This stylesheet has been placed in the public domain.
    1414
    15     <h1>How To Get Tahoe-LAFS</h1>
     15Default cascading style sheet for the HTML output of Docutils.
    1616
    17     <p>This procedure has been verified to work on Windows, Mac, OpenSolaris, and too many flavors of Linux and of *BSD to list.  It's likely to work on other platforms.
     17See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
     18customize this style sheet.
     19*/
    1820
    19     <h2>In Case Of Trouble</h2>
     21/* used to remove borders from tables and images */
     22.borderless, table.borderless td, table.borderless th {
     23  border: 0 }
    2024
    21     <p>There are a few 3rd party libraries that Tahoe-LAFS depends on that might not be easy to set up on your platform.  If the following instructions don't Just Work without any further effort on your part, then please write to the <a href="http://tahoe-lafs.org/cgi-bin/mailman/listinfo/tahoe-dev">the tahoe-dev mailing list</a> where friendly hackers will help you out. You might also find clues in the Advanced Install section described below.
     25table.borderless td, table.borderless th {
     26  /* Override padding for "table.docutils td" with "! important".
     27     The right padding separates the table cells. */
     28  padding: 0 0.5em 0 0 ! important }
    2229
    23     <h2>Install Python</h2>
     30.first {
     31  /* Override more specific margin styles with "! important". */
     32  margin-top: 0 ! important }
    2433
    25     <p>Check if you already have an adequate version of Python installed by running <cite>python -V</cite>.  Python&nbsp;v2.4 (v2.4.4 or greater), Python&nbsp;v2.5, Python&nbsp;v2.6, or Python&nbsp;v2.7 will work. Python&nbsp;v3 does not work. On Windows, we recommend the use of Python&nbsp;v2.6 (native, not Cygwin). If you don't have one of these versions of Python installed, then follow the instructions on <a href="http://www.python.org/download/releases/2.6.6/">the Python download page</a> to download and install Python&nbsp;v2.6. Make sure that the path to the installation directory has no spaces in it (e.g. on Windows, do not install Python in the "<tt>Program Files</tt>" directory).</p>
    26     <p>If you are on Windows, you now must manually install the pywin32 package from <a href="http://sourceforge.net/projects/pywin32/files/">the pywin32 site</a> before getting Tahoe-LAFS. Make sure to get the correct file for the version of Python you are using &mdash; e.g. ending in "py2.6.exe" for Python&nbsp;v2.6. If using 64-bit Windows, the file should have "win-amd64" in its name.</p>
     34.last, .with-subtitle {
     35  margin-bottom: 0 ! important }
    2736
    28     <h2>Get Tahoe-LAFS</h2>
     37.hidden {
     38  display: none }
    2939
    30     <p>Download the latest stable release, v1.8.1:</p>
    31     <pre><a
    32     href="http://tahoe-lafs.org/source/tahoe-lafs/releases/allmydata-tahoe-1.8.1.zip">http://tahoe-lafs.org/source/tahoe-lafs/releases/allmydata-tahoe-1.8.1.zip</a></pre>
     40a.toc-backref {
     41  text-decoration: none ;
     42  color: black }
    3343
    34     <h2>Set Up Tahoe-LAFS</h2>
     44blockquote.epigraph {
     45  margin: 2em 5em ; }
    3546
    36     <p>Unpack the zip file and cd into the top-level directory.</p>
     47dl.docutils dd {
     48  margin-bottom: 0.5em }
    3749
    38     <p>Run <cite>python setup.py build</cite> to generate the <cite>tahoe</cite> executable in a subdirectory of the current directory named <cite>bin</cite>. This will download and build anything you need from various websites.</p>
     50/* Uncomment (and remove this text!) to get bold-faced definition list terms
     51dl.docutils dt {
     52  font-weight: bold }
     53*/
    3954
    40     <p>On Windows, the <cite>build</cite> step might tell you to open a new Command Prompt (or, on XP and earlier, to log out and back in again). This is needed the first time you set up Tahoe-LAFS on a particular installation of Windows.</p>
     55div.abstract {
     56  margin: 2em 5em }
    4157
    42     <p>Optionally run <cite>python setup.py test</cite> to verify that it passes all of its self-tests.</p>
     58div.abstract p.topic-title {
     59  font-weight: bold ;
     60  text-align: center }
    4361
    44     <p>Run <cite>bin/tahoe --version</cite> (on Windows, <cite>bin\tahoe --version</cite>) to verify that the executable tool prints out the right version number.</p>
     62div.admonition, div.attention, div.caution, div.danger, div.error,
     63div.hint, div.important, div.note, div.tip, div.warning {
     64  margin: 2em ;
     65  border: medium outset ;
     66  padding: 1em }
    4567
    46     <h2>Run Tahoe-LAFS</h2>
     68div.admonition p.admonition-title, div.hint p.admonition-title,
     69div.important p.admonition-title, div.note p.admonition-title,
     70div.tip p.admonition-title {
     71  font-weight: bold ;
     72  font-family: sans-serif }
    4773
    48     <p>Now you are ready to deploy a decentralized filesystem.  The <cite>tahoe</cite> executable in the <cite>bin</cite> directory can configure and launch your Tahoe-LAFS nodes.  See <a href="running.html">running.html</a> for instructions on how to do that.</p>
     74div.attention p.admonition-title, div.caution p.admonition-title,
     75div.danger p.admonition-title, div.error p.admonition-title,
     76div.warning p.admonition-title {
     77  color: red ;
     78  font-weight: bold ;
     79  font-family: sans-serif }
    4980
     81/* Uncomment (and remove this text!) to get reduced vertical space in
     82   compound paragraphs.
     83div.compound .compound-first, div.compound .compound-middle {
     84  margin-bottom: 0.5em }
    5085
    51     <h2>Advanced Installation</h2>
     86div.compound .compound-last, div.compound .compound-middle {
     87  margin-top: 0.5em }
     88*/
    5289
    53     <p>For optional features such as tighter integration with your operating system's package manager, you can see the <a href="http://tahoe-lafs.org/trac/tahoe/wiki/AdvancedInstall">AdvancedInstall</a> wiki page. The options on that page are not necessary to use Tahoe-LAFS and can be complicated, so we do not recommend following that page unless you have unusual requirements for advanced optional features. For most people, you should first follow the instructions on this page, and if that doesn't work then ask for help by writing to <a href="http://tahoe-lafs.org/cgi-bin/mailman/listinfo/tahoe-dev">the tahoe-dev mailing list</a>.</p>
    54   </body>
     90div.dedication {
     91  margin: 2em 5em ;
     92  text-align: center ;
     93  font-style: italic }
     94
     95div.dedication p.topic-title {
     96  font-weight: bold ;
     97  font-style: normal }
     98
     99div.figure {
     100  margin-left: 2em ;
     101  margin-right: 2em }
     102
     103div.footer, div.header {
     104  clear: both;
     105  font-size: smaller }
     106
     107div.line-block {
     108  display: block ;
     109  margin-top: 1em ;
     110  margin-bottom: 1em }
     111
     112div.line-block div.line-block {
     113  margin-top: 0 ;
     114  margin-bottom: 0 ;
     115  margin-left: 1.5em }
     116
     117div.sidebar {
     118  margin: 0 0 0.5em 1em ;
     119  border: medium outset ;
     120  padding: 1em ;
     121  background-color: #ffffee ;
     122  width: 40% ;
     123  float: right ;
     124  clear: right }
     125
     126div.sidebar p.rubric {
     127  font-family: sans-serif ;
     128  font-size: medium }
     129
     130div.system-messages {
     131  margin: 5em }
     132
     133div.system-messages h1 {
     134  color: red }
     135
     136div.system-message {
     137  border: medium outset ;
     138  padding: 1em }
     139
     140div.system-message p.system-message-title {
     141  color: red ;
     142  font-weight: bold }
     143
     144div.topic {
     145  margin: 2em }
     146
     147h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
     148h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
     149  margin-top: 0.4em }
     150
     151h1.title {
     152  text-align: center }
     153
     154h2.subtitle {
     155  text-align: center }
     156
     157hr.docutils {
     158  width: 75% }
     159
     160img.align-left, .figure.align-left{
     161  clear: left ;
     162  float: left ;
     163  margin-right: 1em }
     164
     165img.align-right, .figure.align-right {
     166  clear: right ;
     167  float: right ;
     168  margin-left: 1em }
     169
     170.align-left {
     171  text-align: left }
     172
     173.align-center {
     174  clear: both ;
     175  text-align: center }
     176
     177.align-right {
     178  text-align: right }
     179
     180/* reset inner alignment in figures */
     181div.align-right {
     182  text-align: left }
     183
     184/* div.align-center * { */
     185/*   text-align: left } */
     186
     187ol.simple, ul.simple {
     188  margin-bottom: 1em }
     189
     190ol.arabic {
     191  list-style: decimal }
     192
     193ol.loweralpha {
     194  list-style: lower-alpha }
     195
     196ol.upperalpha {
     197  list-style: upper-alpha }
     198
     199ol.lowerroman {
     200  list-style: lower-roman }
     201
     202ol.upperroman {
     203  list-style: upper-roman }
     204
     205p.attribution {
     206  text-align: right ;
     207  margin-left: 50% }
     208
     209p.caption {
     210  font-style: italic }
     211
     212p.credits {
     213  font-style: italic ;
     214  font-size: smaller }
     215
     216p.label {
     217  white-space: nowrap }
     218
     219p.rubric {
     220  font-weight: bold ;
     221  font-size: larger ;
     222  color: maroon ;
     223  text-align: center }
     224
     225p.sidebar-title {
     226  font-family: sans-serif ;
     227  font-weight: bold ;
     228  font-size: larger }
     229
     230p.sidebar-subtitle {
     231  font-family: sans-serif ;
     232  font-weight: bold }
     233
     234p.topic-title {
     235  font-weight: bold }
     236
     237pre.address {
     238  margin-bottom: 0 ;
     239  margin-top: 0 ;
     240  font: inherit }
     241
     242pre.literal-block, pre.doctest-block {
     243  margin-left: 2em ;
     244  margin-right: 2em }
     245
     246span.classifier {
     247  font-family: sans-serif ;
     248  font-style: oblique }
     249
     250span.classifier-delimiter {
     251  font-family: sans-serif ;
     252  font-weight: bold }
     253
     254span.interpreted {
     255  font-family: sans-serif }
     256
     257span.option {
     258  white-space: nowrap }
     259
     260span.pre {
     261  white-space: pre }
     262
     263span.problematic {
     264  color: red }
     265
     266span.section-subtitle {
     267  /* font-size relative to parent (h1..h6 element) */
     268  font-size: 80% }
     269
     270table.citation {
     271  border-left: solid 1px gray;
     272  margin-left: 1px }
     273
     274table.docinfo {
     275  margin: 2em 4em }
     276
     277table.docutils {
     278  margin-top: 0.5em ;
     279  margin-bottom: 0.5em }
     280
     281table.footnote {
     282  border-left: solid 1px black;
     283  margin-left: 1px }
     284
     285table.docutils td, table.docutils th,
     286table.docinfo td, table.docinfo th {
     287  padding-left: 0.5em ;
     288  padding-right: 0.5em ;
     289  vertical-align: top }
     290
     291table.docutils th.field-name, table.docinfo th.docinfo-name {
     292  font-weight: bold ;
     293  text-align: left ;
     294  white-space: nowrap ;
     295  padding-left: 0 }
     296
     297h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
     298h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
     299  font-size: 100% }
     300
     301ul.auto-toc {
     302  list-style-type: none }
     303
     304</style>
     305</head>
     306<body>
     307<div class="document" id="getting-tahoe-lafs">
     308<h1 class="title">Getting Tahoe-LAFS</h1>
     309
     310<p>Welcome to <a class="reference external" href="http://tahoe-lafs.org">the Tahoe-LAFS project</a>, a secure,
     311decentralized, fault-tolerant storage system. <a class="reference external" href="about.rst">About Tahoe-LAFS</a>.</p>
     312<div class="section" id="how-to-get-tahoe-lafs">
     313<h1>How To Get Tahoe-LAFS</h1>
     314<p>This procedure has been verified to work on Windows, Mac, OpenSolaris,
     315and too many flavors of Linux and of BSD to list.  It's likely to work
     316on other platforms.</p>
     317<div class="section" id="in-case-of-trouble">
     318<h2>In Case Of Trouble</h2>
     319<p>There are a few 3rd party libraries that Tahoe-LAFS depends on that
     320might not be easy to set up on your platform.  If the following
     321instructions don't Just Work without any further effort on your part,
     322then please write to <a class="reference external" href="http://tahoe-lafs.org/cgi-bin/mailman/listinfo/tahoe-dev">the tahoe-dev mailing list</a> where
     323friendly hackers will help you out. You might also find clues in the
     324<a class="reference internal" href="#advanced-installation">Advanced Installation</a> section described below.</p>
     325</div>
     326<div class="section" id="install-python">
     327<h2>Install Python</h2>
     328<p>Check if you already have an adequate version of Python installed by
     329running <tt class="docutils literal">python <span class="pre">-V</span></tt>.  Python v2.4 (v2.4.4 or greater), Python v2.5,
     330Python v2.6, or Python v2.7 will work. Python v3 does not work. On
     331Windows, we recommend the use of Python v2.6 (native, not Cygwin). If
     332you don't have one of these versions of Python installed, then follow
     333the instructions on <a class="reference external" href="http://www.python.org/download/releases/2.6.6/">the Python download page</a> to download and
     334install Python v2.6. Make sure that the path to the installation
     335directory has no spaces in it (e.g. on Windows, do not install Python
     336in the &quot;Program Files&quot; directory).</p>
     337<p>If you are on Windows, you now must manually install the pywin32
     338package from <a class="reference external" href="http://sourceforge.net/projects/pywin32/files/">the pywin32 site</a> before getting
     339Tahoe-LAFS. Make sure to get the correct file for the version of Python
     340you are using -- e.g. ending in &quot;py2.6.exe&quot; for Python v2.6. If using
     34164-bit Windows, the file should have &quot;win-amd64&quot; in its name.</p>
     342</div>
     343<div class="section" id="get-tahoe-lafs">
     344<h2>Get Tahoe-LAFS</h2>
     345<p><a class="reference external" href="http://tahoe-lafs.org/source/tahoe-lafs/releases/allmydata-tahoe-1.8.1.zip">Download the latest stable release, v1.8.1</a></p>
     346</div>
     347<div class="section" id="set-up-tahoe-lafs">
     348<h2>Set Up Tahoe-LAFS</h2>
     349<p>Unpack the zip file and cd into the top-level directory.</p>
     350<p>Run <tt class="docutils literal">python setup.py build</tt> to generate the <tt class="docutils literal">tahoe</tt> executable in a
     351subdirectory of the current directory named <tt class="docutils literal">bin</tt>. This will download
     352and build anything you need from various websites.</p>
     353<p>On Windows, the <tt class="docutils literal">build</tt> step might tell you to open a new Command
     354Prompt (or, on XP and earlier, to log out and back in again). This is
     355needed the first time you set up Tahoe-LAFS on a particular
     356installation of Windows.</p>
     357<p>Optionally run <tt class="docutils literal">python setup.py test</tt> to verify that it passes all
     358of its self-tests.</p>
     359<p>Run <tt class="docutils literal">bin/tahoe <span class="pre">--version</span></tt> (on Windows, <tt class="docutils literal">bin\tahoe <span class="pre">--version</span></tt>) to
     360verify that the executable tool prints out the right version number.</p>
     361</div>
     362<div class="section" id="run-tahoe-lafs">
     363<h2>Run Tahoe-LAFS</h2>
     364<p>Now you are ready to deploy a decentralized filesystem.  The <tt class="docutils literal">tahoe</tt>
     365executable in the <tt class="docutils literal">bin</tt> directory can configure and launch your
     366Tahoe-LAFS nodes.  See <a class="reference external" href="running.rst">running.rst</a> for instructions on
     367how to do that.</p>
     368</div>
     369<div class="section" id="advanced-installation">
     370<h2>Advanced Installation</h2>
     371<p>For optional features such as tighter integration with your operating
     372system's package manager, you can see the <a class="reference external" href="http://tahoe-lafs.org/trac/tahoe/wiki/AdvancedInstall">AdvancedInstall</a> wiki page.
     373The options on that page are not necessary to use Tahoe-LAFS and can be
     374complicated, so we do not recommend following that page unless you have
     375unusual requirements for advanced optional features. For most people,
     376you should first follow the instructions on this page, and if that
     377doesn't work then ask for help by writing to <a class="reference external" href="http://tahoe-lafs.org/cgi-bin/mailman/listinfo/tahoe-dev">the tahoe-dev mailing
     378list</a>.</p>
     379</div>
     380</div>
     381</div>
     382</body>
    55383</html>

  • docs/running.html 

    diff --git a/docs/running.html b/docs/running.html
index 90640f1..928f91b 100644
    a b  
    1 <!DOCtype HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
    2 <html lang="en">
    3   <head>
    4     <title>Running Tahoe-LAFS</title>
    5     <link rev="made" class="mailto" href="mailto:zooko[at]zooko[dot]com">
    6     <meta name="description" content="how to run Tahoe-LAFS">
    7     <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    8     <meta name="keywords" content="tahoe Tahoe-LAFS secure decentralized filesystem operation">
    9   </head>
    10 
    11   <body>
    12     <h1>How To Run Tahoe-LAFS</h1>
    13 
    14     <p>This is how to run a Tahoe-LAFS client or a complete Tahoe-LAFS grid. First you
    15     have to install the Tahoe-LAFS software, as documented in <a
    16     href="install.html">install.html</a>.</p>
    17 
    18     <p>The <code>tahoe</code> program in the <code>bin</code> directory is
    19     used to create, start, and stop nodes. Each node lives in a separate base
    20     directory, in which there is a configuration file named <code>tahoe.cfg</code>. Nodes
    21     read and write files within this base directory.</p>
    22 
    23     <p>A grid consists of a set of <em>storage nodes</em> and <em>client nodes</em>
    24     running the Tahoe-LAFS code. There is also an <em>introducer node</em> that
    25     is responsible for getting the other nodes talking to each other.</p>
    26 
    27     <p>If you're getting started we recommend you try connecting to
    28     the <a href="http://tahoe-lafs.org/trac/tahoe-lafs/wiki/TestGrid">the
    29     public test grid</a> as you only need to create a client node.
    30     When you want to create your own grid you'll need to create the
    31     introducer and several initial storage nodes (see the note about
    32     small grids below).</p>
    33 
    34     <p>If the Tahoe-LAFS <code>bin</code> directory is not on your PATH, then
    35     in all the command lines below, specify the full path to <code>bin/tahoe</code>.</p>
    36 
    37     <p>To construct a client node, run
    38     "<code>tahoe create-client</code>", which will create <code>~/.tahoe</code> to be the
    39     node's base directory. Acquire a copy of the <code>introducer.furl</code>
    40     from the introducer and put it into this directory, then use
    41     "<code>tahoe run</code>". After that, the node should be off and running. The first
    42     thing it will do is connect to the introducer and get itself connected to
    43     all other nodes on the grid.  By default, "<code>tahoe create-client</code>"
    44     creates a client-only node, that does not offer its disk space to other nodes.
    45     To configure other behavior, use "<code>tahoe create-node</code>" or see
    46     <a href="configuration.rst">configuration.rst</a>.</p>
    47 
    48     <p>To construct an introducer, create a new base directory for it (the name
    49     of the directory is up to you), <code>cd</code> into it, and run
    50     "<code>tahoe create-introducer .</code>". Now run the introducer using
    51     "<code>tahoe start .</code>". After it starts, it will write a file named
    52     <code>introducer.furl</code> in that base directory. This file contains the
    53     URL the other nodes must use in order to connect to this introducer.
    54     (Note that "<code>tahoe run .</code>" doesn't work for introducers, this is a known
    55     issue: <a href="http://allmydata.org/trac/tahoe-lafs/ticket/937">#937</a>.)</p>
    56 
    57     <p>The "<code>tahoe run</code>" command above
    58     will run the node in the foreground. On Unix, you can run it in the background
    59     instead by using the "<code>tahoe start</code>" command.
    60     To stop a node started in this way, use "<code>tahoe stop</code>".
    61     <code>tahoe --help</code> gives a summary of all commands.</p>
    62 
    63     <p>See <a href="configuration.rst">configuration.rst</a> for more
    64     details about how to configure Tahoe-LAFS, including how to get other
    65     clients to connect to your node if it is behind a firewall or NAT device.
    66 
    67 
    68     <h3>A note about small grids</h3>
    69 
    70     <p>By default, Tahoe-LAFS ships with the configuration parameter
    71     <code>shares.happy</code> set to 7. If you are using Tahoe-LAFS on a
    72     grid with fewer than 7 storage nodes, this won't work well for you
    73     &mdash; none of your uploads will succeed. To fix this, see <a
    74     href='configuration.rst'>configuration.rst</a> to learn how to set
    75     <code>shares.happy</code> to a more suitable value for your
    76     grid.</p>
    77 
    78 
    79     <h2>Do Stuff With It</h2>
    80 
    81     <p>This is how to use your Tahoe-LAFS node.</p>
    82 
    83     <h3>The WUI</h3>
    84 
    85     <p>Point your web browser to <a
    86     href="http://127.0.0.1:3456">http://127.0.0.1:3456</a> &mdash; which is the URL
    87     of the gateway running on your own local computer &mdash; to use your newly
    88     created node.</p>
    89 
    90     <p>Create a new directory (with the button labelled "create a directory").
    91     Your web browser will load the new directory.  Now if you want to be able
    92     to come back to this directory later, you have to bookmark it, or otherwise
    93     save a copy of the URL.  If you lose URL to this directory, then you can never
    94     again come back to this directory.</p>
    95 
    96     <p>You can do more or less everything you want to do with a decentralized
    97     filesystem through the WUI.</p>
    98 
    99     <h3>The CLI</h3>
    100 
    101     <p>Prefer the command-line? Run "<code>tahoe --help</code>" (the same
    102     command-line tool that is used to start and stop nodes serves to navigate
    103     and use the decentralized filesystem). To get started, create a new
    104     directory and mark it as the 'tahoe:' alias by running "<code>tahoe
    105     create-alias tahoe</code>". Once you've done that, you can do
    106     "<code>tahoe ls tahoe:</code>" and "<code>tahoe cp LOCALFILE
    107     tahoe:foo.txt</code>" to work with your filesystem. The Tahoe-LAFS CLI uses
    108     similar syntax to the well-known scp and rsync tools. See <a
    109     href="frontends/CLI.rst">CLI.rst</a> for more details.</p>
    110 
    111     <p>As with the WUI (and with all current interfaces to Tahoe-LAFS), you are
    112     responsible for remembering directory capabilities yourself. If you create
    113     a new directory and lose the capability to it, then you cannot access that
    114     directory ever again.</p>
    115 
    116     <h3>The SFTP and FTP frontends</h3>
    117 
    118     <p>You can access your Tahoe-LAFS grid via any <a href="http://en.wikipedia.org/wiki/SSH_file_transfer_protocol">SFTP</a> or
    119     <a href="http://en.wikipedia.org/wiki/File_Transfer_Protocol">FTP</a> client.
    120     See <a href="frontends/FTP-and-SFTP.rst">FTP-and-SFTP.rst</a> for how to set this up.
    121     On most Unix platforms, you can also use SFTP to plug Tahoe-LAFS into your computer's
    122     local filesystem via <code>sshfs</code>.
    123    
    124     <p>The <a href="http://tahoe-lafs.org/trac/tahoe-lafs/wiki/SftpFrontend">SftpFrontend</a> page
    125     on the wiki has more information about using SFTP with Tahoe-LAFS.</p>
    126 
    127     <h3>The WAPI</h3>
    128 
    129     <p>Want to program your Tahoe-LAFS node to do your bidding?  Easy!  See <a
    130     href="frontends/webapi.rst">webapi.rst</a>.</p>
    131 
    132     <h2>Socialize</h2>
     1<?xml version="1.0" encoding="utf-8" ?>
     2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
     3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
     4<head>
     5<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     6<meta name="generator" content="Docutils 0.6: http://docutils.sourceforge.net/" />
     7<title>How To Run Tahoe-LAFS</title>
     8<style type="text/css">
    1339
    134     <p>You can chat with other users of and hackers of this software on the
    135     #tahoe-lafs IRC channel at <code>irc.freenode.net</code>, or on the <a
    136     href="http://tahoe-lafs.org/cgi-bin/mailman/listinfo/tahoe-dev">tahoe-dev mailing list</a>.</p>
    137 
    138   </body>
     10/*
     11:Author: David Goodger (goodger@python.org)
     12:Id: $Id: html4css1.css 5951 2009-05-18 18:03:10Z milde $
     13:Copyright: This stylesheet has been placed in the public domain.
    13914
     15Default cascading style sheet for the HTML output of Docutils.
     16
     17See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
     18customize this style sheet.
     19*/
     20
     21/* used to remove borders from tables and images */
     22.borderless, table.borderless td, table.borderless th {
     23  border: 0 }
     24
     25table.borderless td, table.borderless th {
     26  /* Override padding for "table.docutils td" with "! important".
     27     The right padding separates the table cells. */
     28  padding: 0 0.5em 0 0 ! important }
     29
     30.first {
     31  /* Override more specific margin styles with "! important". */
     32  margin-top: 0 ! important }
     33
     34.last, .with-subtitle {
     35  margin-bottom: 0 ! important }
     36
     37.hidden {
     38  display: none }
     39
     40a.toc-backref {
     41  text-decoration: none ;
     42  color: black }
     43
     44blockquote.epigraph {
     45  margin: 2em 5em ; }
     46
     47dl.docutils dd {
     48  margin-bottom: 0.5em }
     49
     50/* Uncomment (and remove this text!) to get bold-faced definition list terms
     51dl.docutils dt {
     52  font-weight: bold }
     53*/
     54
     55div.abstract {
     56  margin: 2em 5em }
     57
     58div.abstract p.topic-title {
     59  font-weight: bold ;
     60  text-align: center }
     61
     62div.admonition, div.attention, div.caution, div.danger, div.error,
     63div.hint, div.important, div.note, div.tip, div.warning {
     64  margin: 2em ;
     65  border: medium outset ;
     66  padding: 1em }
     67
     68div.admonition p.admonition-title, div.hint p.admonition-title,
     69div.important p.admonition-title, div.note p.admonition-title,
     70div.tip p.admonition-title {
     71  font-weight: bold ;
     72  font-family: sans-serif }
     73
     74div.attention p.admonition-title, div.caution p.admonition-title,
     75div.danger p.admonition-title, div.error p.admonition-title,
     76div.warning p.admonition-title {
     77  color: red ;
     78  font-weight: bold ;
     79  font-family: sans-serif }
     80
     81/* Uncomment (and remove this text!) to get reduced vertical space in
     82   compound paragraphs.
     83div.compound .compound-first, div.compound .compound-middle {
     84  margin-bottom: 0.5em }
     85
     86div.compound .compound-last, div.compound .compound-middle {
     87  margin-top: 0.5em }
     88*/
     89
     90div.dedication {
     91  margin: 2em 5em ;
     92  text-align: center ;
     93  font-style: italic }
     94
     95div.dedication p.topic-title {
     96  font-weight: bold ;
     97  font-style: normal }
     98
     99div.figure {
     100  margin-left: 2em ;
     101  margin-right: 2em }
     102
     103div.footer, div.header {
     104  clear: both;
     105  font-size: smaller }
     106
     107div.line-block {
     108  display: block ;
     109  margin-top: 1em ;
     110  margin-bottom: 1em }
     111
     112div.line-block div.line-block {
     113  margin-top: 0 ;
     114  margin-bottom: 0 ;
     115  margin-left: 1.5em }
     116
     117div.sidebar {
     118  margin: 0 0 0.5em 1em ;
     119  border: medium outset ;
     120  padding: 1em ;
     121  background-color: #ffffee ;
     122  width: 40% ;
     123  float: right ;
     124  clear: right }
     125
     126div.sidebar p.rubric {
     127  font-family: sans-serif ;
     128  font-size: medium }
     129
     130div.system-messages {
     131  margin: 5em }
     132
     133div.system-messages h1 {
     134  color: red }
     135
     136div.system-message {
     137  border: medium outset ;
     138  padding: 1em }
     139
     140div.system-message p.system-message-title {
     141  color: red ;
     142  font-weight: bold }
     143
     144div.topic {
     145  margin: 2em }
     146
     147h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
     148h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
     149  margin-top: 0.4em }
     150
     151h1.title {
     152  text-align: center }
     153
     154h2.subtitle {
     155  text-align: center }
     156
     157hr.docutils {
     158  width: 75% }
     159
     160img.align-left, .figure.align-left{
     161  clear: left ;
     162  float: left ;
     163  margin-right: 1em }
     164
     165img.align-right, .figure.align-right {
     166  clear: right ;
     167  float: right ;
     168  margin-left: 1em }
     169
     170.align-left {
     171  text-align: left }
     172
     173.align-center {
     174  clear: both ;
     175  text-align: center }
     176
     177.align-right {
     178  text-align: right }
     179
     180/* reset inner alignment in figures */
     181div.align-right {
     182  text-align: left }
     183
     184/* div.align-center * { */
     185/*   text-align: left } */
     186
     187ol.simple, ul.simple {
     188  margin-bottom: 1em }
     189
     190ol.arabic {
     191  list-style: decimal }
     192
     193ol.loweralpha {
     194  list-style: lower-alpha }
     195
     196ol.upperalpha {
     197  list-style: upper-alpha }
     198
     199ol.lowerroman {
     200  list-style: lower-roman }
     201
     202ol.upperroman {
     203  list-style: upper-roman }
     204
     205p.attribution {
     206  text-align: right ;
     207  margin-left: 50% }
     208
     209p.caption {
     210  font-style: italic }
     211
     212p.credits {
     213  font-style: italic ;
     214  font-size: smaller }
     215
     216p.label {
     217  white-space: nowrap }
     218
     219p.rubric {
     220  font-weight: bold ;
     221  font-size: larger ;
     222  color: maroon ;
     223  text-align: center }
     224
     225p.sidebar-title {
     226  font-family: sans-serif ;
     227  font-weight: bold ;
     228  font-size: larger }
     229
     230p.sidebar-subtitle {
     231  font-family: sans-serif ;
     232  font-weight: bold }
     233
     234p.topic-title {
     235  font-weight: bold }
     236
     237pre.address {
     238  margin-bottom: 0 ;
     239  margin-top: 0 ;
     240  font: inherit }
     241
     242pre.literal-block, pre.doctest-block {
     243  margin-left: 2em ;
     244  margin-right: 2em }
     245
     246span.classifier {
     247  font-family: sans-serif ;
     248  font-style: oblique }
     249
     250span.classifier-delimiter {
     251  font-family: sans-serif ;
     252  font-weight: bold }
     253
     254span.interpreted {
     255  font-family: sans-serif }
     256
     257span.option {
     258  white-space: nowrap }
     259
     260span.pre {
     261  white-space: pre }
     262
     263span.problematic {
     264  color: red }
     265
     266span.section-subtitle {
     267  /* font-size relative to parent (h1..h6 element) */
     268  font-size: 80% }
     269
     270table.citation {
     271  border-left: solid 1px gray;
     272  margin-left: 1px }
     273
     274table.docinfo {
     275  margin: 2em 4em }
     276
     277table.docutils {
     278  margin-top: 0.5em ;
     279  margin-bottom: 0.5em }
     280
     281table.footnote {
     282  border-left: solid 1px black;
     283  margin-left: 1px }
     284
     285table.docutils td, table.docutils th,
     286table.docinfo td, table.docinfo th {
     287  padding-left: 0.5em ;
     288  padding-right: 0.5em ;
     289  vertical-align: top }
     290
     291table.docutils th.field-name, table.docinfo th.docinfo-name {
     292  font-weight: bold ;
     293  text-align: left ;
     294  white-space: nowrap ;
     295  padding-left: 0 }
     296
     297h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
     298h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
     299  font-size: 100% }
     300
     301ul.auto-toc {
     302  list-style-type: none }
     303
     304</style>
     305</head>
     306<body>
     307<div class="document" id="how-to-run-tahoe-lafs">
     308<h1 class="title">How To Run Tahoe-LAFS</h1>
     309
     310<div class="section" id="intro">
     311<h1>Intro</h1>
     312<p>This is how to run a Tahoe-LAFS client or a complete Tahoe-LAFS grid.
     313First you have to install the Tahoe-LAFS software, as documented in
     314<a class="reference external" href="quickstart.rst">quickstart.rst</a>.</p>
     315<p>The <tt class="docutils literal">tahoe</tt> program in the <tt class="docutils literal">bin</tt> directory is used to create,
     316start, and stop nodes. Each node lives in a separate base directory, in
     317which there is a configuration file named <tt class="docutils literal">tahoe.cfg</tt>. Nodes read and
     318write files within this base directory.</p>
     319<p>A grid consists of a set of <em>storage nodes</em> and <em>client nodes</em> running
     320the Tahoe-LAFS code. There is also an <em>introducer node</em> that is
     321responsible for getting the other nodes talking to each other.</p>
     322<p>If you're getting started we recommend you try connecting to
     323the <a class="reference external" href="http://tahoe-lafs.org/trac/tahoe-lafs/wiki/TestGrid">the public test grid</a> as you only
     324need to create a client node. When you want to create your own grid
     325you'll need to create the introducer and several initial storage nodes
     326(see the note about small grids below).</p>
     327<p>If the Tahoe-LAFS <tt class="docutils literal">bin</tt> directory is not on your PATH, then in all
     328the command lines below, specify the full path to <tt class="docutils literal">bin/tahoe</tt>.</p>
     329<p>To construct a client node, run &quot;<tt class="docutils literal">tahoe <span class="pre">create-client</span></tt>&quot;, which will
     330create <tt class="docutils literal"><span class="pre">~/.tahoe</span></tt> to be the node's base directory. Acquire a copy of
     331the <tt class="docutils literal">introducer.furl</tt> from the introducer and put it into this
     332directory, then use &quot;<tt class="docutils literal">tahoe run</tt>&quot;. After that, the node should be off
     333and running. The first thing it will do is connect to the introducer
     334and get itself connected to all other nodes on the grid.  By default,
     335&quot;<tt class="docutils literal">tahoe <span class="pre">create-client</span></tt>&quot; creates a client-only node, that does not
     336offer its disk space to other nodes. To configure other behavior, use
     337&quot;<tt class="docutils literal">tahoe <span class="pre">create-node</span></tt>&quot; or see <a class="reference external" href="configuration.rst">configuration.rst</a>.</p>
     338<p>To construct an introducer, create a new base directory for it (the
     339name of the directory is up to you), <tt class="docutils literal">cd</tt> into it, and run
     340&quot;<tt class="docutils literal">tahoe <span class="pre">create-introducer</span> .</tt>&quot;. Now run the introducer using
     341&quot;<tt class="docutils literal">tahoe start .</tt>&quot;. After it starts, it will write a file named
     342<tt class="docutils literal">introducer.furl</tt> in that base directory. This file contains the URL
     343the other nodes must use in order to connect to this introducer. (Note
     344that &quot;<tt class="docutils literal">tahoe run .</tt>&quot; doesn't work for introducers, this is a known
     345issue: <a class="reference external" href="http://allmydata.org/trac/tahoe-lafs/ticket/937">#937</a>.)</p>
     346<p>The &quot;<tt class="docutils literal">tahoe run</tt>&quot; command above will run the node in the foreground.
     347On Unix, you can run it in the background instead by using the
     348&quot;<tt class="docutils literal">tahoe start</tt>&quot; command. To stop a node started in this way, use
     349&quot;<tt class="docutils literal">tahoe stop</tt>&quot;. <tt class="docutils literal">tahoe <span class="pre">--help</span></tt> gives a summary of all commands.</p>
     350<p>See <a class="reference external" href="configuration.rst">configuration.rst</a> for more details about how
     351to configure Tahoe-LAFS, including how to get other clients to connect
     352to your node if it is behind a firewall or NAT device.</p>
     353<div class="section" id="a-note-about-small-grids">
     354<h2>A note about small grids</h2>
     355<p>By default, Tahoe-LAFS ships with the configuration parameter
     356<tt class="docutils literal">shares.happy</tt> set to 7. If you are using Tahoe-LAFS on a
     357grid with fewer than 7 storage nodes, this won't work well for you
     358&amp;mdash; none of your uploads will succeed. To fix this, see &lt;a
     359href='configuration.rst'&gt;configuration.rst&lt;/a&gt; to learn how to set
     360<tt class="docutils literal">shares.happy</tt> to a more suitable value for your
     361grid.</p>
     362</div>
     363</div>
     364<div class="section" id="do-stuff-with-it">
     365<h1>Do Stuff With It</h1>
     366<p>This is how to use your Tahoe-LAFS node.</p>
     367<div class="section" id="the-wui">
     368<h2>The WUI</h2>
     369<p>Point your web browser to <a class="reference external" href="http://127.0.0.1:3456">http://127.0.0.1:3456</a> -- which is the URL of the gateway running on
     370your own local computer -- to use your newly created node.</p>
     371<p>Create a new directory (with the button labelled &quot;create a directory&quot;).
     372Your web browser will load the new directory.  Now if you want to be
     373able to come back to this directory later, you have to bookmark it, or
     374otherwise save a copy of the URL.  If you lose URL to this directory,
     375then you can never again come back to this directory.</p>
     376<p>You can do more or less everything you want to do with a decentralized
     377filesystem through the WUI.</p>
     378</div>
     379<div class="section" id="the-cli">
     380<h2>The CLI</h2>
     381<p>Prefer the command-line? Run &quot;<tt class="docutils literal">tahoe <span class="pre">--help</span></tt>&quot; (the same command-line
     382tool that is used to start and stop nodes serves to navigate and use
     383the decentralized filesystem). To get started, create a new directory
     384and mark it as the 'tahoe:' alias by running
     385&quot;<tt class="docutils literal">tahoe <span class="pre">create-alias</span> tahoe</tt>&quot;. Once you've done that, you can do
     386&quot;<tt class="docutils literal">tahoe ls tahoe:</tt>&quot; and &quot;<tt class="docutils literal">tahoe cp LOCALFILE tahoe:foo.txt</tt>&quot; to
     387work with your filesystem. The Tahoe-LAFS CLI uses similar syntax to
     388the well-known scp and rsync tools. See <a class="reference external" href="frontends/CLI.rst">CLI.rst</a>
     389for more details.</p>
     390<p>As with the WUI (and with all current interfaces to Tahoe-LAFS), you
     391are responsible for remembering directory capabilities yourself. If you
     392create a new directory and lose the capability to it, then you cannot
     393access that directory ever again.</p>
     394</div>
     395<div class="section" id="the-sftp-and-ftp-frontends">
     396<h2>The SFTP and FTP frontends</h2>
     397<p>You can access your Tahoe-LAFS grid via any <a class="reference external" href="http://en.wikipedia.org/wiki/SSH_file_transfer_protocol">SFTP</a> or <a class="reference external" href="http://en.wikipedia.org/wiki/File_Transfer_Protocol">FTP</a> client.
     398See <a class="reference external" href="frontends/FTP-and-SFTP.rst">FTP-and-SFTP.rst</a> for how to set
     399this up. On most Unix platforms, you can also use SFTP to plug
     400Tahoe-LAFS into your computer's local filesystem via <tt class="docutils literal">sshfs</tt>.</p>
     401<p>The <a class="reference external" href="http://tahoe-lafs.org/trac/tahoe-lafs/wiki/SftpFrontend">SftpFrontend</a> page on the
     402wiki has more information about using SFTP with Tahoe-LAFS.</p>
     403</div>
     404<div class="section" id="the-wapi">
     405<h2>The WAPI</h2>
     406<p>Want to program your Tahoe-LAFS node to do your bidding?  Easy!  See
     407<a class="reference external" href="frontends/webapi.rst">webapi.rst</a>.</p>
     408</div>
     409</div>
     410<div class="section" id="socialize">
     411<h1>Socialize</h1>
     412<p>You can chat with other users of and hackers of this software on the
     413#tahoe-lafs IRC channel at <tt class="docutils literal">irc.freenode.net</tt>, or on the <a class="reference external" href="http://tahoe-lafs.org/cgi-bin/mailman/listinfo/tahoe-dev">tahoe-dev
     414mailing list</a>.</p>
     415</div>
     416</div>
     417</body>
    140418</html>