Brian Warner
42c3f09097
release checklist: remember buildbot problem
2016-12-17 14:35:53 -08:00
Brian Warner
b97d23cbfe
docs/anonymity-config: mention debian-tor group
2016-12-17 14:35:28 -08:00
Brian Warner
91047bf828
docs: clean up .rst and references
...
This uses Read-The-Docs (sphinx/docutils) references exclusively, but adds a
README.md for GitHub viewers to remind them that the links there won't
work (closes ticket:2835).
It also fixes all the dangling references and other Sphinx warnings.
The "Preparation" section of docs/magic-folder-howto.rst was removed, since
this feature has since been merged to trunk.
2016-12-12 13:57:28 -08:00
Brian Warner
9cea1d7a46
docs: fix svg encoding diagrams
...
We said "share N" in some places that ought to say "block N", and we no
longer use "peer" to describe where we're pushing a share to (now we say
"server").
Thanks to CcxWrk for the catch.
2016-11-13 14:12:51 -08:00
Brian Warner
fa2b6a567b
expenses: pay 2016 summit and hosting through Oct-2016
2016-11-10 22:20:00 -08:00
Brian Warner
da76c41c83
donation.rst: add new expense addresses, re-sign
...
* secorp's new address for hosting expenses
* warner's address for summit expenses
2016-11-10 21:16:34 -08:00
Brian Warner
09d4e1e936
minor typo
2016-10-25 18:27:11 -07:00
meejah
e00301d7e0
mention poll_interval in magic-folder docs
2016-10-25 18:26:57 -07:00
Brian Warner
130031badf
docs: update out-of-date happiness milestone
...
thanks to CcxWrk for the catch
2016-10-18 17:30:52 -07:00
Brian Warner
42c6a1587b
remove docs about --listen=tor being unfinished
2016-10-09 02:02:40 -04:00
David Stainton
4d30d698cf
Minor correction to ipv6 + ipv4 configuration considerations
2016-09-26 13:31:18 -07:00
equim
f941db60ac
Fix typos in garbage-collection.rst
2016-09-24 23:05:09 +01:00
Brian Warner
b00c2d21b7
test tub.port with multiple endpoints, add docs
...
I think the preferred way to listen on both IPv4 and IPv6 will be to use
"--port=tcp:PORT,tcp6:PORT". This is now reflected in the docs.
refs ticket:867
2016-09-20 13:04:06 -07:00
David Stainton
ff9d3d8922
Reverse order of use-case list in anonymity config doc
2016-09-20 09:29:07 -07:00
Brian Warner
a638a97806
implement connections:tcp=disabled
...
This enables an I2P-only node, which disables TCP entirely (instead of
mapping TCP to Tor, which was the only other option that
reveal-IP-address=False would allow).
closes ticket:2824
2016-09-14 16:27:12 -07:00
Brian Warner
02ba2a05c3
implement --listen=none, use it for create-client
...
Improve docs on server configuration to explain --listen options.
2016-09-14 16:12:32 -07:00
Brian Warner
d69757e069
docs: more server/introducer setup text
...
running.rst: split out the server/introducer text, so someone who only
care about running a client doesn't need to read about hostnames or
--port/--location.
servers.rst: more background text on ports and locations, make section
names less storage-centric
2016-09-14 13:10:29 -07:00
Brian Warner
460cc826fd
update docs
...
* replace sample IPv4/IPv6 addresses with reserved ones from RFC-6890
* remove initial blank line: prevents github from rendering the .rst
* emphasize --hostname, then have --port/--location as a special-case
* list --port first (describe it "from the inside out"), then --location
* explain difference between --port and --location
* in endpoint strings, put interface= at end, to emphasize port
* add servers.rst to index.rst so it'll show up on readthedocs
* don't mention "partial-cone NAT": that's only relevant if/when we get
real ICE-style NAT-hole-punching
2016-09-14 12:45:53 -07:00
David Stainton
f3fafa2270
Add server-side network considerations to servers.rst
...
This includes configuring servers to use IPv4, IPv6, IPv6 with
port forwarding firewall and suggesting the use of i2p/tor if
NAT penetration is needed: provided links to configuration and
anonymity-configuration
2016-09-14 10:58:45 -07:00
Brian Warner
80acd565e2
docs: describe known linkability
...
closes ticket:2384
2016-09-13 02:14:39 -07:00
Brian Warner
2e3ec4109c
document multiintroducer/introducerless config
...
refs ticket:68
2016-09-12 17:45:35 -07:00
Brian Warner
8d9afdc27e
CLI: remove 'debug trial', 'debug repl'
...
These are obsolete. Tests are run with 'tox', or by running 'trial
allmydata' from a populated virtualenv. A populated virtualenv is also
the right way to get a repl: just run 'python'.
refs ticket:2735
2016-09-09 15:37:28 -07:00
str4d
af6cb47390
Explain how to install the tor and i2p extras together
2016-09-03 12:05:08 +12:00
str4d
453574141e
Minor format fix
2016-09-03 11:59:18 +12:00
Brian Warner
c17217699e
docs: improve reveal-IP-address description
2016-09-02 09:18:47 -07:00
Brian Warner
d0da17adeb
create-node: add --hide-ip, update docs
...
So "tahoe create-node --hide-ip" causes "reveal-IP-address = false" to
get written into tahoe.cfg . This also changes the default tahoe.cfg to
include "reveal-IP-address = true", for clarity.
refs ticket:1010
2016-09-01 23:24:38 -07:00
Brian Warner
076b3895dc
config: change syntax of no-listen mode
...
We now use::
tub.port = disabled
tub.location = disabled
instead of using an empty value (but the key still being present, since
if the key is missing entirely, that means "be automatic").
closes ticket:2816
2016-09-01 21:26:48 -07:00
Brian Warner
a03f68b787
tahoe.cfg: fix spelling of 'enabled' for tor/i2p
...
We should use "enabled = true", instead of "enable = true", since
the rest of tahoe.cfg uses "enabled".
refs ticket:2788
2016-08-31 15:23:47 -07:00
Brian Warner
d47fc0fd27
config: add reveal-IP-address=False
...
This adds a safety flag named `[node] reveal-IP-address`, for which the
default value is True. When this is set to False, any configuration that
might reveal the node's IP address (to servers, or the external network)
will cause a PrivacyError to be raised at startup, terminating the node
before it gets a chance to betray the user's privacy. It also adds docs
and tests.
refs ticket:1010
2016-08-31 02:44:27 -07:00
Brian Warner
9057c7301c
incorporate dawuud's feedback
...
* remove anonymity-roadmap
* remove old torsocks section
* minor edits
2016-08-30 08:55:09 -07:00
Brian Warner
f54d2a81a8
fix TOC, remove empty "Legacy I2P" section
2016-08-30 08:55:09 -07:00
Brian Warner
327bef3383
update tor/i2p docs to match current config syntax
...
This removes the section that describes automatic configuration using
transport-agnostic endpoint-centric tub.port strings. That was the
approach where tub.port used "onion:80:hiddenServiceDir=PATH", and
Foolscap was able to query the generated Listener to find out what
address it was supposed to advertise. We considered this for a long
time, but in the end decided to use a more static approach, where
foolscap/tahoe never try to guess it's location: Tahoe always requires
tub.location= to be set.
When we get automatic configuration implemented, it'll be a simple CLI
argument, something like "tahoe create-server --listen=tor".
Instead, this document now explains how to configure Tor to create the
hidden service, then how to copy the generated .onion address into the
tahoe config.
This also removes a lot of other text that seems irrelevant now, and
refers the user to the tahoe.cfg docs (configuration.rst) instead of
including all the `[tor]`/`[i2p]` docs inline.
Closes ticket:2815
2016-08-30 08:55:09 -07:00
str4d
52e35852b1
Update connection config docs to match the current ticket:517 syntax
2016-08-30 08:55:09 -07:00
str4d
f075fa0e85
Remove references to closed tickets
2016-08-30 08:55:09 -07:00
str4d
21013284c9
Improved section on performance and security issues
2016-08-30 08:55:09 -07:00
str4d
24beb033d6
Update content to match current design
2016-08-30 08:55:09 -07:00
str4d
1edb6331c1
[node]anonymize -> [node]anonymous
2016-08-30 08:55:09 -07:00
str4d
3661fc72cf
Updated I2P content
2016-08-30 08:55:08 -07:00
str4d
aa8de0737c
ToC and headings
2016-08-30 08:55:08 -07:00
str4d
0fdae0b96a
Configuration details
2016-08-30 08:55:08 -07:00
str4d
d09173cbf7
Expanded explanation of [node]anonymize
2016-08-30 08:55:08 -07:00
str4d
8cc2307d80
Spelling, rST layout fixes
2016-08-30 08:55:08 -07:00
str4d
1a3f4f2f35
I2P information
2016-08-30 08:55:08 -07:00
Daira Hopwood
8d1fa17d70
Add more info to docs about usage with tor
2016-08-30 08:55:08 -07:00
David Stainton
cb44f883e5
Fix formatting
2016-08-30 08:55:08 -07:00
David Stainton
4f0b7e0f83
Removed I2P ticket info because it belongs in a trac ticket
2016-08-30 08:55:08 -07:00
Daira Hopwood
3126d49d32
Rename tor.rst to anonymity-configuration.rst.
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2016-08-30 08:55:08 -07:00
str4d
f3bc270a4e
Changes required for safe txi2p use
2016-08-30 08:55:08 -07:00
David Stainton
832a798374
Fix formatting
2016-08-30 08:55:08 -07:00
David Stainton
3242a67c3f
Add anonymity roadmap
2016-08-30 08:55:08 -07:00
David Stainton
ce889d5834
Change option name to anonymize for ticket #1010
2016-08-30 08:55:08 -07:00
Daira Hopwood
ed38d69302
Add more details in the Tor integration section
2016-08-30 08:55:08 -07:00
Daira Hopwood
92c908d332
Attempt to fix formating for torsocks section
2016-08-30 08:55:08 -07:00
David Stainton
2a82c2c63c
Add more Torsocks Tahoe Tor usage documentation
2016-08-30 08:55:08 -07:00
David Stainton
5859a17efc
Add legacy torsocks usage
2016-08-30 08:55:08 -07:00
David Stainton
9a6fe0edbd
Minor corrections of index and indention
2016-08-30 08:55:08 -07:00
David Stainton
856f4ce266
Articulated more configuration subtleties
2016-08-30 08:55:08 -07:00
David Stainton
39820821ce
Minor cleanup and added some links
2016-08-30 08:55:08 -07:00
David Stainton
02899f7e59
Add Tor usage and configuration documentation
...
Written by Zooko and I.
We need to add more technical citations and have it
reviewed for inaccuracies by Tor developers.
2016-08-30 08:55:08 -07:00
Brian Warner
fea8b627dd
if tub.port is empty, don't listen
...
Updated config docs. Added errors if we're not listening but were told
to enable storage, helper, or if we're the Introducer server.
closes ticket:2816
2016-08-29 22:28:55 -07:00
Brian Warner
2d8a1e865b
docs/config: use "#" to number sections
...
so I don't have to renumber everything when inserting/removing a
section.. wish I knew about this .rst trick earlier
2016-08-29 18:16:31 -07:00
Brian Warner
a099b9237d
tor: socks.port is now a (restricted) endpoint string
...
Foolscap has limitations that prevent us from accepting anything but a
TCP endpoint, but that will change in the future, so make the tahoe.cfg
syntax accept an endpoint, but then reject non-TCP ones. See the ticket
for details: refs ticket:2813.
This depends upon the new `foolscap.connections.tor.socks_port(host,
port)` API in foolscap-0.12.2, so it bumps the dependency to that (the
previous commit depended upon 0.12.1, but I hadn't gotten around to
updating the dep before now).
2016-08-28 16:30:31 -07:00
Brian Warner
2db38e0cf3
document tor/i2p/connections
2016-08-28 02:41:44 -07:00
Brian Warner
8cf53d2d12
derive permutation seed from pubkey/server_id
2016-08-27 13:08:18 -07:00
Brian Warner
859ce66a03
document private/servers.yaml (static servers)
2016-08-27 11:34:32 -07:00
Brian Warner
37f89b1346
docs: update sample tahoe.cfg
...
* tub.port should be an endpoint
* web.port should be a strports string (with "tcp:" prefix)
* tub.location should include "tcp:" hint types
* FURL hints should include "tcp:" hint types
2016-08-26 17:59:09 -07:00
Daira Hopwood
072d252245
Add multi-party-conflict-detection.rst.
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2016-07-21 12:35:59 -07:00
Daira Hopwood
a7c50b104e
Documentation for Magic Folder.
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2016-07-21 12:35:59 -07:00
Daira Hopwood
539cf9b378
Magic Folder docs: status of tests on Windows.
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2016-07-21 12:35:59 -07:00
Daira Hopwood
abb2d6f9a9
More Magic Folder doc updates.
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2016-07-21 12:35:59 -07:00
Daira Hopwood
1033c6f0c6
Magic Folder doc updates.
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2016-07-21 12:35:59 -07:00
meejah
2e93f3436d
fix the windows command-line too
2016-07-21 12:35:59 -07:00
meejah
8b2c54b518
some minor fixes for instructions
2016-07-21 12:35:59 -07:00
Daira Hopwood
d9acaf605d
Windows path fix.
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2016-07-21 12:35:59 -07:00
Daira Hopwood
b672dd50fd
magic-folder-howto.rst formatting fixes.
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2016-07-21 12:35:59 -07:00
Daira Hopwood
278d713dd5
Add docs/magic-folder-howto.rst.
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2016-07-21 12:35:59 -07:00
Daira Hopwood
815a50df71
magic-folder.rst: remove "Known Issues and Limitations" that have been fixed.
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2016-07-21 12:35:59 -07:00
Daira Hopwood
2f6ca5d3da
magic-folder.rst: update introduction.
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2016-07-21 12:35:59 -07:00
David Stainton
bc6fcc2901
Include brief summary of magic-folder CLI commands
2016-07-21 12:35:59 -07:00
David Stainton
09414bb379
Add link to our cli design doc
2016-07-21 12:35:59 -07:00
David Stainton
ddded9a026
Mention gc is not part of the otf grant and link to the gc ticket
2016-07-21 12:35:59 -07:00
David Stainton
97a1322378
Remove old obsolete/inaccurate statements
2016-07-21 12:35:59 -07:00
Daira Hopwood
1495d0f405
Documentation changes for Magic Folder.
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2016-07-21 12:35:59 -07:00
Daira Hopwood
54371547db
Docs for drop-upload on Windows.
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2016-07-21 12:35:59 -07:00
Daira Hopwood
02362ae52c
github does not render :doc: links; make sure that the links work there.
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2016-07-15 15:38:52 +01:00
Brian Warner
64a7c687a6
expenses: pay hosting through May-2016
2016-07-08 13:17:41 -07:00
Brian Warner
de90ae16a4
expenses: pay DNS, TLS
2016-07-08 12:48:26 -07:00
Brian Warner
4b035c17f2
donations.rst: add new expense addresses, resign
...
Also adds docs/expenses.rst (unsigned) to record individual expenses and
the transactions used to pay them.
2016-07-08 12:18:26 -07:00
Brian Warner
93bb3e995a
stats-gatherer: add --hostname/--location/--port
...
Updates docs, tests, explains how to update an old gatherer.
2016-05-04 17:58:45 -07:00
Brian Warner
d1d988410b
remove "key-generator" node type and client support
...
closes ticket:2783
2016-05-04 16:53:04 -07:00
Brian Warner
bde22ad1f7
docs are now at readthedocs.io
...
The badge image URL remains the same, but the docs themselves are now
hosted on tahoe-lafs.readthedocs.io rather than
tahoe-lafs.readthedocs.org .
2016-04-27 23:12:18 -07:00
Brian Warner
ea473cdc76
remove pickle-based stats output altogether
...
* update munin plugin to read JSON, not pickle
* update docs
2016-04-27 17:27:33 -07:00
Corbin Simpson
e1dba4abeb
stats: Dump a JSON file next to the pickle file.
...
Extremely useful for interoperating with non-Python (e.g. Monte) tooling.
2016-04-27 14:45:37 -07:00
Brian Warner
25b64041cc
update config docs, add NEWS snippet
2016-04-26 22:26:31 -07:00
Brian Warner
cf5b02b487
clean up tub.port processing, reject tcp:0
...
This is the first step towards making node startup be synchronous: the
tub.port is entirely determined (including any TCP port allocation that
might be necessary) before creating the Tub, so the portnumber part of
FURLs can be determined earlier.
2016-04-26 18:39:47 -07:00
Brian Warner
c582a21e99
webapi.rst: fixups
...
Re-indent the blocks for consistency, improve the explanation of
?filename=foo.jpg to match it's new location, use new-style reference
for urls-and-utf8 footnote.
2016-04-22 19:23:49 -07:00
Zooko O'Whielacronx
3e7346100f
update webapi.rst's View/Download File docs
...
• mark "/file/" as a synonym for "/named/" to be deprecated (fixes #1903 )
• move the options common to all three forms to the bottom and dedent them
• name the protocol/format as "LAFS" and the implementation/client "Tahoe"
• reflow (with fill-column 77)
2016-04-22 19:17:22 -07:00
Brian Warner
23f871a409
add [test] "extra" to install testing-only dependencies
...
closes ticket:2776
2016-04-12 12:32:46 -07:00
Brian Warner
8279d919f3
remove "manhole" (ssh-accessible REPL)
...
This little-used debugging feature allowed you to SSH or Telnet "into" a
Tahoe node, and get an interactive Read-Eval-Print-Loop (REPL) that
executed inside the context of the running process. The SSH
authentication code used a deprecated feature of Twisted, this code had
no unit-test coverage, and I haven't personally used it in at least 6
years (despite writing it in the first place). Time to go.
Also experiment with a Twisted-style "topfiles/" directory of NEWS
fragments. The idea is that we require all user-visible changes to
include a file or two (named as $TICKETNUM.$TYPE), and then run a script
to generate NEWS during the release process, instead of having a human
scan the commit logs and summarize the changes long after they landed.
Closes ticket:2367
2016-04-06 13:40:06 -10:00
Brian Warner
431d762872
desert-island: new approach, works better
2016-03-31 17:12:08 -07:00
Brian Warner
2b5633eedb
relnotes, docs: post-release fixups
2016-03-30 17:27:44 -07:00
Brian Warner
3b0789fb0c
docs: update release checklist
2016-03-30 16:03:52 -07:00
Brian Warner
1199a1547f
INSTALL: update downloads URL to expected location
2016-03-30 02:51:49 -07:00
Brian Warner
ab091e68de
update relnotes and known_issues
2016-03-30 02:25:27 -07:00
Brian Warner
c674b55918
docs: switch to default readthedocs.org theme
2016-03-30 02:18:00 -07:00
Brian Warner
12e54e52f4
README: point to tahoe-lafs.readthedocs.org
...
Also add a comment to docs/index.rst, pointing folks who are browsing
the source tree (locally, with an editor) at the formatted version on
readthedocs.org .
2016-03-30 01:26:47 -07:00
Brian Warner
248a6ceade
docs: add .empty to preserve empty _static and _templates
2016-03-30 01:26:47 -07:00
Brian Warner
f81900ee35
format docs for Sphinx
...
Added indexes, fixed cross-references.
Also a few pip-related cleanups I noticed along the way.
2016-03-30 01:26:47 -07:00
Brian Warner
142185bb86
docs: add sphinx index.rst, improve headers
2016-03-29 21:46:11 -07:00
Brian Warner
0acc1dc079
docs: run sphinx-quickstart, move old Makefile
...
* .gitignore: add docs/_build (sphinx output directory)
2016-03-29 21:02:14 -07:00
Brian Warner
2cfe2eb566
INSTALL.rst: more tweaks
2016-03-29 21:01:22 -07:00
Brian Warner
1f1e10d59b
docs/OS-X: the $PATH *does* get added correctly
2016-03-28 01:37:35 -07:00
Brian Warner
20787853dd
docs: stop suggesting 'activate', too much to explain
...
Also it avoids the failure mode where a user forgets to activate the
virtualenv, types the recommended "pip install" command, and installs
stuff directly to their system instead of safely confined inside the
virtualenv.
2016-03-26 14:13:23 -07:00
Brian Warner
365977bf51
minor docs tweaks
...
* use correct fixed-width-font markup
* fix hyperlinks to neighboring (github-side) .rst files
* refer to python-2.7.11 consistently (thanks to PRab for the catch)
2016-03-26 11:50:44 -07:00
Brian Warner
a63263dc55
minor docs tweaks
2016-03-25 19:25:55 -07:00
Brian Warner
ef1759046d
rewrite docs, with pip and virtualenv
2016-03-25 19:22:03 -07:00
Brian Warner
090b592ff8
docs: rename quickstart to INSTALL
2016-03-25 18:26:54 -07:00
Brian Warner
439eaf8c9d
preliminary windows docs
2016-03-25 17:27:38 -07:00
Daira Hopwood
0598c830ed
Rename distribution from allmydata-tahoe to tahoe-lafs. fixes ticket:2011
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2016-03-25 19:16:01 +00:00
Brian Warner
17886c51aa
add docs/desert-island.rst
...
refs ticket:2752
2016-03-22 18:18:49 -07:00
Brian Warner
a8b3c40f46
docs/donations: announce new BTC key, governance+accounting
2016-03-21 01:20:26 -07:00
Brian Warner
136c16e5ec
docs: explain what the OS-X package does and does not provide.
2016-03-16 12:38:26 -07:00
Zooko
e3f47919d0
edit to explain to newbies what "the top-level directory" is
...
I think confusion about this may behind BG <n0trab@yahoo.com>'s recent report
of failure-to-install on tahoe-dev (2016-02-26).
2016-03-13 14:35:48 +00:00
Zooko
a7894a8507
edit for accuracy
2016-03-13 14:34:31 +00:00
Zooko
57cc4e919d
edit for readability
2016-03-13 14:32:46 +00:00
Brian Warner
71c62b3256
docs/quickstart.rst: mention that py2.6 no longer works
2016-01-28 13:13:44 -08:00
Daira Hopwood
41cf600820
Corrections and clarifications to remote-to-local-sync.rst.
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2015-12-28 19:36:19 +00:00
Daira Hopwood
b5222e3679
Merge pull request #204 from leif/preferred_peers-rebased3
...
new feature: preferred storage servers
2015-12-04 18:01:30 +00:00
Leif Ryge
000c148ad8
drop Python 2.6 (.travis.yml, doc, setup.py)
...
Twisted 15 dropped support for it, which causes Travis CI tests to fail on 2.6.
We still theoretically support older versions of Twisted, so perhaps we should
configure Travis to test with those? I think we should drop Python 2.6 in any
case since distros are all on 2.7 now.
I'm leaving Travis running (and ignoring) the failing PyPy tests because I
don't know why that is there.
2015-12-02 20:18:33 +00:00
Leif Ryge
96eaca6a6d
new feature: preferred storage servers
...
this includes a squash merge of dca1de6856
which
was previously seen in pull request #128 , as well as daira's suggested changes
from pull request #204 .
2015-12-01 19:35:41 +00:00
Daira Hopwood
913082230c
Disable bridging of foolscap logging to the Twisted log, and remove docs for it. fixes ticket:2567
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2015-11-03 17:35:21 +00:00
Ramakrishnan Muthukrishnan
a6dd94646e
Move manpage into a heirarchical man1 path.
...
Author: Ramakrishnan Muthukrishnan <ram@leastauthority.com>
2015-09-03 15:18:58 +01:00
Daira Hopwood
7309aed524
Change some instances of "filesystem" that were missed to "file store".
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2015-07-31 18:21:47 +01:00
Brian Warner
befa4babea
update docs for 1.10.2 release
2015-07-30 19:36:45 -07:00
Brian Warner
4bb12887f4
quickstart: Mention python-dev package for Python.h
...
Closes ticket:2328.
2015-07-28 17:47:09 -07:00
Brian Warner
259ba07a5e
improve HTTP byte-range docs
2015-07-28 13:28:36 -07:00
Brian Warner
c3608f61d9
webapi.rst: document Range: header on GET requests
...
closes ticket#2460
2015-07-28 13:15:50 -07:00
Daira Hopwood
8cad9f4fd6
Change the separator character in the Magic Folder user interface design doc from '|' to '+'.
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2015-07-21 00:16:40 +01:00
Brian Warner
e03bae7948
docs/how-to-release: add more wiki pages to update
2015-06-26 18:39:29 -07:00
Brian Warner
aeafbc0dd1
release checklist: use signed git tag next time
2015-06-15 18:35:55 -07:00
Brian Warner
5887029b17
update docs for 1.10.1 release
2015-06-15 16:29:37 -07:00
Daira Hopwood
1105278589
Finish user-interface.rst. fixes ticket:2443
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2015-06-11 21:33:47 +01:00
Daira Hopwood
66178f01da
Make a start on the Magic Folder Objective 5 (user interface design) doc. refs ticket:2443
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2015-06-11 21:33:47 +01:00
Daira Hopwood
b062b76740
Magic Folder design doc: rename "parent DMD" to "collective directory", and don't assume it is mutable.
...
(An immutable collective directory could be interesting for some use cases, and is no more difficult to support.)
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2015-06-06 22:45:42 +01:00
Daira Hopwood
767d01484e
remote-to-local-sync.rst: fix a minor error.
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2015-05-29 22:10:33 +01:00
Daira Hopwood
97c33b175b
Magic Folder: add remote-to-local sync design doc.
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2015-05-29 03:03:46 +01:00
Daira Hopwood
aa65426ad3
docs/frontends/CLI.rst: clarification.
...
The implementation (in [source:src/allmydata/scripts/common.py]) actually tests whether there is a slash anywhere before the first colon.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2015-05-11 15:05:42 +01:00
Daira Hopwood
7ee151fa55
docs/frontends/CLI.rst: remove a superfluous TODO.
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2015-05-11 14:50:32 +01:00
Brian Warner
97fd19407d
Improve docs on 'cp -r', noting the recent 2329 changes
...
refs ticket:2329
2015-05-03 21:49:34 -07:00
Daira Hopwood
17c891f26a
Update title of OpenSSL and pyOpenSSL build instructions.
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2015-05-01 22:07:27 +01:00
Daira Hopwood
226559b44c
Add OpenSSL and pyOpenSSL build instructions for 32-bit Windows.
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2015-05-01 21:43:43 +01:00
Daira Hopwood
b0fb800a41
Add doc for building pyOpenSSL.
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2015-05-01 18:45:19 +01:00
Daira Hopwood
6f29c79d80
Add discussion and rejection of Change Journals.
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2015-04-02 16:16:46 +01:00
Daira Hopwood
fc0523471f
Add link to otf-magic-folder-objective ticket query.
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2015-04-02 16:16:17 +01:00
Daira Hopwood
8fabcbe54b
Copyediting.
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2015-04-02 16:15:39 +01:00
Daira Hopwood
14c3bfd12e
Collaborative design from Daira and David.
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2015-04-02 15:26:25 +01:00
Daira Hopwood
1b83f7854c
Documentation change for AUTO in tub.location. refs #754
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2015-02-10 18:23:59 +00:00
Daira Hopwood
0d935e8589
Update docs for SFTP public key auth. refs #1411
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2015-01-06 19:14:47 +00:00
Daira Hopwood
a55164673b
Change python.org link (https, main download page); editing.
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2014-09-25 18:16:23 +01:00
Zooko
c84ebd3259
reflow to fill-column 77
...
and add comment informing your text editor that fill-column=77
2014-09-25 16:47:19 +00:00
Daira Hopwood
6a38a3c54e
Rename README.txt to README.rst, and add Travis-CI and Coveralls badges to it.
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2014-09-09 18:51:44 +01:00
Brian Warner
2018ff435a
CLI.rst: expand the 'cp -r' subdirectory example
2014-09-02 12:51:13 -07:00
Mark J. Berger
58106e1c0f
Documentation updates
2014-09-02 12:51:13 -07:00
Daira Hopwood
1e3a2994e2
Reference README.txt from License section of docs/about.rst, rather than duplicating the license info. fixes #2067
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2014-09-02 19:37:06 +01:00
Daira Hopwood
c126dc0598
Document ways to use LAFS as a key-value store.
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2014-08-22 15:54:53 +01:00
Zooko Wilcox-O'Hearn
bb13bba2a5
formatting fixes
2014-08-19 18:24:38 +00:00
Zooko Wilcox-O'Hearn
35e90006f4
recommend tahoe backup
...
and, explain some of why it is awesome, and link to
`<docs/frontends/CLI.rst>`__.
2014-08-19 18:18:33 +00:00
Zooko Wilcox-O'Hearn
f62ff304c5
add warning about performance problems with FUSE
2014-08-05 20:50:30 +00:00
zooko
bc6304ae70
Merge pull request #94 from zooko/link-to-Twisted-ticket-4633
...
link to Twisted ticket #4633
2014-07-22 06:27:25 +00:00
Zooko Wilcox-O'Hearn
78503591d7
link to Twisted ticket #4633
2014-07-22 05:16:04 +00:00
pataquets
fac1f0d55a
Update adding comments as seen in https://tahoe-lafs.org/pipermail/tahoe-dev/2012-May/007365.html
...
Found it useful. I can't see here clearly if deleting backupdb will affect deduplication and I'd like to clarify here, anyway. Do deduplication depend on backupdb data? TIA.
2014-07-02 13:10:10 -07:00
Brian Warner
a724c09ab8
release docs: recommend Twine for package upload. Closes #2086 .
2014-04-25 15:26:23 -07:00
Daira Hopwood
0ef5939477
Remove 'needs-rebalancing' and add 'count-happiness' to checker reports; repair tests. fixes #1784 , #2105
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2014-03-20 16:13:57 +00:00
David
7f0c823b14
Small typo: "stil" -> "still"
2014-01-02 01:59:53 +01:00
Daira Hopwood
419df9b0b4
docs/about.rst: Reword and remove redundancy. Also avoid "(S)FTP".
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2013-12-04 01:23:11 +00:00
pataquets
857d072ff4
Warn about ambiguities on "client" and "gateway" terms
2013-12-03 17:25:45 +01:00
Zooko Wilcox-O'Hearn
402a66d472
change more links to footnote-style
2013-11-17 15:46:31 +00:00
Zooko Wilcox-O'Hearn
1b0b49aca9
update link to Maildir tips (thanks MK_FG)
2013-11-12 16:37:02 +00:00
Zooko Wilcox-O'Hearn
0bebbe3290
fix warnings from rst2html
...
Apparently the in-line link syntax with "<>" in them causes these warnings. I
don't know why. I changed them all to a slightly more verbose syntax.
Thanks to Mike Kazantzsev's review comment
(https://github.com/tahoe-lafs/tahoe-lafs/pull/67#commitcomment-4561370 ), I
moved the links to the end of each section.
2013-11-11 22:04:11 +00:00
Zooko Wilcox-O'Hearn
82579cec96
magic first line tells emacs to use utf8+bom
...
Add ".. -*- coding: utf-8-with-signature -*-" to the first line of each .rst
file. This tells emacs to treat the file contents as utf-8, and also to prepend
a so-called utf-8 "bom" marker at the beginning of the file. This patch also
prepends those markers to each of those files.
2013-11-08 21:08:05 +00:00
Daira Hopwood
2ac43975ee
Fix typo pointed out by CptPlastic.
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2013-10-22 02:31:52 +01:00
Daira Hopwood
3529d31192
Add quotes around command lines in quickstart.rst.
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2013-10-05 18:55:01 +01:00
Zooko Wilcox-O'Hearn
cc0b1ff6ec
fix a couple more "file:" links
...
Making them be just links to "$FILENAME" instead of to "file:$FILENAME" causes
them to be working links on trac and on github. Yay!
2013-10-05 03:44:39 +00:00
Zooko Wilcox-O'Hearn
4e0a8d8d4f
fix small issues in formatting
...
* fix warning from "rst2html --verbose" by not using the in-line hyperlink
syntax. The warning said::
known_issues.rst:261: (INFO/1) Hyperlink target "google chart api" is not referenced.
* remove dead code (no-longer-referenced link), thus fixing another warning
* change links to relative files to be just $FILENAME instead of
file:$FILENAME, which I think will fix the problem of broken links on the
trac and github, e.g. the link in
https://tahoe-lafs.org/trac/tahoe-lafs/browser/trunk/docs/known_issues.rst ,
which ought to go to
https://tahoe-lafs.org/trac/tahoe-lafs/browser/trunk/docs/cautions.rst , but
instead goes to file:///cautions.rst
2013-10-05 03:29:00 +00:00
Mark J. Berger
74d37b98fa
Fixes the overlapping text in docs/lease-tradeoffs.svg
...
This fixes ticket #1842 . Patch courtesy of PRabahy.
2013-08-07 13:12:59 -04:00
Nathan Wilcox
d5f97cd74a
Add a link in accounting-overview.txt to ticket #666 .
2013-07-04 12:47:28 -07:00
Brian Warner
a3891d98d7
update release how-to to be closer to current reality
2013-05-01 15:24:24 -07:00
Daira Hopwood
397a95e827
Update terminology in RAIC design doc.
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2013-05-01 22:58:16 +01:00
David-Sarah Hopwood
b94721ad40
docs/proposed/leasedb.rst: Add design doc for leasedb.
...
This version refs #1834 .
Signed-off-by: David-Sarah Hopwood <david-sarah@jacaranda.org>
2013-05-01 22:58:16 +01:00
Brian Warner
d7e71cd22b
known_issues, quickstart: add version and anticipated release date
2013-04-24 17:17:45 -07:00
Brian Warner
0ee23117a4
known_issues.rst: get closer to real date
2013-04-24 00:18:43 -07:00
Brian Warner
02975d1887
known_issues: update chart-API text, with suggestions from Leif. refs #1942
2013-04-23 16:39:53 -07:00
Brian Warner
0ba5058f6a
docs/nodekeys.rst: explain what node keys are for, with compatibility notes
2013-04-21 23:01:25 -07:00
Daira Hopwood
b06f8cd8d0
Add comments and a caveat in webapi.rst indicating that
...
the needs-rebalancing field may be computed incorrectly. refs #1115 , #1784 , #1477
Signed-off-by: Daira Hopwood <david-sarah@jacaranda.org>
2013-04-18 23:48:45 +01:00
Daira Hopwood
6899d02854
Minor improvements to webapi.rst.
...
Signed-off-by: Daira Hopwood <david-sarah@jacaranda.org>
2013-04-18 23:48:45 +01:00
Leif Ryge
c2a355d405
docs: fixed typos
2013-04-18 11:49:33 -07:00
Daira Hopwood
04c7cfe38b
docs/quickstart.rst: update Python 2.7 download URL.
...
Signed-off-by: Daira Hopwood <david-sarah@jacaranda.org>
2013-04-18 04:34:01 +01:00
Daira Hopwood
f51f319998
docs/quickstart.rst: update recommended Python version.
...
Signed-off-by: Daira Hopwood <david-sarah@jacaranda.org>
2013-04-18 04:30:45 +01:00
Brian Warner
3a18157456
known_issues: document the google-chart-API privacy leak. Refs #1942 .
2013-04-14 22:27:03 -07:00
Brian Warner
17fcafbb3f
docs: replace emdash characters with plain ASCII
2013-04-09 20:19:58 +01:00
Zooko O'Whielacronx
643eb4f372
s/node/client; mention restart is needed
2013-04-09 19:00:01 +01:00
Zooko O'Whielacronx
07f7d50afa
convergence secret doc by CtB, marlowe, zooko
2013-04-09 19:00:01 +01:00
Zooko O'Whielacronx
389251860e
attempt to clarify move-vs-relink
2013-04-09 07:08:17 -06:00
Brian Warner
f9335892f2
webapi.rst: small edits to the t=relink section
2013-04-09 12:06:52 +01:00
Daira Hopwood
b1064d456b
docs/frontends/webapi.rst: cosmetics.
...
Signed-off-by: Daira Hopwood <david-sarah@jacaranda.org>
2013-04-05 19:38:43 +01:00
Daira Hopwood
35f37cc5b8
Change web-API to support t=relink instead of t=move (+ docs and tests). fixes #1732
...
Signed-off-by: Daira Hopwood <david-sarah@jacaranda.org>
2013-04-05 19:38:43 +01:00
Daira Hopwood
57d0999425
docs/man/tahoe.1: fix typo and copyright date.
...
Signed-off-by: Daira Hopwood <david-sarah@jacaranda.org>
2013-04-03 21:57:32 +01:00
David-Sarah Hopwood
31a7b3dfd1
CREDITS: change my name.
...
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2013-03-26 19:23:27 +00:00
Brian Warner
0a89b738bc
Make introducer.furl unguessable. Closes #1802 .
...
Previously, Introducers always used a swissnum of "introducer", so
anyone who could learn the (public) tubid of the introducer would be
able to connect to and use it. This changes new Introducers to use the
same randomly-generated swissnum as clients and storage servers do, so
that you absolutely must learn the introducer.furl from someone who
knows it already before you can connect.
This change also moves the location of the file that stores
introducer.furl from BASEDIR/introducer.furl to
BASEDIR/private/introducer.furl, since that's where we keep the private
things. The first time an introducer is started with the new code, it
will move any existing BASEDIR/introducer.furl into the new place.
Note that this will not change the FURL of existing introducers: it will
only affect newly created ones. When you change an introducer's FURL,
you must also update all of the nodes (clients and storage servers)
which connect to it, so upgrading it to an unguessable one isn't
something we should do automatically.
2013-03-20 22:40:33 +00:00
David-Sarah Hopwood
5082ca46f4
Update helper.rst to explain new-style config. fixes #1915
...
Author: Zooko Wilcox-O'Hearn <zooko>
Signed-off-by: David-Sarah Hopwood <david-sarah@jacaranda.org>
2013-03-17 16:53:32 +00:00
David-Sarah Hopwood
eba64f2aba
docs/configuration.rst: clarification on scale suffixes for reserved_space.
...
refs #1812
Signed-off-by: David-Sarah Hopwood <davidsarah@mint>
2012-12-27 23:38:58 +00:00
David-Sarah Hopwood
8618929833
docs/logging.rst: fix rst2html warnings.
...
Signed-off-by: David-Sarah Hopwood <davidsarah@mint>
2012-12-22 23:47:47 +00:00
David-Sarah Hopwood
a125f83f1a
docs/logging.rst: remove note about a bug that was fixed in foolscap 0.6.0.
...
Signed-off-by: David-Sarah Hopwood <davidsarah@mint>
2012-12-22 23:39:11 +00:00
David-Sarah Hopwood
4c91fa948d
docs/frontends/CLI.rst: fix markup of * and ?.
...
Signed-off-by: David-Sarah Hopwood <david-sarah@jacaranda.org>
2012-11-11 16:04:23 +00:00
David-Sarah Hopwood
86471233f0
docs/frontends/CLI.rst: document ./* trick, and that aliases should not be a single char on Windows.
...
Also fix some rst2html warnings. refs #1853 , #1840
Signed-off-by: David-Sarah Hopwood <david-sarah@jacaranda.org>
2012-11-11 15:50:46 +00:00
David-Sarah Hopwood
522e74f572
Update docs/network-and-reliance-topology.svg for RAIC, and to be more accurate about frontend protocols.
...
Signed-off-by: David-Sarah Hopwood <david-sarah@jacaranda.org>
2012-11-03 00:15:32 +00:00
David-Sarah Hopwood
a77ae772f2
docs/about.rst: fix broken link for network-and-reliance-topology image.
...
Signed-off-by: David-Sarah Hopwood <david-sarah@jacaranda.org>
2012-11-01 23:09:07 +00:00
Mike Kazantsev
05d0b8b5b9
docs/frontends/webapi.rst: remove (ignored) "size" keyword from mkdir POST example
2012-10-09 15:01:44 -07:00
david-sarah
6c654be4d5
docs/quickstart.rst: swap two paragraphs to make it more likely a user will report import and versioning errors from 'bin/tahoe --version' if there are any, before trying to run tests. Also, change 'python setup.py test' to 'python setup.py trial' to avoid a rebuild that might change the dependencies (if setuptools decides to throw a spanner in the works).
2012-09-14 02:10:12 +00:00
Zooko O'Whielacronx
0d5c086218
docs: fix link to mutable.rst. Thanks to TimothyA for noticing the broken link
2012-07-20 19:24:02 +00:00
david-sarah
9a6fb89545
docs/configuration.rst: clarify statement about lack of redundancy when shares.happy <= k. fixes #1793
2012-07-12 20:30:26 +00:00
david-sarah
0556a988e1
Update release date for 1.9.2.
2012-07-03 16:30:10 +00:00
david-sarah
2c1368312e
Relnotes, NEWS and quickstart updates for 1.9.2, with updated release date. refs #1776
2012-07-01 23:19:21 +00:00
david-sarah
514fb096be
Update docs, notably performance.rst, to include MDMF. fixes #1772
2012-06-23 23:13:38 +00:00
david-sarah
8c256de1f0
Release notes, NEWS, and quickstart updates for 1.9.2a1. refs #1776
2012-06-23 00:17:52 +00:00
david-sarah
7ffa819eef
docs/frontends/FTP-and-SFTP.rst: remove reference to rekeying bug since it does not apply now that we depend on Twisted 11.0. refs #1297 refs #1771
2012-06-18 17:03:15 +00:00
david-sarah
f86a411928
docs/frontends/FTP-and-SFTP.rst: listing of directories containing mutable files (but not reading/writing mutable files) is fixed for FTP. Also remove the orphaned trac link to #1688 . refs #680
2012-06-18 00:24:54 +00:00
Zooko O'Whielacronx
d86b751fed
docs: remove mention of #1588 from docs/frontends/FTP-and-SFTP.rst, since it is fixed
2012-06-17 03:14:04 +00:00
Patrick R McDonald
2f9f853413
Added docs/specifications/backends/raic.rst for ticket #1760
2012-06-10 12:32:36 -07:00
david-sarah
be6efc1bc7
docs/quickstart.rst: fix rst warning.
2012-06-01 21:01:04 +00:00
david-sarah
f19620301e
docs/frontends/FTP-and-SFTP.rst: remove outdated allmydata.com reference. fixes #1743
2012-05-18 22:56:18 +00:00
david-sarah
959248cd49
Change logging.rst to address warner's review comment. refs #1693
2012-05-16 22:13:29 +00:00
david-sarah
1e2657efe3
Clarify an ambiguity about which version number is meant in quickstart.rst.
2012-05-14 00:26:37 +00:00
Brian Warner
e850b54772
performance.rst: small updates, mention (lack of) MDMF
...
refs #1398
2012-05-13 14:07:39 -07:00
Brian Warner
fcc7e64759
Doc updates and cosmetic fixes for #1115 patch.
...
Removes the caveat from webapi.txt about count-good-share-hosts being wrong.
This series should close #1115 .
2012-05-13 01:15:50 -07:00
david-sarah
379901bf8f
Add 'tahoe debug flogtool' command, test for --help, and docs. This version gets the help synopses more correct, and changes the doc to say that this command is added in 1.10.0 rather than 1.9.2. fixes #1693
2012-03-31 22:41:22 +00:00
Brian Warner
2c5a7f7ba4
Improve webapi t=move docs.
2012-05-09 16:46:53 -07:00
Marcus Wanner
e58a01270b
Change the arbitrary URI support from implied to explicit
...
The move webapi function now takes a target_type argument which lets it
know whether the target is a subdirectory name or URI. This is an
improvement over the old system in which the move handler tried to guess
whether the target was a name or a URI. Also fixed a little docs
copypaste problem and tweaked some line wrapping.
2012-05-09 13:07:14 -07:00
Marcus Wanner
b29d0920d3
Adding 'move' button to web UI, closes #1579
...
This adds "move file" capability to the web UI's directory display. The
support and test framework is heavily based on the similar "rename file"
feature. Unit tests and documentation are included. Multiple in-progress
versions of this patch may be found in ticket 1579. This version
includes arbitrary URI target support and is compatible with the change
from tahoe_css to tahoe.css.
2012-05-09 13:07:13 -07:00
Patrick R McDonald
080c136daf
Updated webapi.rst to list /cap as a synonym for /uri
2012-04-17 11:41:11 -07:00
Patrick R McDonald
589179cf03
Fix for ticket #1662
2012-04-10 11:33:14 -07:00
david-sarah
496b65bf02
docs/frontends/drop-upload.rst: document more known issues and link to new ticket for an existing one.
2012-04-06 04:39:46 +00:00
Brian Warner
3a2a086f6c
webapi.rst: de-tabify
2012-04-02 16:32:05 -07:00
Zooko O'Whielacronx
c84cbcae71
doc: cross-link known_issues.rst and cautions.rst with one another
2012-04-01 21:40:39 +00:00
Zooko O'Whielacronx
62515f1fc3
docs: FTP-and-SFTP.rst: recommend SFTP
...
Add an explicit recommendation of SFTP over FTP. Separate the known issues of
FTP from SFTP. List "SFTP" first in all lists of the two. Use unicode bullet
points and prepend a utf-8 BOM. Use out-of-line rst hyperlinks.
2012-04-01 21:20:02 +00:00
Zooko O'Whielacronx
638dcf867a
docs: quickstart: edits
...
• use out-of-line links to avoid a warning from rst2html --verbose (fixes #1704 )
• reflow to 77 fill-column and prepend utf-8 BOM (fixes #1703 )
• recommend Python 2.7 (fixes #1702 )
• remove link to wiki:AdvancedInstall (fixes #1701 )
2012-04-01 01:57:17 +00:00
david-sarah
922ed08c25
Document PYTHONPATH problem when running flogtool. refs #1693
2012-03-31 22:39:34 +00:00
david-sarah
1562e2a302
FTP-and-SFTP.rst: there were two more instances of 'rootcap'. Also made the wording tweak from ticket:1487#comment:4 . fixes #1487
2012-03-31 02:32:47 +00:00
david-sarah
dde822e26d
FTP-and-SFTP.rst: directories containing mutable files should now be listable via FTP. refs #680
2012-03-31 01:37:30 +00:00
david-sarah
c5e10e2261
Cosmetic formatting in docs.
2012-03-22 22:05:34 +00:00
david-sarah
5495b2aead
Put SFTP before FTP in various docs. fixes #1692
2012-03-22 22:04:53 +00:00
david-sarah
f50b247b8e
Correct a link to frontends/drop-upload.rst. fixes #1690
2012-03-22 22:01:18 +00:00
david-sarah
07312870e1
Minor updates to URLs.
2012-03-13 20:28:53 +00:00
david-sarah
d9c7dfa4a0
Update more links from http: to https: in documentation and comments.
2012-03-13 20:26:54 +00:00
david-sarah
e215af8646
Update copyright notices. refs #1686
2012-03-13 20:50:57 +00:00
Brian Warner
11f9394704
remove 'provisioning'/'reliability' from WUI, add to misc/operations_helpers
...
Also remove docs related to reliability/provisioning pages
2012-02-16 22:29:05 +00:00
david-sarah
2da8339dd7
configuration.rst: another attempt to fix formatting of sample tahoe.cfg.
2012-01-31 00:09:49 +00:00
david-sarah
5b4c159894
configuration.rst: remove the obsolete sizelimit option from the sample tahoe.cfg. Also fix the RST formatting of blank lines in the file.
2012-01-31 00:06:43 +00:00
Patrick R McDonald
cd82f4b5cb
Added clarification on how interface= works
2012-01-24 12:38:21 -08:00
Brian Warner
6ce14241d0
FTP-and-SFTP.rst: minor edits
2012-01-24 12:36:54 -08:00
Patrick R McDonald
95a9972034
Updated accounts.url directive per warner's suggestions
2012-01-24 12:31:26 -08:00
Patrick R McDonald
ee9d28f20b
Added information on accounts.url directive
2012-01-24 12:31:26 -08:00
Zooko O'Whielacronx
0ac4801293
docs: an extra newline to separate utf-8 BOF from comment for the sake of trac's rst renderer
2012-01-22 21:20:02 +00:00
Zooko O'Whielacronx
d23de91e2e
docs: a newline between the utf-8 BOF and the comment in order to prevent trac from misrendering the comment
...
sheesh
2012-01-22 21:18:56 +00:00
Zooko O'Whielacronx
4e4f3cadf9
docs: a comment to inform the (human) reader about encoding and to prevent someone from moving the title up to where it will interact with the utf-8 BOM and cause trac to mis-render the title
2012-01-22 21:17:31 +00:00
Zooko O'Whielacronx
28bfccaefc
docs: insert another newline between utf-8 BOF and title
2012-01-22 21:14:27 +00:00
Zooko O'Whielacronx
f9a756763c
docs: insert newline after utf-8 BOF and before restructuredtext title
2012-01-22 18:21:27 +00:00
Zooko O'Whielacronx
4742f43a6a
docs: remove utf-8 "BOM" which confuses trac's rst renderer
2012-01-22 14:00:52 +00:00
Zooko O'Whielacronx
7db661fe1b
docs: try again to change RestructuredText titles to a format that trac will render
2012-01-22 13:56:13 +00:00
Zooko O'Whielacronx
95f2d70518
docs: backdoors.rst: fix title formatting
2012-01-22 13:51:25 +00:00
Zooko O'Whielacronx
55bfe43866
docs: backdoors.rst: stop using embedded URIs and tweak title so that trac will render it correctly; reflow to fill-column 77; M-x whitespace-cleanup
2012-01-22 13:43:19 +00:00
Brian Warner
769574f665
update release process: git, not darcs, etc
2012-01-12 23:12:57 -08:00
Brian Warner
f139af3603
prepare to Org-ify how_to_make_a_tahoe-lafs_release: rename the file
2012-01-12 23:01:53 -08:00
Brian Warner
544b5476cf
merge relnotes, quickstart.rst from 1.9.1 release
2012-01-12 15:24:20 -08:00
Brian Warner
d10f260f36
retrieve.py: unconditionally check share-hash-tree. Fixes #1654 .
...
Add Kevan's unit test, update known_issues.rst
2012-01-12 13:35:53 -08:00
david-sarah
7f8bbcc155
Use a private/drop_upload_dircap file instead of the [drop_upload]upload.dircap option in tahoe.cfg. Fail if the upload.dircap option is used, or options are missing. Also updates tests and docs. fixes #1593
2011-11-20 23:24:26 +00:00
Zooko O'Whielacronx
ab9859d6a5
docs: how_to_make_a_tahoe-lafs_release.rst add Google+ page to publicity list, change to cute unicode checkboxes
2011-12-26 15:19:05 +00:00
Zooko O'Whielacronx
4a29642623
doc: about.rst: use unicode emdash, use non-embedded URIs, add clarificaiton of when a file gets its mutable-or-immutable nature
...
embedded URIs, although documented here:
http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#embedded-uris
generate messages like this from rst2html --verbose:
quickstart.rst:3: (INFO/1) Duplicate explicit target name: "the tahoe-dev mailing list".
Also this patch prepends a "utf-8 BOM" to the beginning of the file.
2011-12-06 17:19:08 +00:00
david-sarah
b73aba98de
docs/known_issues.rst: describe when the unauthorized access attack is known to be possible, and fix a link.
2011-11-18 00:20:13 +00:00
david-sarah
891069c245
Strengthen description of unauthorized access attack in known_issues.rst.
2011-11-18 00:00:30 +00:00
Brian Warner
3978cc2ab6
update NEWS for the 1.9.0 release
2011-10-31 05:22:52 +00:00
Brian Warner
b047fddde3
more docs updates
2011-10-31 05:08:31 +00:00
Brian Warner
527400b9bf
update relnotes, rotate known_issues, for 1.9
2011-10-30 20:24:39 -07:00
Brian Warner
890b694dd2
add user-oriented notes to NEWS and mutable.rst about SDMF-vs-MDMF
2011-10-30 20:05:12 -07:00
Brian Warner
05dbb1cf86
update project-home URLs: /trac/tahoe/ was replaced by /trac/tahoe-lafs/
2011-10-30 12:14:28 -07:00
Brian Warner
b952d9dc1b
quickstart.rst: remove trailing whitespace
2011-10-30 10:44:11 -07:00
Brian Warner
41a994ba7d
quickstart.rst: update the release URL in preparation for 1.9
2011-10-30 10:33:18 -07:00
Brian Warner
aae5b6e913
and configuration.rst
...
I'm doing these one-at-a-time because I'm also debugging buildbot
problems, and it's handy to trigger builds this way.
2011-10-29 20:51:57 +00:00
Brian Warner
52a9523d7a
and about.rst
2011-10-29 19:58:16 +00:00
Brian Warner
35d9512c77
more http->https changes
2011-10-29 19:09:05 +00:00
Brian Warner
a0432a4ec5
tahoe-lafs.org is now HTTPS-always. Update most URLs.
2011-10-29 18:39:46 +00:00
david-sarah
f8be1f6220
docs/about.rst: correct the description of availability to take into account that shares may not be stored on distinct servers.
2011-10-25 06:25:50 -07:00
Brian Warner
d28041fbe4
CLI: don't deprecate --mutable, small docs fixes. refs #1561
...
Also don't accept 'tahoe mkdir --format=chk'.
2011-10-13 21:00:02 -07:00
Brian Warner
57ee56533f
add --format= to 'tahoe put'/'mkdir', remove --mutable-type. Closes #1561
2011-10-13 20:15:00 -07:00
Zooko O'Whielacronx
587e31a8cf
docs: fix several imprecise or inaccurate values in performance.rst
...
add cpu values for each operation
sort the list of values into the same order in each operation
refs #1398
2011-05-08 05:42:28 -07:00
Brian Warner
210761cd49
misc mutable-type fixes:
...
* fix tahoe.cfg control of default mutable type
* tolerate arbitrary case in [client]mutable.format value
* small docs improvements
* use get_mutable_type() as a format-is-mutable predicate
* tighten up error message
2011-10-13 09:32:29 -07:00
Brian Warner
01b00dc7dc
webapi: use all-caps "SDMF"/"MDMF" acronyms in t=json response
...
docs: upcase examples of t=json output and format= input
2011-10-13 09:31:43 -07:00
Brian Warner
8b91410ebb
webapi.rst: fix whitespace (detabify) t=json examples
2011-10-13 09:30:56 -07:00
kevan
bd642739cb
docs/frontends/webapi.rst: document the format argument
2011-10-09 19:55:29 -07:00
Zooko O'Whielacronx
3a14ad1bb1
docs/configuration.rst: add section about the types of node, and clarify when setting web.port enables web-API service. fixes #1444
2011-09-26 13:38:01 -07:00
david-sarah
8d45f91bf0
docs: fix some broken .rst links. refs #1542
2011-09-24 22:10:01 -07:00
Zooko O'Whielacronx
c4029d427f
docs: insert a newline at the beginning of known_issues.rst to see if this makes it render more nicely in trac
2011-09-13 23:47:28 -07:00
Zooko O'Whielacronx
40bea76b3a
docs: remove the coding: utf-8 declaration at the to of known_issues.rst, since the trac rendering doesn't hide it
2011-09-13 22:57:13 -07:00
Zooko O'Whielacronx
5bc4f64ec9
docs: more cleanup of known_issues.rst -- now it passes "rst2html --verbose" without comment
2011-09-13 22:54:19 -07:00
Zooko O'Whielacronx
42dece142e
docs: more formatting improvements to known_issues.rst
2011-09-13 22:16:39 -07:00
Zooko O'Whielacronx
9a26279391
docs: reformatting of known_issues.rst
2011-09-13 22:02:40 -07:00
Zooko O'Whielacronx
1db2c5395d
docs: fix formatting error in docs/known_issues.rst
2011-09-13 21:59:09 -07:00
Zooko O'Whielacronx
a6d5a9b508
merge Tahoe-LAFS v1.8.3 release announcement with trunk
2011-09-13 14:05:44 -07:00
Zooko O'Whielacronx
fcedf5f143
docs: release notes for Tahoe-LAFS v1.8.3
2011-09-13 09:58:26 -07:00
Zooko O'Whielacronx
48f56dab6f
doc: add entry in known_issues.rst about the issue which allows unauthorized deletion of shares
...
ref. #1528
2011-09-12 15:31:35 -07:00
Zooko O'Whielacronx
5476f67dc1
storage: remove the storage server's "remote_cancel_lease" function
...
We're removing this function because it is currently unused, because it is dangerous, and because the bug described in #1528 leaks the cancellation secret, which allows anyone who knows a file's storage index to abuse this function to delete shares of that file.
fixes #1528 (there are two patches that are each a sufficient fix to #1528 and this is one of them)
2011-09-12 15:23:31 -07:00
david-sarah
08ea3dc512
docs/write_coordination.rst: fix formatting and add more specific warning about access via sshfs.
2011-08-31 16:21:48 -07:00
david-sarah
3d7a32647c
Implementation, tests and docs for blacklists. This version allows listing directories containing a blacklisted child. Inclusion of blacklist.py fixed. fixes #1425
2011-08-24 08:59:28 -07:00
Zooko O'Whielacronx
43ba172f65
doc: eliminate the phrase "rootcap" from doc/frontends/FTP-and-SFTP.rst
...
Two different people have asked me for help, saying they couldn't figure out what a "rootcap" is. Hopefully just calling it a "cap" will make it easier for them to find out from the other docs what it is.
2011-08-09 06:26:01 -07:00
Kevan Carstensen
85a00b2d37
docs: amend configuration, webapi documentation to talk about MDMF
2011-08-01 19:20:56 -07:00
Zooko O'Whielacronx
f1897a3da1
docs: change links that pointed to COPYING.TGPPL.html to point to COPYING.TGPPL.rst instead
2011-08-18 23:01:42 -07:00
Zooko O'Whielacronx
74e83bba9f
docs: formatting: reflow to fill-column 77
2011-08-18 23:01:10 -07:00
Zooko O'Whielacronx
3c711a8375
docs: formatting: M-x whitespace-cleanup
2011-08-18 23:00:41 -07:00
Zooko O'Whielacronx
41999430e0
docs: reflow docs/logging.rst to fill-column 77
2011-08-18 21:41:03 -07:00
Zooko O'Whielacronx
cd006ed46b
doc: fix formatting error in docs/logging.rst
2011-08-18 21:39:46 -07:00
Zooko O'Whielacronx
33461a775e
doc: formatting: reflow to fill-column=77
2011-08-09 06:25:10 -07:00
david-sarah
4d58e7cef9
Makefile: remove targets that used misc/debian[_helpers] which no longer exist. Also change docs/debian.rst to reflect the fact that we no longer support building .debs using those targets. refs #1454
2011-07-31 20:18:57 -07:00
Zooko O'Whielacronx
035dbcadde
doc: edit the explanation of K-of-N tradeoffs
2011-08-04 12:34:09 -07:00
Zooko O'Whielacronx
b66cbf10de
doc: clean up formatting of doc/configuration.rst
...
reflow to 77 chars line width, M-x white-space cleanup, blank link between name and definition
2011-08-04 12:27:22 -07:00
Zooko O'Whielacronx
b7683d9b83
drop-upload: rename the 'upload.uri' parameter to 'upload.dircap', and a couple of cleanups to error messages. refs #1429
...
I rerecorded this patch, originally by David-Sarah, to use "darcs replace" instead of editing to do the renames. This uncovered one missed rename in Client.init_drop_uploader. (Which also means that code isn't exercised by the current unit tests.)
refs #1429
2011-08-09 15:05:08 -07:00
david-sarah
667b086b59
Documentation for drop-upload frontend. refs #1429
2011-08-08 11:21:46 -07:00
Brian Warner
4028908b2e
add docs about timing-channel attacks
2011-08-01 21:45:41 -07:00
Zooko O'Whielacronx
e5c4e83f4c
reject old-style (pre-Tahoe-LAFS-v1.3) configuration files
...
Check for the existence of any of them and if any are found raise exception which will abort the startup of the node.
This is a backwards-incompatible change for anyone who is still using old-style configuration files.
fixes #1385
2011-08-01 16:24:23 -07:00
Zooko O'Whielacronx
420e3aa293
whitespace-cleanup
2011-07-24 18:55:46 -07:00
david-sarah
9ba8a1b83e
docs/frontends/webapi.rst: change some more instances of 'delete' or 'remove' to 'unlink', change some section titles, and use two blank lines between all sections. refs #776 , #1104
2011-08-01 15:09:19 -07:00
david-sarah
00dccc4377
docs/webapi.rst: address Kevan's comments about use of 'delete' on ref #1104
2011-08-01 13:53:56 -07:00
david-sarah
4861d50c2f
docs: some changes of 'delete' or 'rm' to 'unlink'. refs #1104
2011-07-12 17:27:22 -07:00
david-sarah
07ecac1d83
WUI: change the label of the button to unlink a file from 'del' to 'unlink'. Also change some internal names to 'unlink', and allow 't=unlink' as a synonym for 't=delete' in the web-API interface. Incidentally, improve a test to check for the rename button as well as the unlink button. fixes #1104
2011-07-12 17:12:18 -07:00
david-sarah
da58fefd50
docs/man/tahoe.1: add man page. fixes #1420
2011-07-24 10:17:28 -07:00
david-sarah
8b40826774
Update the dependency on Twisted to >= 10.1. This allows us to simplify some documentation: it's no longer necessary to install pywin32 on Windows, or apply a patch to Twisted in order to use the FTP frontend. fixes #1274 , #1438 . refs #1429
2011-07-21 16:36:58 -07:00
david-sarah
55cec9770b
docs/running.rst: use 'tahoe run ~/.tahoe' instead of 'tahoe run' (the default is the current directory, unlike 'tahoe start').
2011-07-17 17:59:49 -07:00
david-sarah
1f4643f80d
docs/running.rst: say to put the introducer.furl in tahoe.cfg.
2011-07-17 12:43:15 -07:00
Zooko O'Whielacronx
ed836157aa
docs: fix error in crypto specification that was noticed by Taylor R Campbell <campbell+tahoe@mumble.net>
2011-06-29 11:57:11 -07:00
Zooko O'Whielacronx
155d048d17
docs: three minor fixes
...
CREDITS for arc for stats tweak
fix link to .zip file in quickstart.rst (thanks to ChosenOne for noticing)
English usage tweak
2011-06-10 05:16:56 -07:00
david-sarah
ff136b8ed2
docs/running.rst: fix stray HTML (not .rst) link noticed by ChosenOne.
2011-06-09 15:37:19 -07:00
wilcoxjg
67ad0175cd
server.py: get_latencies now reports percentiles _only_ if there are sufficient observations for the interpretation of the percentile to be unambiguous.
...
interfaces.py: modified the return type of RIStatsProvider.get_stats to allow for None as a return value
NEWS.rst, stats.py: documentation of change to get_latencies
stats.rst: now documents percentile modification in get_latencies
test_storage.py: test_latencies now expects None in output categories that contain too few samples for the associated percentile to be unambiguously reported.
fixes #1392
2011-05-27 05:01:35 -07:00
secorp
d566e4632d
corrected "k must never be smaller than N" to "k must never be greater than N"
2011-04-24 18:03:08 -07:00
david-sarah
a817163cc6
docs: convert NEWS to NEWS.rst and change all references to it.
2011-05-16 18:02:55 -07:00
david-sarah
435dcfd6ff
docs: remove out-of-date docs/testgrid/introducer.furl and containing directory. fixes #1404
2011-05-12 07:05:59 -07:00
Zooko O'Whielacronx
f251bbece5
M-x whitespace-cleanup
2011-05-10 12:36:53 -07:00
Zooko O'Whielacronx
9619812a9d
docs: fix typo in running.rst, thanks to arch_o_median
2011-05-10 12:36:33 -07:00
Zooko O'Whielacronx
299e8ad579
replace remaining .html docs with .rst docs
...
Remove install.html (long since deprecated).
Also replace some obsolete references to install.html with references to quickstart.rst.
Fix some broken internal references within docs/historical/historical_known_issues.txt.
Thanks to Ravi Pinjala and Patrick McDonald.
refs #1227
2011-05-10 12:16:50 -07:00
Zooko O'Whielacronx
02cfdd2f03
docs: FTP-and-SFTP.rst: fix a minor error and update the information about which version of Twisted fixes #1297
2011-04-27 22:52:32 -07:00
Brian Warner
2b9d333835
update FTP-and-SFTP.rst: the necessary patch is included in Twisted-10.1
2011-03-25 16:25:11 -07:00
Brian Warner
0f3fe54530
docs/configuration.rst: add a "Frontend Configuration" section
...
this points to docs/frontends/*.rst, which were previously underlinked
2011-02-21 17:43:23 -08:00
Brian Warner
7a4f76fd90
update docs for the 1.8.2 release
2011-01-30 17:59:45 -08:00
Zooko O'Whielacronx
c1ec785b48
docs: edit running.html, change " http://allmydata.org " to " http://tahoe-lafs.org " in NEWS and README.txt, add Josh Wilcox to CREDITS for his contribution of doc patches
2011-01-28 07:07:00 -08:00
david-sarah
5299db9c04
docs/configuration.rst: fix a typo in the previous correction, and correct another error ('[storage]readonly_storage' should be '[storage]readonly').
2011-01-22 18:39:55 -08:00
david-sarah
41753dc42d
docs/configuration.rst: correct an error in the Example section ('[helper]run_helper' should be '[helper]enabled').
2011-01-22 18:23:04 -08:00
david-sarah
0f818d7cc4
docs/configuration.rst: correct the name of 'tahoe-client.tac' and document other .tac files. Also make the capitalization consistent in that section.
2011-01-22 18:00:11 -08:00
david-sarah
3eadc8a053
NEWS, docs/quickstart.html: pywin32 is no longer required on Windows. refs #1274
2011-01-21 18:47:41 -08:00
david-sarah
a9fc4668c0
docs/frontends/CLI.rst, src/allmydata/test/trialtest.py: add trailing newlines. refs #1296
2011-01-19 00:19:55 -08:00
david-sarah
bbc1f56981
Documentation for 'tahoe debug trial' (rebased for trunk). refs #1296
2011-01-18 12:57:29 -08:00
david-sarah
f10a2c0902
CLI: make 'tahoe create-alias' and 'tahoe add-alias' accept a trailing colon on the new alias name (v2, minor change not to rely on implicit Unicode conversion). Includes doc changes and news; tests in a separate patch. fixes #1305
2011-01-13 19:44:14 -08:00
Brian Warner
45212d8000
Set "reserved_space=1G" in newly-created storage nodes. Closes #1208 .
2011-01-16 12:58:22 -08:00
david-sarah
feed9977a9
docs/frontends/CLI.rst: fix the rst syntax to be as actually intended :-)
2011-01-08 17:40:57 -08:00
david-sarah
6c45f4d238
docs/frontends/CLI.rst: really fix rst syntax error this time.
2011-01-08 17:39:14 -08:00
david-sarah
98e2b15e3b
docs/frontends/CLI.rst: fix rst syntax error.
2011-01-08 17:09:43 -08:00
david-sarah
6ce3ec6d0d
docs/frontends/CLI.rst: discuss commandline/output quoting issues and wildcards. refs #1135
2011-01-08 17:01:19 -08:00
david-sarah
2b5b285dab
docs/FTP-and-SFTP.rst: document issue in ref #1297 . Remove known issue #1045 which is fixed. Also some cosmetic changes.
2011-01-07 22:10:38 -08:00
Zooko O'Whielacronx
3523b50716
docs: update performance.rst to describe the difference between already-uploaded and not-already-uploaded, to parameterize segment size, and to use "~A" to mean "approximately A"
2011-01-03 22:54:55 -08:00
david-sarah
6e0308be30
docs/quickstart.html: fix redundant, badly nested tag. refs #1284
2011-01-02 09:51:59 -08:00
david-sarah
4aec2e1e02
docs/quickstart.html: information about 'troublesome dependencies' and 'verified systems' de-emphasized by smaller italic font. Re-wrap so that the HTML source is readable (just about) as text. Minor wording tweaks. Improve organization by adding 'Windows Caveats' subsection. fixes #1284
2011-01-02 09:42:12 -08:00
david-sarah
be18ded062
docs/webapi.rst: typos.
2010-12-29 19:44:22 -08:00
david-sarah
53aeb3a3bc
docs/webapi.rst: capitalization, formatting of section on URL character encoding, and a correction about Internet Explorer.
2010-12-29 19:40:49 -08:00
david-sarah
83f97dcf7d
docs: corrections and clarifications.
2010-12-26 21:10:56 -08:00
david-sarah
45dd8b910a
docs: more formatting cleanups and corrections. Spell webapi and wapi as web-API.
2010-12-26 21:05:33 -08:00
david-sarah
7be2c73f08
docs/debian.rst: bring description of building dependencies from source up-to-date, and change hostname from allmydata.com to tahoe-lafs.org.
2010-12-12 14:29:12 -08:00
david-sarah
382b595d9e
docs/architecture.rst: correct rst syntax.
2010-12-12 12:20:03 -08:00
david-sarah
13bdf3a43d
docs/architecture.rst: formatting.
2010-12-12 12:17:19 -08:00
david-sarah
5c4ed235de
docs: linkification, wording improvements.
2010-12-12 12:12:34 -08:00
david-sarah
a86724ccd8
docs: formatting.
2010-12-12 12:11:15 -08:00
david-sarah
dfd9c8a949
docs/configuration.rst: more formatting tweaks; which -> that.
2010-12-12 11:55:22 -08:00
david-sarah
43ebdbb87d
docs/configuration.rst: more changes to formatting.
2010-12-12 11:45:11 -08:00
david-sarah
50b8a89c00
docs/configuration.rst: changes to formatting (mainly putting commands and filenames in monospace).
2010-12-12 10:18:28 -08:00
david-sarah
a02e871e7f
docs/frontends/CLI.rst: changes to formatting (mainly putting commands and filenames in monospace), and to command syntax to reflect that DIRCAP/... is accepted. Clarify the syntax of 'tahoe put' and other minor corrections. Tahoe -> Tahoe-LAFS.
2010-12-12 08:58:00 -08:00
david-sarah
c90fd96538
docs/frontends/CLI.rst: Unicode arguments to 'tahoe' work on Windows as of v1.7.1.
2010-12-11 22:37:40 -08:00
david-sarah
e35cbb7aef
docs/known_issues.rst: fix title and linkify another URL. refs #1225
2010-12-11 22:28:17 -08:00
david-sarah
64a4ef5966
docs/known_issues.rst: fix an external link. refs #1225
2010-12-11 22:24:35 -08:00
david-sarah
5f73c27b23
Fix a link from uri.rst to dirnodes.rst. refs #1225
2010-12-11 21:45:02 -08:00
david-sarah
341cad80ff
Fix a link from webapi.rst to FTP-and-SFTP.rst. refs #1225
2010-12-11 21:34:35 -08:00
david-sarah
5ce5faf0af
More specific hyperlink to architecture.rst from helper.rst. refs #1225
2010-12-11 21:26:07 -08:00
david-sarah
5d612c87ab
Update hyperlinks between docs, and linkify some external references. refs #1225
2010-12-11 21:14:59 -08:00
david-sarah
458b2de08b
docs/specifications/dirnodes.rst: fix references to mutable.rst. refs #1225
2010-12-11 17:27:20 -08:00
david-sarah
7da1885531
docs/specifications/mutable.rst: correct the magic string for v1 mutable containers. refs #1225
2010-12-11 17:14:00 -08:00
david-sarah
1d5c705201
Move .txt files in docs/frontends and docs/specifications to .rst. refs #1225
2010-12-11 17:02:51 -08:00
david-sarah
2100273ce3
Convert docs/frontends and docs/specifications to reStructuredText format (not including file moves).
2010-12-11 16:46:32 -08:00
david-sarah
940dd12227
quickstart.html: fix link to point to allmydata-tahoe-1.8.1.zip.
2010-11-28 14:17:28 -08:00
david-sarah
841dc76187
Release v1.8.1. refs #1242
2010-11-28 12:47:38 -08:00
Zooko O'Whielacronx
a4e9016482
docs: fix error in .rst formatting introduced by renaming Tahoe to Tahoe-LAFS in a header
2010-11-10 20:43:44 -08:00
Zooko O'Whielacronx
776eb31039
edit docs for English usage, rename "Tahoe" to "Tahoe-LAFS" in docs/configuration.rst, rename a variable in bin/tahoe-script.template for clarity, update François's CREDITS entry
2010-10-31 21:26:02 -07:00
david-sarah
5528af0524
docs/known_issues.rst: Add section on traffic analysis. Fix URL for current version of file.
2010-10-24 16:42:59 -07:00
david-sarah
679983bac6
docs/running.html: fix missing end-quote, and change frontends/ doc references to .rst.
2010-10-24 10:15:00 -07:00
david-sarah
1380fa9bb2
docs/running.html: 'tahoe create-client' now creates a node with storage disabled. Also change configuration.txt references to configuration.rst.
2010-10-24 10:04:31 -07:00
Zooko O'Whielacronx
9c01fdeb37
docs: update how-to-make-a-release doc with a few tweaks from the 1.8.0 process
2010-10-14 22:44:13 -07:00
Brian Warner
c4f8376a20
docs: fix tab-vs-spaces, make some CLI examples <tt>/"literal", wrap some to
...
80-cols, remove spurious whitespace. Add rst2html.py rule to Makefile.
2010-10-14 23:06:06 -07:00
Zooko O'Whielacronx
1e76d8ac39
docs: add Peter Secor, Shawn Willden, and Terrell Russell as signatories to docs/backdoors.rst
2010-10-14 22:32:42 -07:00
Zooko O'Whielacronx
8143183e39
docs: convert all .txt docs to .rst thanks to Ravi Pinjala
...
fixes #1225
2010-10-14 22:29:13 -07:00
Zooko O'Whielacronx
7c37292a09
docs: add statement on our refusal to insert backdoors
2010-10-05 22:11:47 -07:00
Zooko O'Whielacronx
6bf594ae13
docs: timestamp the 1.8.0 release
2010-09-23 19:15:52 -07:00
Zooko O'Whielacronx
2a5140b3b0
docs: update quickstart.html to include "In Case Of Trouble" and to mention Python 2.7
2010-09-23 19:08:51 -07:00
Zooko O'Whielacronx
79cfff8961
docs: mention default values of K, H, and M
2010-09-23 19:02:45 -07:00
david-sarah
41cee8a868
relnotes.txt and docs/quickstart.html for 1.8.0 release
2010-09-18 22:03:35 -07:00
david-sarah
3882692368
NEWS, docs/known_issues.txt for 1.8.0 release
2010-09-18 21:44:12 -07:00
Zooko O'Whielacronx
6eba4a2f8c
docs: a few simple updates to links and naming, and also recommend torsocks instead of the old, unmaintained tsocks, for use with Tor
2010-09-18 18:16:36 -07:00
david-sarah
b86404e796
docs/quickstart.html: note dependency on python development files, e.g. on Ubuntu
2010-09-13 21:04:56 -07:00
Zooko O'Whielacronx
6b60525523
docs: update relnotes.txt, NEWS, and quickstart.html for the 1.8.0c4 release
2010-09-11 23:14:23 -07:00
david-sarah
31f66c5470
docs/frontends/webapi.txt: document that the meaning of the 'healthy' field may change in future to reflect servers-of-happiness; refs #614
2010-09-10 17:31:47 -07:00
david-sarah
0091205e3c
docs/frontends/webapi.txt: note that 'count-good-share-hosts' is computed incorrectly; refs #1115
2010-09-10 17:25:48 -07:00
david-sarah
f32dddbced
docs/frontends/FTP-and-SFTP.txt: docs/performance.txt, architecture.txt: updates taking into account new downloader (revised). refs #798
2010-09-10 12:54:22 -07:00
david-sarah
7d8e17c443
docs/frontends/FTP-and-SFTP.txt: warn users about connecting to the FTP and SFTP servers remotely. Fixes #1192
2010-09-10 12:32:34 -07:00
marc.doudiet
95c62dc238
docs/frontends/FTP-and-SFTP.txt : ftpd and sftpd doesn't listen on loopback interface only
2010-08-13 07:08:53 -07:00
Zooko O'Whielacronx
b6c559e009
docs: a couple of small edits to CREDITS and how_to_make_a_tahoe-lafs_release.txt
2010-08-29 15:27:58 -07:00
Zooko O'Whielacronx
36f698b637
docs: doc of the download status page
...
ref: http://tahoe-lafs.org/trac/tahoe-lafs/ticket/1169#comment:1
2010-08-13 22:41:17 -07:00
david-sarah
a3b4d76815
quickstart.html: update tarball link.
2010-08-10 00:38:32 -07:00
david-sarah
5872f6c8cf
webapi.txt: fix grammatical error.
2010-08-09 23:41:27 -07:00
david-sarah
699eb25a78
NEWS, relnotes and known-issues for 1.8.0c2.
2010-08-09 23:28:51 -07:00
david-sarah
146c96d52e
how_to_make_a_tahoe-lafs_release.txt: add step to check that release will report itself as the intended version.
2010-08-06 17:42:54 -07:00
david-sarah
0cb4903593
NEWS, quickstart.html and known_issues.txt for 1.8.0c1 release.
2010-08-06 16:51:11 -07:00
Brian Warner
25bee8ade6
update NEWS and other docs in preparation for 1.8.0rc1
...
in particular, merge the various 1.8.0b1/b2 sections, and remove the
datestamp. NEWS gets updated just before a release, doesn't need to precisely
describe pre-release candidates, and the datestamp gets updated just before
the final release is tagged
Also, I removed the BOM from some files. My toolchain made it hard to retain,
and BOMs in UTF-8 don't make a whole lot of sense anyway. Sorry if that
messes anything up.
2010-08-06 01:02:28 -07:00
david-sarah
077108bbe9
relnotes.txt and docs/known_issues.txt for 1.8.0beta2.
2010-08-05 21:08:23 -07:00
david-sarah
9fc6ab1183
NEWS and docs/quickstart.html for 1.8.0beta2.
2010-08-05 20:51:12 -07:00
david-sarah
5ad9a86bc7
docs/quickstart.html: remove link to tahoe-lafs-ticket798-1.8.0b.zip, due to appname regression. refs #1159
2010-08-05 17:24:35 -07:00
david-sarah
ebfde4f09f
docs/quickstart.html: link to 1.8.0beta zip, and note 'bin\tahoe' on Windows.
2010-08-03 16:32:54 -07:00
david-sarah
74060f4ab8
docs/quickstart.html: extra step to open a new Command Prompt or log out/in on Windows.
2010-08-02 17:49:38 -07:00
Zooko O'Whielacronx
21daa70ee5
docs: update the list of forums to announce Tahoe-LAFS too, add empty checkboxes
2010-08-01 23:33:14 -07:00
david-sarah
e3b58b1e88
docs/specifications/dirnodes.txt: 'mesh'->'grid'.
2010-07-22 23:16:16 -07:00
david-sarah
497925317e
docs/specifications/dirnodes.txt: bring layer terminology up-to-date with architecture.txt, and a few other updates (e.g. note that the MAC is no longer verified, and that URIs can be unknown). Also 'Tahoe'->'Tahoe-LAFS'.
2010-07-22 22:47:03 -07:00
david-sarah
ac29012946
docs/known_issues.txt: update release version and date.
2010-07-18 16:59:40 -07:00
david-sarah
09d35bf6b4
relnotes.txt, docs/quickstart.html: prepare for 1.7.1 release. Don't claim to work on Cygwin (this might work but is untested).
2010-07-18 16:54:37 -07:00
david-sarah
974f38eac9
docs/logging.txt: document that _trial_temp/test.log does not receive messages below level=OPERATIONAL, due to < http://foolscap.lothar.com/trac/ticket/154 >.
2010-07-18 16:04:20 -07:00
jacob
ca660a5fc6
Debian documentation update
2010-03-04 18:30:04 -07:00
jacob
babbdf9494
debian-docs-patch-final
2010-03-04 02:59:55 -07:00
david-sarah
be6139dad7
docs/logging.txt: note that setting flogging vars might affect tests with race conditions.
2010-07-11 22:07:21 -07:00
david-sarah
3b1b0147a8
test_storage.py: potential fix for failures when logging is enabled.
1970-07-12 21:05:46 -07:00
david-sarah
5ade4f82e0
quickstart.html: python 2.5 -> 2.6 as recommended version
2010-07-05 10:58:58 -07:00
david-sarah
325ec1f6c2
docs/how_to_make_a_tahoe-lafs_release.txt: trivial correction, install.html should now be quickstart.html.
2010-06-25 15:39:29 -07:00
Zooko O'Whielacronx
0dd5f637fe
docs: about.html link to home page early on, and be decentralized storage instead of cloud storage this time around
2010-06-18 23:53:18 -07:00
Zooko O'Whielacronx
f1887bce90
docs: update about.html, especially to have a non-broken link to quickstart.html, and also to comment out the broken links to "for Paranoids" and "for Corporates"
2010-06-18 23:51:24 -07:00
Zooko O'Whielacronx
15b65ae54b
docs: update known_issues.txt with more detail about web browser "safe-browsing" features and slightly tweaked formatting
2010-06-18 22:17:34 -07:00
Zooko O'Whielacronx
09b0fd8bf4
docs: quickstart.html: link to 1.7.0 zip file and add UTF-8 BOM
2010-06-18 22:01:24 -07:00
Zooko O'Whielacronx
49912c106e
docs: apply patch from duck for #937 about "tahoe run" not working on introducers
2010-06-18 21:07:54 -07:00
david-sarah
4002c7aeb0
webapi.txt: fix statement about leap seconds.
2010-06-18 20:56:03 -07:00
david-sarah
8784e4a596
running.html: Tahoe->Tahoe-LAFS in what used to be using.html, and #tahoe->#tahoe-lafs (IRC channel).
2010-06-18 20:31:52 -07:00
david-sarah
4712875193
dirnode.py: stop writing 'ctime' and 'mtime' fields. Includes documentation and test changes.
2010-06-18 16:01:19 -07:00
david-sarah
6d669029bd
running.html: describe where 'bin/tahoe' is only once.
2010-06-16 20:36:03 -07:00
david-sarah
965f0dcfc3
Merge using.html into running.html.
2010-06-16 18:28:57 -07:00
david-sarah
1c7e71ee52
Remove firewall section from running.html and say to read configuration.txt instead.
2010-06-16 17:45:13 -07:00
david-sarah
29a9059c94
FTP-and-SFTP.txt: add Known Issues section.
2010-06-18 17:43:11 -07:00
david-sarah
e05c6c2c7d
FTP-and-SFTP.txt: remove description of public key format that is not actually implemented. Document that SFTP does not support server private keys with passphrases, and that FTP cannot list directories containing mutable files.
2010-06-18 17:17:38 -07:00
david-sarah
a92a23fe34
configuration.txt and servers-of-happiness.txt: 1 <= happy <= N, not k <= happy <= N. Also minor wording changes.
2010-06-17 22:07:10 -07:00
david-sarah
82d0f0c59e
how_to_make_a_tahoe-lafs_release.txt: reordering, add fuse-sshfs@lists.sourceforge.list as place to send relnotes.
2010-06-17 21:18:54 -07:00
david-sarah
e8636ee4be
running.html: fix overeager replacement of 'tahoe' with 'Tahoe-LAFS', and some simplifications.
2010-06-16 17:09:52 -07:00
Kevan Carstensen
7cadb49b88
Add a specification for servers of happiness.
2010-05-23 17:35:08 -07:00
Kevan Carstensen
a0a770a96a
Note that servers of happiness only applies to immutable files for the moment
2010-05-23 21:28:36 -07:00
Zooko O'Whielacronx
4141d95588
Add a note about running Tahoe-LAFS on a small grid to running.html
...
also Change "tahoe" and "Tahoe" to "Tahoe-LAFS" in running.html
author: Kevan Carstensen
2010-06-16 07:02:27 -07:00
david-sarah
22738db577
CLI.txt: introduce 'create-alias' before 'add-alias', document Unicode argument support, and other minor updates.
2010-06-10 15:55:47 -07:00
Zooko O'Whielacronx
8fc6c17a70
docs: a few tweaks to NEWS and CREDITS and make quickstart.html point to 1.7.0β!
2010-06-09 07:29:27 -07:00
francois
6cdf68785b
docs: wording fix, thanks to Jeremy Visser, fix #987
2010-06-09 01:11:03 -07:00
david-sarah
d7d0ae3c2c
FTP-and-SFTP.txt: minor technical correction to doc for 'no-write' flag.
2010-06-06 23:16:00 -07:00
Zooko O'Whielacronx
1fc6be28f4
setup: organize misc/ scripts and tools and remove obsolete ones
...
This is for ticket #1068 .
2010-06-06 22:16:18 -07:00
david-sarah
6476752467
quickstart.html: link to snapshots page, sorted with most recent first.
2010-06-06 15:11:27 -07:00
david-sarah
52f73207db
quickstart.html: We haven't released 1.7beta yet.
2010-06-06 15:03:01 -07:00
david-sarah
529add7774
Raise Python version requirement to 2.4.4 for non-UCS-2 builds, to avoid a critical Python security bug.
2010-06-04 20:17:13 -07:00
Francois Deppierraz
496802420e
Fix handling of correctly encoded unicode filenames ( #534 )
...
Tahoe CLI commands working on local files, for instance 'tahoe cp' or 'tahoe
backup', have been improved to correctly handle filenames containing non-ASCII
characters.
In the case where Tahoe encounters a filename which cannot be decoded using the
system encoding, an error will be returned and the operation will fail. Under
Linux, this typically happens when the filesystem contains filenames encoded
with another encoding, for instance latin1, than the system locale, for
instance UTF-8. In such case, you'll need to fix your system with tools such
as 'convmv' before using Tahoe CLI.
All CLI commands have been improved to support non-ASCII parameters such as
filenames and aliases on all supported Operating Systems except Windows as of
now.
2010-05-19 17:43:56 -07:00
david-sarah
29a06457d2
dirnode.py: fix a bug in the no-write change for Adder, and improve test coverage. Add a 'metadata' argument to create_subdirectory, with documentation. Also update some comments in test_dirnode.py made stale by the ctime/mtime change.
2010-06-01 20:26:41 -07:00
david-sarah
de95140b7b
SFTP: changes for #1063 ('no-write' field) including comment:1 (clearing owner write permission diminishes to a read cap). Includes documentation changes, but not tests for the new behaviour.
2010-05-31 22:11:39 -07:00
david-sarah
aa258b5800
quickstart.html: warn against installing Python at a path containing spaces.
2010-06-03 20:24:13 -07:00
david-sarah
87ddf54ed8
Minor documentation tweaks.
2010-06-02 22:44:58 -07:00
freestorm77
261923186b
doc_reformat_stats.txt
...
- Added heading format begining and ending by "=="
- Added Index
- Added Title
Note: No change are made in paragraphs content
**END OF DESCRIPTION***
Place the long patch description above the ***END OF DESCRIPTION*** marker.
The first line of this file will be the patch name.
This patch contains the following changes:
M ./docs/stats.txt -2 +2
2010-04-24 04:46:15 -07:00
freestorm77
be5604f0e0
doc_reformat_performance.txt
...
- Added heading format begining and ending by "=="
- Added Index
- Added Title
Note: No change are made in paragraphs content
2010-04-24 04:44:44 -07:00
freestorm77
6f224ad1fd
doc_refomat_logging.txt
...
- Added heading format begining and ending by "=="
- Added Index
- Added Title
Note: No change are made in paragraphs content
2010-04-24 04:43:16 -07:00
freestorm77
3af24d051d
doc_reformat_known_issues.txt
...
- Added heading format begining and ending by "=="
- Added Index
- Added Title
Note: No change are made in paragraphs content
2010-04-24 04:41:18 -07:00
freestorm77
c221ebff45
doc_reformat_helper.txt
...
- Added heading format begining and ending by "=="
- Added Index
- Added Title
Note: No change are made in paragraphs content
2010-04-24 05:06:49 -07:00
freestorm77
cfbc62c7f0
doc_reformat_garbage-collection.txt
...
- Added heading format begining and ending by "=="
- Added Index
- Added Title
Note: No change are made in paragraphs content
2010-04-24 05:08:30 -07:00
freestorm77
9ad0a93d49
doc_reformat_FTP-and-SFTP.txt
...
- Added heading format begining and ending by "=="
- Added Index
- Added Title
Note: No change are made in paragraphs content
2010-04-24 05:13:34 -07:00
freestorm77
c086314bd0
doc_reformat_debian.txt
...
- Added heading format begining and ending by "=="
- Added Index
- Added Title
Note: No change are made in paragraphs content
2010-04-24 05:05:37 -07:00
freestorm77
1381884173
doc_reformat_configuration.txt
...
- Added heading format begining and ending by "=="
- Added Index
- Added Title
Note: No change are made in paragraphs content
2010-04-24 03:49:03 -07:00
freestorm77
0641059ce6
doc_reformat_CLI.txt
...
- Added heading format begining and ending by "=="
- Added Index
- Added Title
Note: No change are made in paragraphs content
2010-04-24 05:15:12 -07:00
freestorm77
7ec83e9927
doc_reformat_backupdb.txt
...
- Added heading format begining and ending by "=="
- Added Index
- Added Title
Note: No change are made in paragraphs content
2010-04-24 05:04:16 -07:00
freestorm77
4232fa12dd
doc_reformat_architecture.txt
...
- Added heading format begining and ending by "=="
- Added Index
- Added Title
Note: No change are made in paragraphs content
2010-04-24 05:01:33 -07:00
Zooko O'Whielacronx
77aabe7066
docs: update docs/architecture.txt to more fully and correctly explain the upload procedure
2010-05-13 21:34:58 -07:00
Kevan Carstensen
4e29060847
Change stray "shares_of_happiness" to "servers_of_happiness"
2009-11-16 15:24:59 -07:00
kevan
1338318644
Update 'docs/architecture.txt' to reflect readonly share discovery
2010-05-13 17:38:52 -07:00
Kevan Carstensen
98325b40ee
Alter the wording in docs/architecture.txt to more accurately describe the servers_of_happiness behavior.
2010-04-27 17:24:55 -07:00
Kevan Carstensen
7c4c6f393e
Update 'docs/configuration.txt' to reflect the servers_of_happiness behavior.
2009-12-04 21:38:13 -07:00
david-sarah
56aa72fb2d
Clarify quickstart instructions for installing pywin32
2010-05-11 11:03:00 -07:00
Zooko O'Whielacronx
b771254b09
docs: install.html http-equiv refresh to quickstart.html
2010-04-21 09:57:08 -07:00
Zooko O'Whielacronx
a1fa80fc0c
docs: install.html -> quickstart.html
...
It is not called "installing" because that implies that it is going to change the configuration of your operating system. It is not called "building" because that implies that you need developer tools like a compiler. Also I added a stern warning against looking at the "InstallDetails" wiki page, which I have renamed to "AdvancedInstall".
2010-04-21 08:57:57 -07:00
jacob
8fddc7a4a5
desert-island-build-with-proper-versions
2010-03-03 17:38:58 -08:00
Zooko O'Whielacronx
34a50b857a
docs: a few small edits to try to guide newcomers through the docs
...
These edits were suggested by my watching over Jake Appelbaum's shoulder as he completely ignored/skipped/missed install.html and also as he decided that debian.txt wouldn't help him with basic installation. Then I threw in a few docs edits that have been sitting around in my sandbox asking to be committed for months.
2010-03-03 15:19:02 -08:00
david-sarah
e9ce5b2d6b
Change install.html to reference 1.6.1 instead of 1.6.0
2010-02-27 22:19:41 -08:00
Zooko O'Whielacronx
9433002235
docs: fix the asymptotic network performance of mutable file download in performance.txt, rename the howto-make-a-release file
2010-02-27 22:14:39 -08:00
Brian Warner
8ba5363196
docs/performance.txt: split out CPU from network, expand on mutable costs
2010-02-23 23:38:13 -05:00
Brian Warner
cc2fcd700c
docs/FTP: the Twisted patch (t3462) has landed, will be in the next release
2010-02-23 16:04:02 -05:00
Kevan Carstensen
09177a6e19
Update docs/frontends/webapi.txt to reflect the new expiration times in #577
2010-02-20 17:07:16 -08:00
Peter Secor
8f3246430b
docs running.html - "tahoe run ." does not work with the current installation, replaced with "tahoe start ."
2010-02-06 08:53:20 -08:00
Zooko O'Whielacronx
4d2c81d009
docs: install.html: link into Python 2.5.5 download page
2010-02-01 22:58:52 -08:00
Zooko O'Whielacronx
f0497e345d
docs: install.html: recommend Python 2.5 (because I can build extension modules for it with mingw), architecture.txt: point out that our Proof of Retrievability feature is client-side-only
2010-02-01 21:38:42 -08:00
Brian Warner
479492b1a9
architecture.txt: remove trailing whitespace, wrap lines: no content changes
2010-02-01 21:53:04 -08:00
Zooko O'Whielacronx
be1dac0e56
docs: a few small edits to performance.txt and README
2010-02-01 21:27:50 -08:00
Kevan Carstensen
7094f11a28
Fill in 'docs/performance.txt' with some performance information
2010-02-01 16:59:14 -08:00
Zooko O'Whielacronx
da13cacd41
docs: a few edits to architecture.txt, most significantly highlighting "future work" to avoid confusing it with the current version, and adding a "future work" about a random-sampling Proof of Retrievability verifier
2010-02-01 20:51:17 -08:00
david-sarah
8a43361aaa
Document leakage of cap URLs via phishing filters in known_issues.txt
2010-02-01 17:52:38 -08:00
Zooko O'Whielacronx
57e3af1447
docs: updates to relnotes.txt, NEWS, architecture, historical_known_issues, install.html, etc.
2010-02-01 10:18:09 -08:00
david-sarah
e2ee725d7d
Fix invalid trailing commas in JSON example
2010-01-29 12:17:42 -08:00
david-sarah
f1fd703ded
Fix example JSON in webapi.txt that cannot occur in practice
2010-01-28 19:27:42 -08:00
david-sarah
3e35959e9b
Add mutable field to t=json output for unknown nodes, when mutability is known
2010-01-28 19:14:24 -08:00
david-sarah
b9eda4de6a
Address comments by Kevan on 833 and add test for stripping spaces
2010-01-27 15:06:42 -08:00
david-sarah
56c00cb381
Miscellaneous documentation, test, and code formatting tweaks.
2010-01-26 23:03:09 -08:00
david-sarah
6057bc02cc
Prevent mutable objects from being retrieved from an immutable directory, and associated forward-compatibility improvements.
2010-01-26 22:44:30 -08:00
Brian Warner
b4d3e23024
docs: fix references to --no-storage, explanation of [storage] section
2010-01-27 12:09:56 -08:00
david-sarah
5c5a6fe610
Patch to accept t=set-children as well as t=set_children
2010-01-23 19:00:20 -08:00
Kevan Carstensen
26c6b806d7
Add 'docs/performance.txt', which (for the moment) describes mutable file performance issues
2010-01-15 12:45:00 -08:00
david-sarah
66646d9dd6
Warn about test failures due to setting FLOG* env vars
2010-01-24 14:06:29 -08:00
david-sarah
5c04fd689a
Change running.html to describe 'tahoe run'
2010-01-11 20:44:09 -08:00
david-sarah
87f1bae7fe
Add create-node CLI command, and make create-client equivalent to create-node --no-storage ( fixes #760 )
2010-01-15 21:20:55 -08:00
Brian Warner
d3d1293d2f
change docs and --help to use "grid" instead of "virtual drive": closes #892 .
...
Thanks to David-Sarah Hopwood for the patch.
2010-01-14 12:11:19 -08:00
Brian Warner
7143707178
backupdb.txt: fix ST_CTIME reference
2010-01-14 11:40:52 -08:00
Zooko O'Whielacronx
47003fdc07
docs: fix helper.txt to describe new config style
2009-12-24 14:35:22 -08:00
Brian Warner
c4c9683766
docs/stats.txt: add TOC, notes about controlling gatherer's listening port
...
Thanks to Jody Harris for the suggestions.
2009-12-24 15:21:33 -05:00
Brian Warner
950b1d80bb
Add docs/stats.py, explaining Tahoe stats, the gatherer, and the munin plugins.
2009-12-23 00:24:00 -05:00
Zooko O'Whielacronx
c1438805ce
docs: reflow architecture.txt to 78-char lines
2009-12-08 15:29:43 -08:00
Zooko O'Whielacronx
275da69ba4
docs: update the about.html a little
2009-12-08 13:27:37 -08:00
Zooko O'Whielacronx
95296e01a3
docs: remove obsolete doc file "codemap.txt"
...
I started to update this to reflect the current codebase, but then I thought (a) nobody seemed to notice that it hasn't been updated since December 2007, and (b) it will just bit-rot again, so I'm removing it.
2009-11-13 08:30:33 -08:00
Brian Warner
a6e25d0d2c
FTP-and-SFTP.txt: fix ssh-keygen pointer
2009-12-06 21:28:03 -08:00
david-sarah
ef002c935a
storage server: detect disk space usage on Windows too ( fixes #637 )
2009-11-20 21:56:44 -08:00
Brian Warner
31c9cb760a
update "tahoe backup" docs, and webapi.txt's mkdir-with-children
2009-11-27 00:59:00 -05:00
Brian Warner
9901a08fd3
Add dirnodes to backupdb and "tahoe backup", closes #606 .
...
* backups now share dirnodes with any previous backup, in any location,
so renames and moves are handled very efficiently
* "tahoe backup" no longer bothers reading the previous snapshot
* if you switch grids, you should delete ~/.tahoe/private/backupdb.sqlite,
to force new uploads of all files and directories
2009-11-26 15:42:57 -08:00
Brian Warner
6e7fb1006d
Use DIR-IMM and t=mkdir-immutable for "tahoe backup", for #828
2009-11-18 11:28:13 -08:00
Brian Warner
f85690697a
Add t=mkdir-immutable to the webapi. Closes #607 .
...
* change t=mkdir-with-children to not use multipart/form encoding. Instead,
the request body is all JSON. t=mkdir-immutable uses this format too.
* make nodemaker.create_immutable_dirnode() get convergence from SecretHolder,
but let callers override it
* raise NotDeepImmutableError instead of using assert()
* add mutable= argument to DirectoryNode.create_subdirectory(), default True
2009-11-17 23:09:00 -08:00
Brian Warner
768c76aa5f
webapi: use t=mkdir-with-children instead of a children= arg to t=mkdir .
...
This is safer: in the earlier API, an old webapi server would silently ignore
the initial children, and clients trying to set them would have to fetch the
newly-created directory to discover the incompatibility. In the new API,
clients using t=mkdir-with-children against an old webapi server will get a
clear error.
2009-10-25 18:13:21 -07:00
Brian Warner
b30041c5ec
webapi: t=mkdir now accepts initial children, using the same JSON that t=json
...
emits.
client.create_dirnode(initial_children=) now works.
2009-10-12 19:34:44 -07:00
Brian Warner
f03e87d081
webapi.txt: document t=set_children, other small edits
2009-10-09 13:04:46 -07:00
Brian Warner
7ef99c5e33
CHK-hashes.svg: cross out plaintext hashes, since we don't include
...
them (until we finish #453 )
2009-10-04 18:08:03 -07:00
Zooko O'Whielacronx
ffd5135fed
docs: edits for docs/running.html from Sam Mason
2009-08-09 13:14:16 -07:00
Zooko O'Whielacronx
0e8b299588
docs: install.html: instruct Debian users to use this document and not to go find the DownloadDebianPackages page, ignore the warning at the top of it, and try it
...
http://allmydata.org/pipermail/tahoe-dev/2009-August/002507.html
2009-08-04 05:38:40 -07:00
Zooko O'Whielacronx
d494ff24c7
docs: about.html: fix English usage noticed by Amber
2009-08-01 22:05:33 -07:00
Zooko O'Whielacronx
200f7f5cb3
docs: fix mis-spelled word in about.html
2009-08-01 22:03:20 -07:00
Zooko O'Whielacronx
5b84dde946
docs: update install.html to point to 1.5.0 and edit the instructions (broadening the recommendation on Python versions to bless >= v2.4.2 <= v2.6.x)
2009-08-01 20:05:23 -07:00
Zooko O'Whielacronx
2a63fc9159
docs: update relnotes.txt, relnotes-short.txt, and others documentation bits for v1.5.0 release!
2009-08-01 19:57:10 -07:00
Zooko O'Whielacronx
a12ca6e228
docs: about.html: edit (hopefully improve) the "What Makes Tahoe-LAFS Different" copy
2009-08-01 19:27:33 -07:00
Brian Warner
ad45511156
ftpd: update docs, point to Twisted ticket for the proposed patch
2009-07-31 11:32:26 -07:00
Shawn Willden
3782c27ac5
Lossmodel updates
...
Various improvements to the lossmodel, plus addition of README.lossmodel
that provides a link to the PDF.
2009-07-28 15:44:30 -07:00
Zooko O'Whielacronx
e42d180ad7
docs: remove extra <h1> from install.html (thanks, David-Sarah Hopwood)
2009-07-26 07:24:36 -07:00
Zooko O'Whielacronx
4ff97e6fbc
docs: mention pywin32 earlier
2009-07-26 06:34:52 -07:00
Zooko O'Whielacronx
70beaeea43
docs: introducing "provider-independent security"; Nathan Wilcox gave me good advice on how to be more specific in terminology when making security claims so as not fit in with the background noise of overblown and indefensible claims that is always buzzing in the security world
2009-07-21 20:17:50 -07:00
Zooko O'Whielacronx
20fe8cdac4
docs: edit about.html, add P.S. about expansion of LAFS, add Andrew Orlowski to media list
2009-07-21 19:24:30 -07:00
Zooko O'Whielacronx
20ae6bdc57
docs: update NEWS, about.html, relnotes-short.txt, and known_issues.txt in preparation for v1.5.0
...
Especially note that strong claims of specialness that I've added, e.g. in about.html .
2009-07-21 16:43:11 -07:00
Zooko O'Whielacronx
abd2ff6ba5
docs: a couple of minor edits to NEWS and docs/architecture.txt
2009-07-20 18:41:12 -07:00
Brian Warner
bf1e61c8f3
Touch up #705 changes:
...
webapi.txt: clarify replace=only-files argument, mention replace= on POST t=uri
test_cli.py: insert whitespace between logical operations
web.common.parse_replace_arg: make it case-insensitive, to match the docs
2009-07-20 11:38:03 -04:00
kevan
3a9f1f2952
Update webapi docs to reference new PUT behavior.
2009-07-19 20:44:47 -07:00
Brian Warner
9b18930c2f
docs/backupdb.txt: small fixes, thanks to David Triendl
2009-07-19 18:04:56 -07:00
Brian Warner
5501983f5f
proposed/mutable-DSA.txt: add some new design criteria
2009-07-11 14:25:00 +01:00
Brian Warner
ef1b6ae8e3
Tolerate unknown URI types in directory structures. Part of #683 .
...
The idea is that future versions of Tahoe will add new URI types that this
version won't recognize, but might store them in directories that we *can*
read. We should handle these "objects from the future" as best we can.
Previous releases of Tahoe would just explode. With this change, we'll
continue to be able to work with everything else in the directory.
The code change is to wrap anything we don't recognize as an UnknownNode
instance (as opposed to a FileNode or DirectoryNode). Then webapi knows how
to render these (mostly by leaving fields blank), deep-check knows to skip
over them, deep-stats counts them in "count-unknown". You can rename and
delete these things, but you can't add new ones (because we wouldn't know how
to generate a readcap to put into the dirnode's rocap slot, and because this
lets us catch typos better).
2009-07-02 18:07:49 -07:00
Brian Warner
2c0f418cc0
add docs/proposed/GridID.txt (cleaning out some of my old branches)
2009-06-21 12:12:04 -07:00
Zooko O'Whielacronx
5390f3ea4f
docs: remove warning about inability to build modules on py2.6 on Windows with mingw, differentiate between clients and servers, reflow to a consistent column width (79), add hint about firewall/NAT docs.
2009-06-21 10:50:05 -07:00
Zooko O'Whielacronx
3db5de5846
setup: edit install.html to warn Windows users away from Python v2.6
2009-06-11 15:55:06 -07:00
Zooko O'Whielacronx
8c18ac38a9
backup: remove the --no-backupdb command, the handling of "can't import sqlite", and the related tests, and change an error message to more correctly indicate failure to load the database from disk rather than failure to import sqlite module
...
Fixes #728 .
2009-06-04 10:31:31 -07:00
Zooko O'Whielacronx
9a02f4a104
docs: small edit to about.html
2009-05-28 16:34:22 -07:00
Zooko O'Whielacronx
78a98d2ad8
docs: add links to Tahoe-LAFS for Paranoids and Tahoe-LAFS for Corporates in about.html
2009-05-28 16:27:17 -07:00
Zooko O'Whielacronx
078c755ee8
docs: edit about.html and include network-and-reliance-topology.png (loaded from http://allmydata.org )
2009-05-27 08:09:16 -07:00
Zooko O'Whielacronx
ed71e2b8a8
docs: a few more edits to network-and-reliance-topology.svg
2009-05-27 08:04:58 -07:00
Zooko O'Whielacronx
a799dd66fc
docs: update network-and-reliance-topology.svg for beauty and clarity
2009-05-26 20:11:23 -07:00
Zooko O'Whielacronx
a19c5e659e
docs: network-and-reliance-topology.svg: nicer server icons, mv out of the "specifications" subdir
2009-05-26 09:58:42 -07:00
Zooko O'Whielacronx
1e77e961a2
docs: update network-and-reliance-topology.svg
2009-05-26 09:31:05 -07:00
Brian Warner
591d0fb5fb
accounting-overview.txt: more edits
2009-05-23 12:03:59 -07:00
Brian Warner
b94012ed05
accounting-overview.txt: small edits
2009-05-23 11:40:11 -07:00
Zooko O'Whielacronx
e7e13958c2
docs: add a diagram that I'm about to show to the Boulder Linux Users Group: network-and-reliance-topology.svg
2009-05-14 16:20:59 -07:00
Zooko O'Whielacronx
5c6145c695
docs: how_to_make_a_tahoe_release.txt: a couple of small edits
2009-05-07 14:49:32 -07:00
Zooko O'Whielacronx
8c687c78da
docs: inaugurate Tahoe-1.4.1, since I left out a handful of patches from the Tahoe-1.4.0 release
2009-04-13 19:54:30 -07:00
Zooko O'Whielacronx
0b2d036fd5
docs: add "darcs pull" to how_to_make_a_tahoe_release.txt, and renumber
2009-04-13 19:43:42 -07:00
Zooko O'Whielacronx
79b6706038
docs: add note about pywin32 to install.html
2009-04-13 11:52:10 -07:00
Zooko O'Whielacronx
a2f34b4e1a
docs: a few edits/updates about dirnodes
2009-04-13 09:08:37 -07:00
Zooko O'Whielacronx
9ccdb05e00
docs: change install.html to point to the 1.4.0 release zip file instead of 1.3.0
2009-04-13 09:06:49 -07:00
Zooko O'Whielacronx
4581b23333
docs: edit install.html regarding versions of Python
2009-04-13 09:06:12 -07:00
Zooko O'Whielacronx
6d31501275
docs: some small edits to install.html
2009-04-13 09:04:14 -07:00
Zooko O'Whielacronx
66ccf0e426
docs: update relnotes.txt, NEWS for Tahoe-1.4.0 release!
2009-04-12 21:14:05 -07:00
Zooko O'Whielacronx
9729753692
dirnode: add 'tahoe'/'linkcrtime' and 'tahoe'/'linkmotime' to take the place of what 'mtime'/'ctime' originally did, and make the 'tahoe' subdict be unwritable through the set_children API
...
Also add extensive documentation in docs/frontends/webapi.txt about the behaviors of these values. See ticket #628 .
2009-04-11 15:52:05 -07:00
Zooko O'Whielacronx
664b69dd8d
docs: webapi.txt edits to explain a few things better, adjust indentation, editing
2009-04-11 15:48:28 -07:00
Zooko O'Whielacronx
37c6e77764
wui: edit some of the human-readable parts of the wui such as button labels
...
(The word "parent" suggests that you can go up a directory hierarchy -- perhaps that word is vestigial.)
2009-04-07 11:54:59 -07:00
Brian Warner
3d2bc909aa
docs: modify how-to-relase notes a tiny bit
2009-04-06 19:11:35 -07:00
Zooko O'Whielacronx
438bc67548
docs: setup: Norm Hardy suggested that it would be easier if users realized that they already had Python (especially true for Mac users)
2009-03-24 20:54:59 -07:00
Brian Warner
32250e0c06
docs/proposed: new Accounting overview, discuss in #666
2009-03-23 18:57:52 -07:00
Brian Warner
5f2f95a51e
docs/proposed: move old accounting docs out of the way
2009-03-23 18:54:57 -07:00
Brian Warner
b5d4972a7a
move GC docs out of proposed/, since it's all implemented now. Add reference to configuration.txt . Add expire.*= suggestions to tahoe.cfg .
2009-03-23 16:08:20 -07:00
Brian Warner
f0071c2571
expirer: clean up constructor args, add tahoe.cfg controls, use cutoff_date instead of date_cutoff
2009-03-18 18:00:09 -07:00
Brian Warner
babcf632da
util/time_format: new routine to parse dates like 2009-03-18, switch expirer to use it. I'd prefer to use 18-Mar-2009, but it is surprisingly non-trivial to build a parser that will take UTC dates instead of local dates
2009-03-18 17:58:14 -07:00
Brian Warner
c7254c5f1d
GC: add date-cutoff -based expiration, add proposed docs
2009-03-16 22:10:41 -07:00
Zooko O'Whielacronx
dd559e96b4
doc: update how_to_make_a_tahoe_release.txt
2009-02-22 11:57:39 -07:00
Brian Warner
f42e3bb107
web: full patch for HTML-vs-plaintext traceback renderings, improve test coverage of exception rendering
2009-03-03 21:56:30 -07:00
Brian Warner
fd4ceb6a87
webapi: modify streaming deep-manifest/deep-checker to emit an ERROR: line if they encounter an unrecoverable+untraversable directory. For #590 .
2009-02-24 23:13:35 -07:00
Alberto Berti
e1c925b373
Two small fixes on documentation for cli backup command.
2009-02-24 16:36:34 -07:00
Alberto Berti
82352add22
Added documentation for '--exclude' and friends cli backup command.
2009-02-24 09:30:49 -07:00
Brian Warner
4ab3397992
docs: move many specification-like documents into specifications/
2009-02-21 23:40:54 -07:00
Brian Warner
c86acc42f4
docs: add lease-tradeoffs diagram
2009-02-18 14:41:37 -07:00
Brian Warner
505220f27d
docs/debian.txt: minor edit
2009-02-17 21:22:12 -07:00
Brian Warner
bce4a5385b
add --add-lease to 'tahoe check', 'tahoe deep-check', and webapi.
2009-02-17 19:32:43 -07:00
Brian Warner
fde2289e7b
CLI #590 : convert 'tahoe deep-check' to streaming form, improve display, add tests
2009-02-17 17:15:11 -07:00
Brian Warner
476a5c8fac
webapi #590 : add streaming deep-check. Still need a CLI tool to use it.
2009-02-16 23:35:53 -07:00
Zooko O'Whielacronx
820f8af97c
doc: a few edits to docs made after the 1.3.0 release
2009-02-16 14:15:39 -07:00
Brian Warner
ee956ffc7d
lossmodel.lyx: move draft paper into docs/proposed/, since it's unfinished
2009-02-15 16:19:05 -07:00
Shawn Willden
51ab76875b
More lossmodel work, on repair.
2009-01-15 20:56:48 -07:00
Shawn Willden
d65b0ff911
Loss model work (temp1)
2009-01-14 21:00:58 -07:00
Shawn Willden
21832280da
Statistics module
...
Added a statistics module for calculating various facets of
share survival statistics.
2009-01-13 20:12:35 -07:00
Zooko O'Whielacronx
967d1b414d
docs: a few last-minute edits to the docs for 1.3.0 (also this patch will accompany the tag and conveniently trigger the buildbots to build a 1.3.0 version)
2009-02-13 18:05:00 -07:00
Zooko O'Whielacronx
de8e72e27b
docs: known_issues.txt: my version of #615 , remove "issue numbers", edits, move tahoe-1.1.0 issues to historical
2009-02-12 22:16:21 -07:00
Brian Warner
1bf0515484
docs/known_issues: mention #615 javascript-vs-frames, for zooko to improve/rewrite
2009-02-11 14:14:53 -07:00
Zooko O'Whielacronx
2dcadfaa1b
docs: small edit to about.html
2009-02-10 11:02:19 -07:00
Zooko O'Whielacronx
390de8aaa4
docs: edit about.html
2009-02-10 02:01:02 -07:00
Zooko O'Whielacronx
1d13be3701
docs: suggest Python 2.5 -- Python 2.6 is not as well tested yet
2009-02-09 23:44:21 -07:00
Brian Warner
bbef104315
docs/specifications: add an outline of the spec documents we'd like to have some day
2009-02-08 17:47:48 -07:00
Brian Warner
177ffa0870
docs/CLI: document 'tahoe backup'
2009-02-05 22:14:45 -07:00
Brian Warner
ca32db5b39
#598 : add cli+backupdb tests, improve user display, update docs, move docs out of proposed/
2009-02-05 22:07:01 -07:00
Zooko O'Whielacronx
23fd9680cc
doc: specify Python >= 2.4.2
2009-02-04 15:38:40 -07:00
Zooko O'Whielacronx
1ef317d585
docs: mention issues using flogtool on Windows
2009-02-03 21:34:10 -07:00
Brian Warner
4e572a5f24
webapi: add verifycap (spelled 'verify_url') to the t=json output on files and directories. Closes #559 .
2009-02-03 19:22:48 -07:00
Brian Warner
af8d282f46
CLI.txt: improve docs on 'tahoe manifest' to cover --verify-cap, --repair-cap, and streaming JSON
2009-01-23 16:59:39 -07:00
Brian Warner
26260374e9
#590 : add webish t=stream-manifest
2009-01-22 22:01:36 -07:00
Zooko O'Whielacronx
7d91dc5efe
rollback the feature of making "ambient upload authority" configurable
...
This reverses some, but not all, of the changes that were committed in the following set of patches.
rolling back:
Sun Jan 18 09:54:30 MST 2009 toby.murray
* add 'web.ambient_upload_authority' as a paramater to tahoe.cfg
M ./src/allmydata/client.py -1 +3
M ./src/allmydata/test/common.py -7 +9
A ./src/allmydata/test/test_ambient_upload_authority.py
M ./src/allmydata/web/root.py +12
M ./src/allmydata/webish.py -1 +4
Sun Jan 18 09:56:08 MST 2009 zooko@zooko.com
* trivial: whitespace
I ran emacs's "M-x whitespace-cleanup" on the files that Toby's recent patch had touched that had trailing whitespace on some lines.
M ./src/allmydata/test/test_ambient_upload_authority.py -9 +8
M ./src/allmydata/web/root.py -2 +1
M ./src/allmydata/webish.py -2 +1
Mon Jan 19 14:16:19 MST 2009 zooko@zooko.com
* trivial: remove unused import noticed by pyflakes
M ./src/allmydata/test/test_ambient_upload_authority.py -1
Mon Jan 19 21:38:35 MST 2009 toby.murray
* doc: describe web.ambient_upload_authority
M ./docs/configuration.txt +14
M ./docs/frontends/webapi.txt +11
Mon Jan 19 21:38:57 MST 2009 zooko@zooko.com
* doc: add Toby Murray to the CREDITS
M ./CREDITS +4
2009-01-20 20:47:35 -07:00
Zooko O'Whielacronx
9f49f3fabb
setup: use setup.cfg aliases to map "setup.py test" to "setup.py trial" and "setup.py build" to "setup.py darcsver --count-all-patches build_tahoe"
...
Thanks to dpeterson for the suggestion.
2009-01-20 12:37:23 -07:00
toby.murray
c5a5b22c17
doc: describe web.ambient_upload_authority
2009-01-19 22:38:35 -07:00
Zooko O'Whielacronx
2dc8398886
setup: simplify install.html a tad
2009-01-19 15:04:47 -07:00
Brian Warner
26ca53fa3d
node.py: use NODEDIR/tmp for the 'tempfile' module's temporary directory, so webapi upload tempfiles are put there instead of /tmp . You can set it to something else by setting [node]tempdir in tahoe.cfg
2009-01-14 20:00:15 -07:00
Brian Warner
4334ee056b
webapi.txt: explain POST /uri/?t=upload, thanks to Toby Murray for the catch
2009-01-14 18:08:03 -07:00
Zooko O'Whielacronx
0a2895e17a
docs: rename wapi.txt to webapi.txt
...
Because Brian argues that the file contains a description of the wui as well as of the wapi, and because the name "webapi.txt" might be more obvious to the untrained eye.
2009-01-14 13:53:48 -07:00
Zooko O'Whielacronx
c360bf604a
docs: rename frontends/webapi.txt to frontends/wapi.txt
...
rename CLI.txt to frontends/CLI.txt
change a few mentions of "webapi" to "wapi"
fixes #582
2009-01-13 20:51:43 -07:00
Zooko O'Whielacronx
a56df2587a
setup: remove custom Trial class inside our setup.py and use the setuptools_trial plugin
2008-12-05 17:22:07 -07:00
Brian Warner
7ee336b274
webapi/deep-manifest t=JSON: don't return the (large) manifest/SI/verifycap lists unless the operation has completed, to avoid the considerable CPU+memory cost of creating the JSON (for 330k dirnodes, it could take two minutes to generate 275MB of JSON). They must be paid eventually, but not on every poll
2009-01-08 19:59:32 -07:00
Zooko O'Whielacronx
5e6f90a015
rename "checker results" to "check results", because it is more parallel to "check-and-repair results"
2009-01-06 13:37:03 -07:00
Zooko O'Whielacronx
aa1ffa8ecf
docs: update install.html to recommend Python v2 instead of Python v2.5.2
2009-01-03 12:31:00 -07:00
cgalvan
1c816b1670
merge_install.patch
2009-01-02 10:44:34 -07:00
Zooko O'Whielacronx
d45780faf0
setup: new install doc -- doesn't require GNU make or a C++ compiler any more!
2008-12-01 12:09:33 -07:00
cgalvan
f1feb08f6a
remove_sumo_install.patch
2009-01-02 10:23:47 -07:00
Zooko O'Whielacronx
169c695801
docs: editing changes and updated news in known_issues.txt
2008-12-30 01:01:16 -07:00
Zooko O'Whielacronx
698dbfa78a
docs: split historical/historical_known_issues.txt out of known_issues.txt
...
All issues which are relevant to users of v1.1, v1.2, or v1.3 go in known_issues.txt. All issues which are relevant to users of v1.0 go in historical/historical_known_issues.txt.
2008-12-30 00:52:26 -07:00
Zooko O'Whielacronx
872e4fc84d
doc: sundry amendments to docs and in-line code comments
2008-12-28 16:59:54 -07:00
Zooko O'Whielacronx
bfa7794535
doc: add mention of "tahoe create-alias" in the security-warning section of CLI.txt
2008-12-24 15:16:46 -07:00
Zooko O'Whielacronx
57d11ad1b8
doc: trivial: remove trailing whitespace
2008-12-24 15:16:34 -07:00
Zooko O'Whielacronx
5c4049210b
doc: warn that unicode might not work, in CLI.txt
2008-12-24 15:16:18 -07:00
Zooko O'Whielacronx
e00319f051
doc: use the term "filesystem" rather than "virtual drive" in CLI.txt
2008-12-24 15:16:14 -07:00
Zooko O'Whielacronx
8b7ce325d7
immutable, checker, and tests: improve docstrings, assertions, tests
...
No functional changes, but remove unused code, improve or fix docstrings, etc.
2008-12-21 15:07:52 -07:00
Zooko O'Whielacronx
c3edae5158
finish renaming 'subshare' to 'block' in immutable/encode.py and in docs/
2008-12-09 16:33:18 -07:00
Brian Warner
d1d2d0b686
webapi.txt: minor edits
2008-12-08 15:32:56 -07:00
Zooko O'Whielacronx
c43d7dd5f0
setup: one more address to send release announcements to
2008-12-02 19:50:40 -07:00