Commit Graph

273 Commits

Author SHA1 Message Date
Zooko O'Whielacronx
7a5fc8ef8a docs: lowercase "introducer"
He's not that important.
2008-06-10 19:23:14 -07:00
Zooko O'Whielacronx
991bda19c9 docs: edits to [source:docs/install.html] and [source:docs/running.html] 2008-06-10 19:22:00 -07:00
Zooko O'Whielacronx
d3e3285eb8 docs: explain better how to invoke the tahoe executable when creating and starting nodes 2008-06-10 19:19:23 -07:00
Zooko O'Whielacronx
06ce373e26 docs: update install.html to reflect Justin's user test 2008-06-10 19:04:58 -07:00
Zooko O'Whielacronx
56d6c5798f docs: reformat for 70 columns plus a few small edits 2008-06-10 16:37:25 -07:00
Zooko O'Whielacronx
24a2b921e0 docs: explain exactly what false alarms are caused in the unit tests by Twisted v8 and pyOpenSSL v0.7 2008-06-10 16:31:26 -07:00
Zooko O'Whielacronx
0f182751a5 docs: [source:docs/known_issues.txt] 2008-06-10 16:24:25 -07:00
Zooko O'Whielacronx
ff298182aa doc: mention that "Mac Developer Tools" is the way to get gcc/g++ for Mac 2008-06-10 16:19:34 -07:00
Zooko O'Whielacronx
970edc5c65 setup and docs: various improvements to setup and docs
Remove docs/install-details.html and README.win32 for now (see #282).
Remove checks for pywin32 and pyopenssl in Makefile -- that is (or will be) automated by setuptools.
Remove twisted from setup_requires.  This causes the problem in which Nevow doesn't declare its dependency on Twisted (#440) to yield a clear ImportError mentioning Twisted and to fail repeatedly, rather than yielding a weird ImportError and working on the second identical attempt.
Fix Makefile to set PATH so that trial and twistd can be found by "make test" after Twisted was installed into support/ during "make"
2008-06-05 13:55:05 -07:00
Brian Warner
699d912d80 docs/configuration.txt: explain the current limitations of readonly_storage 2008-06-03 17:47:08 -07:00
Brian Warner
91565f465d docs: move files that are about future plans into docs/proposed/, to clearly separate them from descriptions of the present codebase 2008-06-02 23:07:02 -07:00
Brian Warner
01469433ef docs: update webapi.txt with write-coordination issues, add TODO note to recovery section of mutable.txt 2008-06-02 23:03:21 -07:00
Brian Warner
f9fe63fd7a docs/file-encoding.txt: move this over from the wiki 2008-06-02 19:58:27 -07:00
Brian Warner
e0fd3d8fe1 docs/file-encoding: update some of the stale diagrams to reflect current code 2008-06-02 19:21:39 -07:00
Brian Warner
2443ffe305 docs/historical: move 'tahoe2' from wiki into source tree 2008-06-02 18:43:31 -07:00
Brian Warner
aa2c693764 move historical docs from wiki pages into the source tree, clearly marked as historical 2008-06-02 18:38:32 -07:00
Brian Warner
313876263d docs/using.html: update CLI section to reflect the new alias: scheme. Closes #431 2008-06-02 18:00:16 -07:00
Brian Warner
3e8d58767f CLI: improve docs w.r.t. aliases, add examples to 'tahoe put' and 'tahoe get' help output. Addresses part of #431 2008-06-02 17:54:56 -07:00
Brian Warner
c83d8b7a6d architecture.txt: explain the introducer SPOF and why it really isn't that bad. Closes #323. 2008-05-29 18:51:11 -07:00
Brian Warner
72d8905c71 docs/backupdb.txt: preliminary sketch of our plans for the duplicate-upload-avoidance database 2008-05-28 16:20:13 -07:00
Brian Warner
3ac4a734e5 web t=json: add 'mutable' key to the information dict 2008-05-20 15:40:49 -07:00
Brian Warner
1d8e452184 CLI: add 'list-aliases', factor out get_aliases 2008-05-20 14:36:04 -07:00
Brian Warner
8e92dfcb50 overhaul CLI: not quite complete but it works a lot better than it used to. The new scheme uses 'tahoe add-alias' and rsync/scp-style 'alias:foo/bar.txt' arguments 2008-05-19 19:28:50 -07:00
Brian Warner
151f69d9b5 webapi.txt: overhaul documentation. API changes are as follows:
* download/upload localdir=/localfile= has been removed. This sort of ambient
   authority was unsafe to expose over the web (CSRF), and at some point
   soon we'll have 'cp -r' in the CLI to replace it.
 * GET save=filename -> GET filename=filename&save=true
 * GET t=download removed
 * side-effect causing operations now use POST where appropriate, not PUT
 * to create multiple directories, either use
   * POST /uri/DIRCAP/parent?t=mkdir&name=child  (more form/browser oriented)
   * POST /uri/DIRCAP/parent/child?t=mkdir (more machine oriented)
   The t=mkdir-p form is still accepted, but not preferred (since it leaks
   the child name queryarg into the logs)
 * use PUT /uri/MUTABLEFILECAP or PUT /uri/DIRCAP/child (on a mutable file) to
   replace its contents, or POST /same?t=upload from forms
 * response bodies and codes are better specified than before
2008-05-19 12:47:46 -07:00
Brian Warner
0838f76e0f CLI.txt: document proposed scp:-based CLI syntax 2008-05-09 18:06:29 -07:00
Brian Warner
e2af2decdc docs/CLI.txt: provide an overview of bin/tahoe subcommands 2008-05-09 12:36:19 -07:00
Brian Warner
fabdc28c06 deep-stats: add file-size histogram 2008-05-08 16:19:42 -07:00
Brian Warner
6c00a70dbc dirnode: add a deep_stats(), like deep-size but with more information. webish adds t=deeps-size too. 2008-05-08 13:21:14 -07:00
Brian Warner
e2f56b8e3c configuration.txt: describe helper config 2008-05-06 15:59:06 -07:00
Zooko O'Whielacronx
a01864c713 docs: shorter running.html 2008-05-06 15:29:04 -07:00
Brian Warner
783fbb12e6 docs/helper.txt: explain more about the helper 2008-05-06 13:49:01 -07:00
Zooko O'Whielacronx
0432f5dee6 docs: mention configuration, suggested by ben hyde's question about storage servers 2008-05-06 13:39:35 -07:00
Zooko O'Whielacronx
8a0deaf53f docs: edit to install.html suggested by Brian 2008-05-06 12:31:15 -07:00
Zooko O'Whielacronx
2f3a44f820 docs: remove the redundant (and therefore bit-rotting) parts of mutable-DSA.txt and instead refer to mutable.txt 2008-04-29 15:51:58 -07:00
Zooko O'Whielacronx
c2621313bb setup: pyOpenSSL is now easy_installable, and pycryptopp now includes Crypto++, so we can remove those two from the Manual Dependencies 2008-04-24 10:29:17 -07:00
Zooko O'Whielacronx
60eb3505f5 docs: tiny update to webapi.txt
I'm actually committing this just to test our patch management infrastructure.
2008-04-17 21:09:12 -07:00
Zooko O'Whielacronx
9b4a213824 docs: tiny change in webapi.txt
(I'm actually committing this patch only in order to test our patch management infrastructure.)
2008-04-17 21:00:51 -07:00
Zooko O'Whielacronx
3d4a339857 docs: merge conflicts between the patch to document "127.0.0.1" instead of "localhost" and some other patches (precisely which, I don't know) 2008-04-17 20:57:41 -07:00
Zooko O'Whielacronx
7b2ca46b35 docs: use "127.0.0.1" instead of "localhost"
Unfortunately there are occasionally configurations in the real world where "localhost" does not resolve to 127.0.0.1, and if a user has such a configuration then using 'localhost' could lead to an authority leak.
2008-04-17 20:45:34 -07:00
Brian Warner
1b4b4cbd4a mutable WIP: rename NotEnoughPeersError to NotEnoughSharesError 2008-04-15 16:08:32 -07:00
Zooko O'Whielacronx
fe54dd114c docs: yay! We can remove Twisted from the list of "Manual Dependencies" that users have to be aware of when installing 2008-04-10 18:44:07 -07:00
Zooko O'Whielacronx
d10c23bcd4 docs: another small edit (don't mention docs/ directory in about.html now that docs/ is prominent on wiki:Docs) 2008-04-09 16:02:45 -07:00
Zooko O'Whielacronx
81240eeff7 docs: a couple of tiny docs updates 2008-04-09 15:57:59 -07:00
Zooko O'Whielacronx
8783eabf5a don't do a du on startup if there is no size limit configured
This also turns off the production of the "space measurement done" log message, if there is no size limit configured.
2008-04-08 11:36:56 -07:00
Zooko O'Whielacronx
eb4a7b5b0c docs: fix anchor text of hyperlink to tarball 2008-03-27 19:01:29 -07:00
Brian Warner
9b3a32d0b3 add GET /uri/URI/?t=deep-size, to compute the total size of immutable files reachable from a given directory 2008-03-27 11:33:42 -07:00
Zooko O'Whielacronx
f91d937925 docs: link to the 1.0.0 tarball in docs/install.html 2008-03-25 20:22:29 -07:00
Zooko O'Whielacronx
29b844efaf docs: document the private/convergence configuration file 2008-03-25 11:22:41 -07:00
Brian Warner
f17b9839ec docs: add some accounting proposals 2008-03-20 12:18:41 -07:00
Zooko O'Whielacronx
4e505d9a87 docs: link from install.html to the (imminent) location of allmydata-tahoe-0.9.0.tar.gz 2008-03-13 13:02:37 -07:00
Brian Warner
2ef70ab814 mutable.py: split replace() into update() and overwrite(). Addresses #328. 2008-03-12 18:00:43 -07:00
Brian Warner
1ddeb88e9b architecture.txt: make it clear that accounting/leases are not yet implemented 2008-03-10 12:25:19 -07:00
Zooko O'Whielacronx
1f7931e596 docs: trivial edit 2008-03-06 18:32:30 -07:00
Zooko O'Whielacronx
d5886bed2f doc: tiny change about status of mutable.txt 2008-03-06 15:02:15 -07:00
Brian Warner
456b437608 docs/mutable: describe deep-verify-cap scheme, update picture 2008-03-05 16:54:26 -07:00
Zooko O'Whielacronx
5cdc678d24 docs: fix example JSON in webapi.txt to be legal JSON. ;-) 2008-02-29 18:39:25 -07:00
Zooko O'Whielacronx
1934ae26f9 doc: change example filename extension back because it is more recognizable and because I love Brian 2008-02-27 14:54:05 -07:00
Zooko O'Whielacronx
0097d662c7 docs: tweak wording per kpreid and tweak example filename extension per me 2008-02-27 14:41:57 -07:00
Zooko O'Whielacronx
fed427b087 docs: clarify which webport value is the default 2008-02-27 11:10:03 -07:00
Zooko O'Whielacronx
28aab75555 docs: about.html: a couple of edits suggested by kpreid's comments 2008-02-27 09:01:38 -07:00
Zooko O'Whielacronx
f75c17ed29 docs: change example capability 2008-02-19 15:34:19 -07:00
Zooko O'Whielacronx
fc0d637523 docs: update install and usage docs, improve cli "usage" output, make new example directories, add unit test that fails code which prints out sentences that don't end with punctuation marks 2008-02-15 13:11:02 -07:00
Zooko O'Whielacronx
294cb071a3 docs: edit running.html 2008-02-15 11:02:19 -07:00
Brian Warner
92640dc6e5 docs/uri.txt: update to reflect mutable files 2008-02-14 17:59:29 -07:00
Brian Warner
7927495cbe unicode handling: declare dirnodes to contain unicode child names, update webish to match 2008-02-14 15:45:56 -07:00
Brian Warner
1a32aaaa33 more minor architecture.txt changes 2008-02-13 20:20:43 -07:00
Brian Warner
28611d1f90 architecture.txt: fix some things that have changed a lot in recent releases 2008-02-13 20:14:29 -07:00
Brian Warner
269d4bcded docs/dirnodes.txt: add notes on dirnode sizes 2008-02-13 17:40:45 -07:00
Brian Warner
1f6855ede8 mutable.txt: fix offset math in the SDMF layout 2008-02-13 17:39:06 -07:00
Zooko O'Whielacronx
481f3649ec docs: link straight to the release tar.gz in install.html 2008-02-14 11:54:14 -07:00
Zooko O'Whielacronx
73c148a725 docs: update relnotes, running.html 2008-02-14 08:54:34 -07:00
Zooko O'Whielacronx
b9841d09a2 docs: beginning of update to relnotes.txt for v0.8 2008-02-13 17:43:02 -07:00
amber
0a01fd405b docs: 10 blocks by default, not 12 2008-02-13 04:57:19 -07:00
Zooko O'Whielacronx
e400c5a8fb docs: edits and updates to architecture.txt, with Amber 2008-02-13 10:24:52 -07:00
Brian Warner
a7867aeea2 introducer: remove encoding-parameter config, for now 2008-02-12 18:59:54 -07:00
Brian Warner
a70fba4ef1 webish: add edge metadata to t=json output, including timestamps 2008-02-11 19:14:10 -07:00
Brian Warner
18817c00a3 docs/install-details.html: wrap to 80 cols, no content changes 2008-02-07 21:50:04 -07:00
Brian Warner
fc690a70be dirnodes.txt: update docs a bit, we don't yet do choose-latest-version, just choose-any-version 2008-02-07 20:14:05 -07:00
Brian Warner
7dcb4ee62b webapi.txt: document POST /uri?t=mkdir 2008-02-07 20:10:28 -07:00
Brian Warner
6e0d3059a3 webish: add when_done= to POST /uri?t=upload . I did not add a 'recent uploads' section to the welcome page, but I think the new upload-results page provides the desired data 2008-02-06 02:38:16 -07:00
Brian Warner
1e4504463c webish: make POST /uri?t=upload deposit you on an 'Upload Results' page 2008-02-05 23:01:37 -07:00
Brian Warner
23c2c8d660 webish: add PUT /uri?mutable=true 2008-02-05 22:18:02 -07:00
Brian Warner
e5dc9a8486 webish: add POST /uri?t=upload&mutable=true 2008-02-05 22:10:22 -07:00
Brian Warner
6afe50e2aa webish: add upload/view-uri forms (not associated with any particular directory) to the welcome page. Document POST /uri?t=upload . 2008-02-05 21:44:40 -07:00
Brian Warner
dff7671ff9 docs/testgrid/introducer.furl: update to new introducer 2008-02-05 18:48:26 -07:00
Brian Warner
78e26b0879 docs/configuration.txt: wrap to 80 cols 2008-02-05 14:35:12 -07:00
Brian Warner
d35b2f304f docs/configuration.txt: document nickname, no_storage, readonly_storage 2008-02-05 14:33:29 -07:00
nejucomo
7caec120b3 docs: webapi: Add concise shorthand for options, input, output, and statuses to the operation descriptions...
I'm not convinced if this is the best way to do this, but I find it
handy to have a conscise "quick reference" for the webapi operations
which summarize all related I/O.

Another possibility is to reject this patch, but create a separate
"webapi_quickref.html" with a concise table.
2008-01-30 01:27:42 -07:00
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