docs/using.html

   1 <!DOCtype HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html lang="en">
   3   <head>
   4     <title>Using Tahoe</title>
   5     <link rev="made" class="mailto" href="mailto:zooko[at]zooko[dot]com">
   6     <meta name="description" content="how to use Tahoe">
   7     <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
   8     <meta name="keywords" content="tahoe secure decentralized filesystem operation">
   9   </head>
  10
  11   <body>
  12     <p>This is how to use your Tahoe node.  First, you have to run your own local Tahoe node, as described in <a href="running.html">running.html</a>.</p>
  13
  14     <h1>The WUI</h1>
  15
  16     <p>Point your web browser to <a href="http://127.0.0.1:8123">http://127.0.0.1:8123</a> -- which is the URL of your own local computer -- to use your newly created node.</p>
  17
  18     <p>Create a new directory (with the button labelled "create a directory").  Your web browser will load the new directory.  Now if you want to be able to come back to this directory later, you have to bookmark it, or otherwise save the URL of it.  If you lose URL to this directory, then you can never again come back to this directory.</p>
  19
  20     <p>You can do more or less everything you want to do with a decentralized filesystem through the WUI.</p>
  21
  22     <p>P.S.  "WUI" is pronounced "wooey".</p>
  23
  24     <h1>The CLI</h1>
  25
  26     <p>Prefer the command-line? Run "<cite>tahoe --help</cite>" (the same
  27     command-line tool that is used to start and stop nodes serves to navigate
  28     and use the decentralized filesystem). To get started, create a new
  29     directory and mark it as the 'tahoe:' alias by running "<cite>tahoe
  30     add-alias tahoe `tahoe mkdir`</cite>". Once you've done that, you can do
  31     "<cite>tahoe ls tahoe:</cite>" and "<cite>tahoe cp LOCALFILE
  32     tahoe:foo.txt</cite>" to work with your filesystem. The Tahoe CLI uses
  33     the same syntax as the well-known scp and rsync tools. See <a
  34     href="CLI.txt">CLI.txt</a> for more details.</p>
  35
  36     <p>As with the WUI (and with all current interfaces to Tahoe), you are
  37     responsible for remembering directory capabilities yourself. If you
  38     create a new directory and lose the capability to it, then you cannot
  39     access that directory ever again.</p>
  40
  41     <p>P.S.  "CLI" is pronounced "clee".</p>
  42
  43     <h1>The FUSE Extension</h1>
  44
  45     <p>You can plug Tahoe into your computer's local filesystem using the FUSE extension, found in the <cite>contrib</cite> directory.  Warning: unlike most of Tahoe, and unlike the rest of the user interfaces described on this page, the FUSE plugin doesn't have extensive unit tests that are automatically run on every check-in of the source.  Therefore, we can't be sure how complete and reliable it is.</p>
  46
  47     <p>P.S.  "FUSE" rhymes with "booze".</p>
  48
  49     <h1>The WAPI</h1>
  50
  51     <p>Want to program your Tahoe node to do your bidding?  Easy!  See <a href="webapi.txt">webapi.txt</a>.</p>
  52
  53     <p>P.S.  "WAPI" is pronounced "wappy".</p>
  54
  55     <h2>Socialize</h2>
  56
  57     <p>You can chat with other users of and hackers of this software at <a href="http://allmydata.org/">http://allmydata.org</a>.</p>
  58
  59   </body>
  60
  61 </html>