Commit Graph

885 Commits

Author SHA1 Message Date
Zooko O'Whielacronx 6363ab5727 docs: architecture.txt: some edits with Amber 2008-02-01 12:39:06 -07:00
Zooko O'Whielacronx a2e1f13fd8 docs: update docs/about.html with Amber 2008-02-01 11:39:23 -07:00
Brian Warner 412f2ceda5 install-details.html: debian 3.1 is better known as 'sarge' 2008-01-30 17:03:42 -07:00
Zooko O'Whielacronx 991cbe4804 docs: add note that Debian 3.1 seems to have the same problem as Ubuntu Dapper with regard to Nevow and Twisted version compatibility 2008-01-30 12:21:17 -07:00
Brian Warner f4c0167552 docs/dirnodes.txt: rewrite to reflect 0.7.0's RSA-based SDMF dirnodes 2008-01-29 19:13:58 -07:00
Zooko O'Whielacronx f200090b45 docs: edit "grid of storage servers" section with Amber 2008-01-28 11:48:21 -07:00
Zooko O'Whielacronx 5bc69329fc docs: edit architecture.txt with Amber's help 2008-01-28 11:33:46 -07:00
Zooko O'Whielacronx e00b5daff7 docs: edit install.html to point to about.html 2008-01-23 08:08:10 -07:00
Zooko O'Whielacronx f3a9a47420 docs: about.html: edit thanks to nej 2008-01-21 21:52:01 -07:00
Zooko O'Whielacronx 6c0e894134 doc: architecture.txt: start updating architecture.txt
I chose to remove mention of non-convergent encoding, not because I dislike non-convergent encoding, but because that option isn't currently expressed in the API and in order to shorten architecture.txt.  I renamed "URI" to "Capability".  I did some editing, including updating a few places that treated all capabilities as CHK-capabilities and that mentioned that distributed SSKs were not yet implemented.
2008-01-21 17:53:03 -07:00
Zooko O'Whielacronx 2148903125 docs: architecture.txt: reflow to 77 cols
Experiment showed that reflowing to 77 cols changed the fewest lines.
2008-01-21 17:26:28 -07:00
Zooko O'Whielacronx cce2dbfe80 doc: fix typos and otherwise edit about.html 2008-01-21 15:54:43 -07:00
Zooko O'Whielacronx 20aaefc3f0 doc: add an overview to about.html
Hopefully this overview has the right combination of generality and precision to satisfy The Norm Hardy Request:
http://allmydata.org/pipermail/tahoe-dev/2007-November/000222.html
2008-01-21 15:19:25 -07:00
Brian Warner db5f58f9d5 docs/mutable-DSA.txt: update mutable.txt to reflect our proposed DSA-based mutable file scheme (#217) 2008-01-11 04:30:58 -07:00
Zooko O'Whielacronx 973a01edb8 docs: mention some tips of how to resolve a certain dependency on Dapper 2008-01-10 15:32:38 -07:00
Zooko O'Whielacronx ed9c41d8a7 docs: start updating install-details.html to reflect current auto-dependency and setuptools requirements, and to be better written 2008-01-10 14:03:37 -07:00
Zooko O'Whielacronx b0dd88158a setup: update the version numbers of packages that we require, add zope.interface to our requirements, make nevow >= 0.6.0 always be a requirement 2008-01-10 13:56:39 -07:00
Zooko O'Whielacronx 10d7d48bf8 docs: add require version numbers of deps to install.html, move pywin32 from install.html to install-details.html, change ref to install-details.html in install.html 2008-01-10 13:35:30 -07:00
Brian Warner 25666e1d44 docs/mutable-DSA.svg: fix background color, resolution for export-to-png 2008-01-08 20:11:04 -07:00
Brian Warner d95a4df0c7 docs/mutable-DSA.svg: add a picture of the upcoming DSA-based mutable file structure 2008-01-08 20:08:52 -07:00
the real nejucomo ca26c2ad5e Make the purpose and location of the tahoe executable more explicit in install.html. 2008-01-08 11:33:26 -07:00
Zooko O'Whielacronx 55caa2db92 docs: update configuration.txt to mention the private subdir and edit the description of webport 2008-01-08 11:44:07 -07:00
Zooko O'Whielacronx 7f9e6dc318 docs: fix hyperlinks from install.html to the Win32 and Cygwin notes 2008-01-08 11:38:48 -07:00
Zooko O'Whielacronx 5e75c83b9f docs: update the example link in using.html 2008-01-08 11:23:45 -07:00
Zooko O'Whielacronx 9e2ed2df01 direct the user to docs/write_coordination.html in case of an UncoordinatedWriteError 2008-01-08 11:15:06 -07:00
Zooko O'Whielacronx 5ea9f156be docs: make it so that people will stop experiencing build failure due to g++ not being installed 2008-01-08 11:03:29 -07:00
Zooko O'Whielacronx 74bf8047ba docs: add not to dirnode.txt that it is obsolete 2008-01-08 10:50:25 -07:00
Zooko O'Whielacronx 4223f7216d rename "dir-uri" to "dir-cap" 2008-01-08 10:41:27 -07:00
Zooko O'Whielacronx a9a06fae25 docs: some documentation updates for 0.7.0 2008-01-08 10:32:41 -07:00
Zooko O'Whielacronx 11f960b9fc doc: describe how to start client first in running.html 2008-01-06 01:16:57 -07:00
Zooko O'Whielacronx 7eb291302c more introductory doc cleanup
mv README to docs/about.html and reformat it as HTML
add a new README which is a text file pointing to docs/{about,install,running}.html
include the Transitive Grace Period Public Licence in its HTML form (it is too big)
2008-01-04 18:09:19 -07:00
robk-tahoe 77f62a1cd5 quick hacks to make install-details.html viewable as html 2008-01-04 17:34:15 -07:00
Zooko O'Whielacronx 49a9fddb1d new licences, move details from README to doc/install-details.html 2008-01-04 12:27:42 -07:00
Zooko O'Whielacronx 6a86000c06 doc: even simpler running.html 2008-01-03 21:11:59 -07:00
Zooko O'Whielacronx 5995d11a3c remove automatic private dir
* rename my_private_dir.cap to root_dir.cap
 * move it into the private subdir
 * change the cmdline argument "--root-uri=[private]" to "--dir-uri=[root]"
2008-01-03 17:02:05 -07:00
Brian Warner 02202c76fe docs/Makefile: rules to turn our SVG images into .png and .eps forms 2008-01-02 17:00:22 -07:00
Brian Warner 7ef1b7606f running.html: fix usage of 'tahoe create-client' and 'tahoe start', explain ~/.tahoe, add closing tags 2008-01-01 21:50:46 -07:00
Zooko O'Whielacronx 5e9f226826 docs: update install.html and update and format running.html 2008-01-01 17:20:07 -07:00
Zooko O'Whielacronx e923bb9fb1 docs: a couple of improvements to install.html 2008-01-01 01:52:50 -07:00
Zooko O'Whielacronx ca116f373d docs: even further simplify and reformat install.html 2007-12-31 08:39:07 -07:00
Zooko O'Whielacronx 1bc6b7f2b0 docs: format install.html into HTML format 2007-12-30 20:01:18 -07:00
Zooko O'Whielacronx 0eb31774d1 docs: a bunch of updates to simplify the process of installing from source and running Tahoe
These changes are a work-in-progress -- there are many incomplete and incorrect parts, but the install.html and running.html files 
are complete and should work (and they are delightfully concise!).  I'm pushing this just to let people see incremental progress 
and to solicit feedback.  "Testing out" the install.html and running.html files and submitting patches or bug reports would be 
quite welcome.

More to come.
2007-12-30 05:47:17 -07:00
Brian Warner 8b9f86fb17 remove the slash-to-bang conversion from CLI tools and webapi.txt 2007-12-17 20:22:26 -07:00
Zooko O'Whielacronx ea43753386 fix unit tests to assert that we do *not* link to start.html when there is no private dir, instead of asserting that we *do* 2007-12-17 18:51:16 -07:00
Brian Warner 785f21b9bf test_web.py: add coverage for POST t=check 2007-12-04 23:49:38 -07:00
Brian Warner 56e02b274b webish: add POST t=mutable, make it replace files in-place, add t=overwrite 2007-12-04 23:42:54 -07:00
Brian Warner 0bf5a762a9 use AES from pycryptopp instead of pycrypto, also truncate the keys slightly differently 2007-12-03 17:27:46 -07:00
Brian Warner 30b7d8fd40 docs/subtree1.svg: make the page smaller 2007-11-13 13:54:51 -07:00
Zooko O'Whielacronx 59d6c3c822 decentralized directories: integration and testing
* use new decentralized directories everywhere instead of old centralized directories
 * provide UI to them through the web server
 * provide UI to them through the CLI
 * update unit tests to simulate decentralized mutable directories in order to test other components that rely on them
 * remove the notion of a "vdrive server" and a client thereof
 * remove the notion of a "public vdrive", which was a directory that was centrally published/subscribed automatically by the tahoe node (you can accomplish this manually by making a directory and posting the URL to it on your web site, for example)
 * add a notion of "wait_for_numpeers" when you need to publish data to peers, which is how many peers should be attached before you start.  The default is 1.
 * add __repr__ for filesystem nodes (note: these reprs contain a few bits of the secret key!)
 * fix a few bugs where we used to equate "mutable" with "not read-only".  Nowadays all directories are mutable, but some might be read-only (to you).
 * fix a few bugs where code wasn't aware of the new general-purpose metadata dict the comes with each filesystem edge
 * sundry fixes to unit tests to adjust to the new directories, e.g. don't assume that every share on disk belongs to a chk file.
2007-12-03 14:52:42 -07:00
Brian Warner 9de9346a66 docs/webapi.txt: document the POST t=upload&mutable=on command used to create mutable files 2007-11-09 04:05:07 -07:00
Brian Warner e7ad7f8791 mutable: grab encprivkey when necessary during publish, fix test_mutable 2007-11-08 02:46:27 -07:00
Brian Warner c4ae0efcd6 docs/configuration.txt: expand the 'sizelimit' docs 2007-11-08 02:08:42 -07:00
the real nejucomo 4589d73e02 Add "sizelimit" to configuration doc. 2007-11-05 01:46:42 -07:00
Brian Warner c4f7412f1c stabilize on 20-byte nodeids everywhere, printed with foolscap's base32 2007-11-06 18:49:59 -07:00
Brian Warner 2ed394e471 mutable: move IV into signed prefix, add more retrieval code 2007-11-06 15:04:46 -07:00
Brian Warner 70bd92f24d mutable.txt: need offset of EOF too 2007-11-02 22:28:07 -07:00
Brian Warner 49cc32d012 mutable.txt: more notes 2007-11-02 20:53:41 -07:00
Brian Warner d777283e9e implement preliminary log publisher/gatherer
This creates a Referenceable object that will eventually be able to publish
log events to a remote subscriber (at present all it can do is provide
version information). The FURL for this logport is written to 'logport.furl'.

In addition, if a file named 'log_gatherer.furl' is present, the given target
will be contacted and offered access to the logport. This can be used by a
centralized logging agent to subscribe to logs, e.g. from all the nodes in a
centrally-maintained storage grid. (think syslog -r, but with all the
security properties of FURLs, and permitting non-printable strings and
structured data).

Once this framework matures a bit, it will be moved into Foolscap.
2007-11-01 17:29:15 -07:00
Brian Warner 715a3268cd docs/mutable.txt: put fingerprint in read-write URI too, it makes everything easier 2007-10-31 16:30:15 -07:00
Brian Warner ebc44c3fcb mutable.txt: we're now sort of ready to handle lease-migration 2007-10-31 00:04:08 -07:00
Brian Warner 75b7df7e29 mutable.txt: more updates: record offset of extra lease count instead of the actual extra leases 2007-10-30 19:46:58 -07:00
Brian Warner 9b92bff51c docs/mutable.txt: add IV, define a place for it in the data structure 2007-10-29 19:51:12 -07:00
Brian Warner 64f7183157 docs/mutable.txt: we need readkey IV 2007-10-29 18:14:51 -07:00
Brian Warner 5d48193647 mutable.txt: use merkle trees on blocks, since it probably won't be that hard (the code is all being copied from the CHK classes anyways), and that keeps the storage format identical to the MDMF case, for better forward-compatibility 2007-10-26 16:25:01 -07:00
Brian Warner 63c2629740 mutable.txt: fix everybody-gets-read bug, define WE-update protocol, add accepting-nodeid to leases to allow updating lease tokens 2007-10-26 16:15:50 -07:00
Brian Warner c4d2a5faa2 docs: add writeup of our mutable-file plans 2007-10-26 02:26:56 -07:00
Zooko O'Whielacronx 61d5899d66 update docs about webport (fixes #185) 2007-10-22 17:50:52 -07:00
Zooko O'Whielacronx 426721f3f2 update a few documents, comments, and defaults to mention 3-of-10 instead of 25-of-100 2007-10-15 19:53:59 -07:00
Zooko O'Whielacronx 0455c13082 webapi.txt: update webapi.txt to reflect the security fix from #98 2007-10-15 12:29:02 -07:00
Zooko O'Whielacronx d1f2c99c51 change another example to use port 8123 2007-10-11 16:12:13 -07:00
Brian Warner 002472587e add public testnet .furls to docs/testnet/, and copy into .deb . Closes #157. 2007-10-11 14:55:23 -07:00
Brian Warner c35ed6ff11 docs/webapi.txt: mention that we default to a --webport of 8123 2007-10-11 13:19:11 -07:00
Brian Warner 6bbc5fcbb4 docs: change our default HTTP port to 8123 2007-10-11 13:17:33 -07:00
Brian Warner dc573554c8 rename bin/allmydata-tahoe to bin/tahoe. Closes #155. 2007-10-11 03:38:24 -07:00
Brian Warner 2da65f118c webapi.txt: reinstate documentation of the unpleasant URI-escaping needed for
slashes in dirnode URIs, to be resolved some day by #102.
2007-10-11 06:58:08 -07:00
Brian Warner 173cf1676e docs/CHK-hashes.svg: preliminary copy of a whiteboard drawing, showing hash relationships in a CHK file 2007-09-24 18:12:04 -07:00
Zooko O'Whielacronx f5518eca92 a few edits to architecture.txt and related docs 2007-09-21 14:12:26 -07:00
Zooko O'Whielacronx ca5883b09b architecture.txt: a few small edits 2007-09-19 14:27:04 -07:00
Brian Warner 64d17c4532 docs: remove subtree{2,3,4}.svg, since they no longer reflect reality 2007-09-19 00:44:52 -07:00
Brian Warner 77d973471b architecture.txt: update to include tahoe2, dirnodes, leases 2007-09-17 18:24:48 -07:00
Brian Warner b7703df6a5 remove PyCrypto, copy AES/SHA256/Util.number into the allmydata/ tree 2007-08-14 13:57:41 -07:00
Zooko O'Whielacronx 9b4a0ffa30 webapi.txt: minor edits 2007-08-23 13:09:44 -07:00
Zooko O'Whielacronx 75b10954e4 webapi.txt edits (thanks to Brian Warner) 2007-08-23 13:06:06 -07:00
Zooko O'Whielacronx 2b77a70920 new improved webapi.txt
As per ticket #118, this refactors the explanation of URIs and paths and changes the JSON metadata schema.

http://allmydata.org/trac/tahoe/ticket/118
2007-08-23 13:03:26 -07:00
Zooko O'Whielacronx 6c38118c36 webapi.txt: s/dirnodes/directories/ 2007-08-16 15:53:53 -07:00
Brian Warner 944ad6508b webapi.txt: specify replace= behavior on all PUT and POST commands 2007-08-15 19:31:49 -07:00
Brian Warner 31bfb3950a webapi.txt: clear up underspecified items, replace 'webpassword' paragraph
with a section about our expected plans for #98, add more introductory text
to the sections on manipulate-file vs manipulate-directory.
2007-08-15 19:04:47 -07:00
Zooko O'Whielacronx 4f2244bfdd webapi.txt: shorter and hopefully clearer description of names vs. identifiers
Brian (and anyone who has an interest in the API and documentation): please review.
2007-08-15 12:28:04 -07:00
Brian Warner e6195caff1 docs/configuration.txt: explain the files in the node's basedir, which ones are useful to modify, etc 2007-08-13 13:28:40 -07:00
Brian Warner b4a0effe30 webapi.txt: separate out debug/test commands, indicate that localfile=/localdir= requires special activation 2007-08-10 18:20:22 -07:00
Brian Warner 54b6900526 webapi.txt: minor clarifications and examples 2007-08-10 15:52:27 -07:00
Zooko O'Whielacronx c0c6417e95 webapi.txt: put back the manifest feature
So that we can compare versions of webapi.txt with and without this documentation, side by side.
2007-08-10 12:58:33 -07:00
Zooko O'Whielacronx ba2e9aa4cb webapi.txt: put back the localfile feature
So that we can compare versions webapi.txt with and without this documentation side by side.
2007-08-10 12:52:37 -07:00
Zooko O'Whielacronx 193f603e74 webapi.txt: add URI-based GET variants 2007-08-10 12:33:29 -07:00
Zooko O'Whielacronx 89d2e1ac57 webapi.txt: some editing, and remove the localfile feature and the manifest feature
My motivation to remove these features is as per:

http://allmydata.org/pipermail/tahoe-dev/2007-August/000067.html

However, I haven't heard back from Brian yet, so I'm actually going to put them back in the next patch so that I can compare the two versions of webapi.txt side by side.
2007-08-10 12:24:13 -07:00
Zooko O'Whielacronx 887240e7a3 webapi.txt: further refactoring and add a section explaining TOCTTOU bugs and how to avoid them by using URIs 2007-08-10 12:04:30 -07:00
Zooko O'Whielacronx e68a0e07de webapi.txt: further refactoring and editing to clarify the fact that you don't know whether a thing is a file or a directory before you fetch it 2007-08-10 10:19:27 -07:00
Zooko O'Whielacronx 8b0807812b webapi.txt: add "?t=file" flag and reorganize doc to discourage people from thinking that they know before hand the file-or-dir type of the thing that they are naming 2007-08-10 09:43:52 -07:00
Brian Warner 1bb44df8ba webapi.txt: update rfc reference 2007-08-09 11:24:35 -07:00
wilcoxjg e274f4350c in --> across 2007-08-08 21:17:54 -07:00
wilcoxjg 1cc2040d18 cleaning grammar 2007-08-08 21:11:54 -07:00
Zooko O'Whielacronx fedab34f83 architecture.txt: small edits 2007-08-08 22:31:05 -07:00
Brian Warner a45bb727d9 update architecture.txt a little bit 2007-07-22 20:30:05 -07:00
Brian Warner 9c5ab89afe truncate storage index to 128 bits, since it's derived from a 128 bit AES key 2007-07-22 19:48:44 -07:00
Brian Warner 81a9904455 CHK: remove the storage index from the URI, deriving it from the key instead 2007-07-21 18:23:15 -07:00
Brian Warner 9cac3261a7 docs/uri.txt: document current URI formats 2007-07-21 17:29:01 -07:00
Brian Warner f207f4a199 webish.py: disallow slashes in POSTed filenames. Closes #75. 2007-07-16 11:53:12 -07:00
robk-org d65d02fa58 add a 'rename' button to the webish dir view
alongside the 'del' button is now presented a 'rename' button, which takes
the user to a new page, the 't=rename-form' page, which asks ther user for
the new name of the child and ultimately submits a POST request to the dir
for 't=rename' to perform the actual rename i.e. an attach followed by a
delete of children.
2007-07-12 16:53:54 -07:00
robk-org 908cc0e481 fix a typo in webapi.txt 2007-07-12 16:45:51 -07:00
Brian Warner 13e84526a1 webapi: normalized API: use t=upload or t=download when providing localdir= or localfile= 2007-07-10 13:24:10 -07:00
Brian Warner 723825ff28 webapi.txt: note that the 'curl' utility can be used to exercise most of this interface 2007-07-10 10:36:37 -07:00
Brian Warner 72fc8c5cb8 web: use real JSON instead of the fake stubs
Also include the encoder portion of Bob Ippolito's simplejson-1.7.1 as
allmydata.util.json_encoder . simplejson is distributed under a more liberal
license than Tahoe (looks to be modified BSD), so redistributing it should be ok.
2007-07-08 00:17:11 -07:00
Brian Warner bd8625076a web: remove t=XML, and other dead code 2007-07-07 22:55:15 -07:00
Brian Warner 62e8528cc6 web: /uri/ must escape slashes, we use bangs for this 2007-07-07 22:06:52 -07:00
Brian Warner 464f25e5f2 web: more test work, now all tests pass, POST too, only XMLRPC left to implement 2007-07-07 20:06:58 -07:00
Brian Warner 7d92b8a123 webish.py: add links to JSON/etc representations of directory contents to the listing 2007-07-07 11:31:07 -07:00
Brian Warner 9dc9f59a86 webapi updates 2007-07-07 10:37:07 -07:00
Brian Warner c15f37dc9b add webapi.txt: explain our plans for the node's webserver 2007-07-05 13:36:03 -07:00
Brian Warner 92e57f50c1 dirnodes.txt: minor edits 2007-07-03 13:16:48 -07:00
Brian Warner 8a4c174ce9 document our current directory node (dirnode) design 2007-07-02 17:32:24 -07:00
Brian Warner b06c74c2a1 Add the 'vdrive' service, for clients to access the public/private root dirs.
These allow client-side code to conveniently retrieve the IDirectoryNode
instances for both the global shared public root directory, and the per-user
private root directory.
2007-06-27 17:11:06 -07:00
Brian Warner 466083700f URI-extension.txt: update docs, we aren't using bencode for this. 2007-06-11 17:02:50 -07:00
Brian Warner 956d5ae256 rename fileid/verifierid to plaintext_hash/crypttext_hash 2007-06-09 20:46:04 -07:00
Brian Warner dac76b508c thingA.txt has finally been renamed 2007-06-09 20:32:34 -07:00
Brian Warner 5abc034378 update thingA/uri-extension docs 2007-06-09 20:31:48 -07:00
Brian Warner 243300f843 docs/thingA.txt: describe what this does, even if it doesn't yet have a name 2007-06-07 21:50:58 -07:00
Zooko O'Whielacronx 3872e94da2 rename all "*PBURL*" to "*FURL*"
This breaks backwards compatibility with Tahoe v0.2 -- the first public release of Tahoe.
2007-05-22 14:08:30 -07:00
Zooko O'Whielacronx 22bd668948 mention ticket #22 2007-05-01 20:33:22 -07:00
Zooko O'Whielacronx e0a18d12af globally search and replace "mesh" with "grid" and adjust description of the effect of NAT on the topology 2007-04-30 13:06:09 -07:00
Zooko O'Whielacronx d19d1058e0 extirpate all references the "queen" and "metatracker"
This is a potentially disruptive and potentially ugly change to the code base,
because I renamed the object that serves in both roles from "Queen" to
"IntroducerAndVdrive", which is a bit of an ugly name.

However, I think that clarity is important enough in this release to make this
change.  All unit tests pass.  I'm now darcs recording this patch in order to
pull it to other machines for more testing.
2007-04-30 09:57:52 -07:00
Brian Warner 36fa95372a docs: update some of the terminology 2007-04-23 19:11:48 -07:00
Brian Warner 9048936719 docs: add a bunch of .svg pictures 2007-04-23 18:25:26 -07:00
Brian Warner 50e1313156 more architecture docs, this is fun 2007-04-20 01:14:29 -07:00
Brian Warner 159a3fc678 add architecture/code-layout documents describing our current architecture and a bit of our future plans 2007-04-19 23:43:47 -07:00
Brian Warner 09aedcac7b add the 'Denver Airport' design doc, for Chord-based peer selection 2006-12-01 19:09:14 -07:00