ExternalVendorCode/tahoe-lafs
1
0
Fork 0
mirror of https://github.com/tahoe-lafs/tahoe-lafs.git synced 2024-12-28 00:38:52 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
14,110 Commits 185 Branches 90 Tags 89 MiB
6c0e5f5807
Commit Graph

1404 Commits

Author SHA1 Message Date
meejah
a3dc7123e8 revert whitespace 2019-06-22 23:39:21 -06:00
meejah
78a13aad43 cryptography back into docs 2019-06-13 22:19:28 -06:00
meejah
b67ef21a21 whitespace 2019-06-13 22:19:28 -06:00
heartsucker
33090ef6e2 remove last remaining references to pycryptopp 2019-06-13 22:19:28 -06:00
heartsucker
b6da2cb6e8 remove references to pycryptopp from docs 2019-06-13 22:18:55 -06:00
Jean-Paul Calderone
6667988733 May as well link this into the main docs as well 2019-03-15 13:11:39 -04:00
Brian Warner
495156ddaa docs: describe BTC/development agreement with Aspiration 
update docs/donations.rst with the transfer address
 2018-12-28 11:32:50 -06:00
meejah
dc240c7ac3 add concept of Release Maintainer 2018-08-21 12:19:21 -06:00
meejah
05ea484876 add note about dockerhub 2018-07-17 13:50:59 -06:00
meejah
bd4643cd5b tweak checklist, add more command-lines 2018-07-17 13:48:08 -06:00
meejah
70c7c36b9f re-update the key-ids 2018-07-17 13:48:08 -06:00
meejah
66349c49eb update to full key-ids 2018-07-17 13:48:08 -06:00
meejah
ef8bc55ce0 correct order, org-mode counts 2018-07-17 13:48:08 -06:00
meejah
1a6ba867d1 fixups from review 2018-07-17 13:48:08 -06:00
meejah
74d8cef679 add command-line 2018-07-17 13:48:08 -06:00
meejah
dc8327bdef remove 'original checklist' after confirming it's all covered by new 2018-07-17 13:48:08 -06:00
meejah
966d34deb3 tweak list, and ensure all original points are in new list 2018-07-17 13:48:08 -06:00
meejah
ebf61a84f4 preliminary copy-pasta of the "pad" document 2018-07-17 13:48:08 -06:00
Jean-Paul Calderone
4f04521fe5 encourage use of variables and copy/paste of command 2018-07-17 13:14:36 -04:00
Jean-Paul Calderone
fbd2374ef0 point to the new doc site 2018-07-03 13:03:48 -04:00
Jean-Paul Calderone
e1c1cd1637 Verisimilitude 2018-07-03 13:03:23 -04:00
Jean-Paul Calderone
8401201868 convey the basis for our prediction 
instead of the prediction.
we know the basis is true.
who knows about the prediction.
 2018-07-03 13:02:41 -04:00
Jean-Paul Calderone
e2ceb4f8e4 Spelling fix 2018-07-02 15:38:10 -04:00
Jean-Paul Calderone
de95a2092a Refer to wallet documentation 2018-07-02 15:34:35 -04:00
Jean-Paul Calderone
fad4ffe37e Point to the new doc from existing config docs 
Perhaps this will make it more likely folks will find the information.
 2018-07-02 15:29:51 -04:00
Jean-Paul Calderone
df7de6cb90 Document a convention for encouraging donations 
The convention smuggles an address in the node nickname and uses Zcash
shielded transactions for privacy.
 2018-07-02 15:24:10 -04:00
Jean-Paul Calderone
c48fec5b03
Merge pull request #499 from LeastAuthority/2925.http-storage-node-protocol-spec 
Add an initial "Great Black Swamp" protocol specification proposal.

Fixes ticket:2925
 2018-06-29 13:13:37 -04:00
Jean-Paul Calderone
687c4c8f4f Talk about lack of creation 2018-06-29 11:30:45 -04:00
Jean-Paul Calderone
635c0c5db0 Slots are not separately, explicitly created 2018-06-29 11:30:28 -04:00
Jean-Paul Calderone
250465f810 Discard base32 and SHA1. 2018-06-29 11:11:30 -04:00
Jean-Paul Calderone
ff12263ed5 remove an extra extra word 2018-06-27 16:53:37 -04:00
Jean-Paul Calderone
209c8694f9 Simplify language 2018-06-27 16:53:17 -04:00
Jean-Paul Calderone
4cd018fc11 Consistently name the gbs information 
And replace the flag with the full information otherwise the client
cannot find the gbs server without talking to the introducer again.
 2018-06-27 16:51:47 -04:00
Jean-Paul Calderone
4e5ec27d50 Use that : notation consistently here 2018-06-27 16:49:45 -04:00
Jean-Paul Calderone
145ee3b6ab mention the introducer 2018-06-27 16:39:02 -04:00
Jean-Paul Calderone
c43eacc3a9 clarify which party is vulnerable 2018-06-13 08:27:45 -04:00
Jean-Paul Calderone
c3011a434b Specify preferred encoding and encoding negotiation 2018-06-06 13:46:45 -04:00
Jean-Paul Calderone
b8cfee79e3 frame it a little more 2018-06-06 13:31:34 -04:00
Jean-Paul Calderone
4e10f7971a discuss decision to use query args 2018-05-29 10:52:37 -04:00
Jean-Paul Calderone
3d3c3d2eb4 elaborate on the transition stages 
talk about cases of each stage and desired behavior
 2018-05-22 09:57:39 -04:00
Jean-Paul Calderone
a592053b18 refer to GBS more than HTTP 2018-05-22 09:57:29 -04:00
Jean-Paul Calderone
534b8db318 markup and spelling 2018-05-22 09:57:18 -04:00
Jean-Paul Calderone
acf541a0be try to make the example more useful 2018-05-22 09:08:59 -04:00
Jean-Paul Calderone
504452f1fd clean up description of certificate validity period 2018-05-22 09:00:30 -04:00
Jean-Paul Calderone
ab37b5eabb clean up the description of the tls usage 2018-05-22 09:00:10 -04:00
Jean-Paul Calderone
65103445ea secrecy is the kind of security we're talking about here 2018-05-22 08:43:19 -04:00
Jean-Paul Calderone
97176e88d4 but it is part of this proposed solution 2018-05-22 08:43:12 -04:00
Jean-Paul Calderone
bf305b91e4 HTTP *per se* is not a requirement 2018-05-22 08:42:55 -04:00
Jean-Paul Calderone
5ede9662bb fix typo 2018-05-22 08:42:39 -04:00
Jean-Paul Calderone
44afc1de03 talk about a non-security requirement! 2018-05-22 08:42:28 -04:00
Jean-Paul Calderone
ff48e67418 flop some heading levels around 2018-05-22 08:42:16 -04:00
Jean-Paul Calderone
c321c937f6 copy edits and another option for tubID length 2018-05-22 08:27:31 -04:00
Jean-Paul Calderone
b73e95ec30 discuss protocol identification 2018-05-22 08:27:24 -04:00
Jean-Paul Calderone
17ae8a191b I like it 2018-05-22 08:27:15 -04:00
Jean-Paul Calderone
4592bf3de2 wip - more edits of the security material & transition plan 2018-05-21 16:23:53 -04:00
Jean-Paul Calderone
176732dcaf gotta announce the new fURL sometime 2018-05-21 14:59:46 -04:00
Jean-Paul Calderone
16076f9bd7 be explicit about the security goals being achieved 2018-05-21 14:59:28 -04:00
Jean-Paul Calderone
11184939e8 It's SPKI not public key 2018-05-21 14:59:10 -04:00
Jean-Paul Calderone
fa4384e36e add a security summary (noting foolscap features) 
also, expanded discussion.
 2018-05-21 14:14:53 -04:00
Jean-Paul Calderone
cea0ae8004 tahoe-lafs is already good at redundant storage 2018-05-21 14:14:39 -04:00
Jean-Paul Calderone
4626a09224 elaborate on reputation-based assumptions 2018-05-21 13:31:16 -04:00
Jean-Paul Calderone
931ffec005 semantic newlines 2018-05-21 13:31:10 -04:00
meejah
fb9317ed80 change versions in INSTALL 2018-05-18 14:41:48 -06:00
Jean-Paul Calderone
d09b613d59 make mutable and immutable read the same 2018-05-18 15:45:22 -04:00
Jean-Paul Calderone
f4b59b166d no more int-key mappings 2018-05-18 13:08:13 -04:00
Jean-Paul Calderone
3898911fcc consistent title levels 2018-05-18 13:07:18 -04:00
Jean-Paul Calderone
f09ed91ab6 collapse these two APIs, they are the same 
also add mutable .../shares listing
 2018-05-18 13:01:57 -04:00
Jean-Paul Calderone
9388903515 need a way to advise of corrupt mutable shares 2018-05-18 13:01:45 -04:00
Jean-Paul Calderone
c6a8e4535c mount this beneath the storage index resource 2018-05-18 13:01:19 -04:00
Jean-Paul Calderone
69195e0a5a maybe we don't even want Range 2018-05-18 13:01:10 -04:00
Jean-Paul Calderone
6c664d69a8 consistent non-abbreviation 2018-05-18 13:01:03 -04:00
Jean-Paul Calderone
9402698918 Harmonize hyphens 2018-05-18 11:11:04 -04:00
Jean-Paul Calderone
943b389d77 Banish slots and deemphasize buckets 2018-05-18 11:09:17 -04:00
Jean-Paul Calderone
3ef1ceeead markup 2018-05-18 09:13:57 -04:00
Jean-Paul Calderone
dd78fe81d0 note the failure case 2018-05-18 09:05:46 -04:00
Jean-Paul Calderone
fb51c1df40 correct the sample code 2018-05-18 09:05:37 -04:00
Jean-Paul Calderone
00ae3b5663 discuss encoded hash length 2018-05-18 09:05:25 -04:00
Jean-Paul Calderone
d3f9ee2406 link to a different upload resume strategy 2018-05-17 15:09:50 -04:00
Jean-Paul Calderone
113af95984 when you are sending a range, you use Content-Range 
when you are _asking_ for a range, you use Range
 2018-05-17 15:08:03 -04:00
Jean-Paul Calderone
2bbe51a01d Discuss Range requests for uploads 2018-05-17 14:11:37 -04:00
Jean-Paul Calderone
d011c2f936 rst twiddles 2018-05-17 14:11:32 -04:00
Jean-Paul Calderone
eb9b44885e simple naming mistake 
this must be a different endpoint or it is ambiguous with bucket
interactions.  plus it makes more sense that "place where storage
indexes are" is different from "place where buckets are" although I
am still uncomfortable with the idea that "storage indexes" are things
and not ... indexes ...
 2018-05-17 14:01:46 -04:00
Jean-Paul Calderone
4e99f22c2b make containers plural I suppose 2018-05-17 14:01:36 -04:00
Jean-Paul Calderone
1d3f9715f8 trivial json markup fix 2018-05-17 14:01:18 -04:00
Jean-Paul Calderone
5fa71484e3 call out the base32/base64 mismatch 2018-05-16 10:16:58 -04:00
Jean-Paul Calderone
67ff44039f add values to the example 2018-05-16 09:49:58 -04:00
Jean-Paul Calderone
4bed6363a3 be specific about public key comparison 2018-05-16 09:49:48 -04:00
Jean-Paul Calderone
4ad5b5ab46 address slots 2018-05-15 16:00:40 -04:00
Jean-Paul Calderone
c824bcd8b2 make the share a logical child of the bucket? 2018-05-15 15:28:03 -04:00
Jean-Paul Calderone
6d84cd8179 these are gone 2018-05-15 15:27:53 -04:00
Jean-Paul Calderone
178cb58a57 dunno how much the risk is elevated 2018-05-15 15:27:33 -04:00
Jean-Paul Calderone
6b72750397 reduce verticality 2018-05-15 15:27:26 -04:00
Jean-Paul Calderone
5f88cd0687 rework the security section 2018-05-15 15:16:01 -04:00
Jean-Paul Calderone
357820357c front matter 2018-05-15 15:04:20 -04:00
Jean-Paul Calderone
465489fd0b re-organize 2018-05-15 14:48:42 -04:00
Jean-Paul Calderone
23242266dc consistent style 2018-05-15 14:16:02 -04:00
Jean-Paul Calderone
a3d4edca7d retrieve server version and info 2018-05-15 10:10:21 -04:00
Jean-Paul Calderone
73d903ad96 client-selected resource identifier -> PUT 2018-05-15 09:42:20 -04:00
Jean-Paul Calderone
5b35f591f1 write share data 2018-05-15 09:42:10 -04:00
Jean-Paul Calderone
b6572e2856 clear now they are not necessarily consecutive 2018-05-15 09:41:45 -04:00
Jean-Paul Calderone
599bf074e3 more spurious indentation 2018-05-15 09:07:58 -04:00
Jean-Paul Calderone
8e9ba52118 spurious indentation 2018-05-15 09:07:07 -04:00
Jean-Paul Calderone
53dce7eafc first pass over read and write api 2018-05-14 15:58:21 -04:00
Jean-Paul Calderone
c612fb7075 initial pass over security section 2018-05-14 14:30:34 -04:00
Jean-Paul Calderone
b9939f7d4d link to inotify wikipedia page 2018-04-20 14:42:33 -04:00
Jean-Paul Calderone
6fd1f12a3c doc improvements related to the storage dir 2018-03-19 15:28:44 -04:00
Ruben Pollan
136de7d7f7 Add storage_dir config field 
On the [storage] section of the tahoe.cfg now there is a field
'storage_dir' where the path to the storage folder can be configured.
 2018-03-19 11:20:04 -04:00
meejah
0b25cad71e documentation fixups from daira's review 2018-02-06 15:28:02 -07:00
meejah
1171bf13af ticket #2882: preserve user mtime 2018-02-06 15:27:56 -07:00
tpltnt
c3a91376f3 added link to RFC 822 2018-01-06 15:12:16 +01:00
tpltnt
a6655040b2 added link tp ConfigParser documentation 2018-01-06 15:10:30 +01:00
tpltnt
1896335eda added link to wikipedia article on ini file format 2018-01-06 15:08:33 +01:00
Brian Warner
097abb42fa tahoe.cfg: add tub.port=listen:i2p (and/or listen:tor) 
This delegates the construction of the server Endpoint object to the i2p/tor
Provider, which can use the i2p/tor section of the config file to add options
which would be awkward to express as text in an endpoint descriptor string.

refs ticket:2889 (but note this merely makes room for a function to be
written that can process I2CP options, it does not actually handle such
options, so it does not close this ticket yet)
 2017-11-03 00:24:46 -07:00
meejah
9375056b61 Split up startstop_node and add 'tahoe daemonize' 
This sets the stage for further changes to the startup
process so that "async things" are done before we create
the Client instance while still reporting early failures
to the shell where "tahoe start" is running

Also adds a bunch of test-coverage for the things that got
moved around, even though they didn't have coverage before
 2017-09-19 10:39:19 -06:00
Gordon Hall
593ebdfb07 add note about using docker compose to running docs 2017-09-19 09:25:39 -07:00
AnBuKu
e453761a0b Time goes by :-) 
See https://packages.debian.org/source/stretch/tahoe-lafs
 2017-09-18 07:27:09 +02:00
meejah
798bf57e28 Add 'tahoe invite' and 'tahoe create-node --join' commands 
This opens a wormhole and sends appropriate JSON down
it to a tahoe-gui using a wormhole server running on
tahoe-lafs.org

The other end uses the 'tahoe create-node' command (with
new --join option) to read the configuration JSON from
a 'tahoe invite' command
 2017-08-08 18:27:06 -06:00
Jean-Paul Calderone
1f16a173f0 flatten the result structure 
flat is better than nested
 2017-07-27 15:32:47 -04:00
Jean-Paul Calderone
e0ee726d22 Update to the format the code now actually produces 2017-07-27 15:28:29 -04:00
Jean-Paul Calderone
780a932122 consistent markup 2017-07-27 15:26:30 -04:00
Jean-Paul Calderone
7b88cf376b remove duplicate "above" 2017-07-27 15:26:30 -04:00
Jean-Paul Calderone
cc0e6ea6f9 typo fix 2017-07-27 15:26:30 -04:00
David Stainton
2006e6ae41 docs: add explaination of json welcome fields 2017-07-27 15:26:29 -04:00
David Stainton
a87822e66b Add note about json welcome page to api docs 2017-07-27 15:26:29 -04:00
Brian Warner
705dc856eb grammatical improvements 2017-06-06 11:28:23 +01:00
Daira Hopwood
eb1b51e263 Clean up some remaining obsolete terminology. refs #2345 
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
 2017-06-06 11:20:49 +01:00
Daira Hopwood
2055a66cf2 Doc changes that require more careful review. refs #2345 
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
 2017-06-06 11:20:49 +01:00
Daira Hopwood
4723af6e2f LAFS now stands for "Least-Authority File Store" rather than "Least-Authority File System". refs #2345 
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
 2017-06-06 11:20:49 +01:00
Brian Warner
bc34556e1a INSTALL.rst: reorder deps 2017-06-06 10:26:11 +01:00
ValdikSS
718835e08c Update INSTALL.rst 2017-06-06 10:25:21 +01:00
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