ExternalVendorCode/tahoe-lafs
1
0
Fork 0
mirror of https://github.com/tahoe-lafs/tahoe-lafs.git synced 2024-12-26 16:11:08 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
13,673 Commits 185 Branches 90 Tags 89 MiB
c632aa1de1
Commit Graph

1374 Commits

Author SHA1 Message Date
meejah
05f48c3601 Various cleanups, fixes and improvements 
Squashed all commits that were meejah's between
30d68fb499f300a393fa0ced5980229f4bb6efda
and
33c268ed3a8c63a809f4403e307ecc13d848b1ab
On the branch meejah:1382.markberger-rewrite-rebase.6 as
per review
 2017-06-05 16:31:41 -06:00
meejah
b6d9945b95 default answer for every share 
refactor hypothesis to be 'pytest style' and add another one

get rid of 'shares->set(1 thing)' in generate_mappings return

Add a unittest hypothesis came up with

fix tests since we return peers, not sets-of-1-peer

add more debug

add a unit-test that's like test_problem_layout_ticket_1128

fix bug

add a note

fix utest

unit-test for bigger numbers

re-insert markberger code for testing

results of pairing with david
 2017-06-05 16:26:46 -06:00
meejah
adb9a98383 WIP: refactoring (squahshed all meejah's commits) 2017-06-05 16:26:46 -06:00
Brian Warner
211dc602fa updates from summit 2017-06-05 16:26:46 -06:00
Mark Berger
17cff7a176 Implements 'Servers of Happiness' algorithm for upload 
This is Mark Berger's original commits, from ticket #1382
 2017-06-05 16:26:46 -06:00
tpltnt
2af8e69750 OpenSolaris is discontinued, naming illumos 2017-06-05 10:35:37 +01:00
Brian Warner
ce47f6aaee NEWS/INSTALL/relnotes: release 1.12.1 2017-01-18 16:28:23 -08:00
Brian Warner
582931b1c2 docs: recommend proper introducers.yaml syntax 
add a test to exercise that this syntax is parseable, and another to point
out that the previously-recommended syntax was not

refs ticket:2862
 2017-01-08 22:59:51 -08:00
Vladimir Rusinov
b7e76c7f24 Document api-version field for deep-stats. 2016-12-23 22:50:48 -05:00
Brian Warner
0efc24cd79 how-to-release: 'twine register' is no longer necessary 2016-12-17 15:07:29 -08:00
Brian Warner
120ef7ee86 docs/INSTALL: update pointers for 1.12.0 2016-12-17 14:36:18 -08:00
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