Commit Graph

885 Commits

Author SHA1 Message Date
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 1cddcb6bc3 Leasedb and cloud backend merge is scheduled for v1.12.0.
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2014-04-09 05:34:08 +01:00
Daira Hopwood 3df9bb7934 Add the 'tahoe admin ls-container' command and tests. fixes #1759
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2014-04-09 01:57:52 +01:00
Daira Hopwood efd86e32a1 Azure: change 'container_name' config entry to 'container' for consistency with OpenStack.
Also fix a hidden bug in a test.

Signed-off-by: Daira Hopwood <david-sarah@jacaranda.org>
2014-04-09 01:57:51 +01:00
Daira Hopwood b71637b2ce docs/backends/cloud.rst: cosmetics and caveat about support for 'create-container'. refs #1971
Signed-off-by: Daira Hopwood <david-sarah@jacaranda.org>
2014-04-09 01:57:51 +01:00
Daira Hopwood 0f840c4514 Add and document "tahoe admin create-container" command (rebased). refs #1971
Signed-off-by: Daira Hopwood <david-sarah@jacaranda.org>
2014-04-09 01:57:51 +01:00
Itamar Turner-Trauring 0c9fab28d6 Add documentation for Microsoft Azure Blob Service cloud storage backend config. 2014-04-09 01:44:25 +01:00
Itamar Turner-Trauring 74b796d939 Address review comments from Daira.
1. Fix typo.
2. Rename config item googlestorage.bucket_name to googlestorage.bucket for
   consistency.
2014-04-09 01:33:55 +01:00
Itamar Turner-Trauring afdbce1569 Add documentation for Google Cloud Storage backend. 2014-04-09 01:33:55 +01:00
David-Sarah Hopwood 5304c0b152 docs/backends/cloud.rst: clarify how to get to API Access in the Rackspace console.
Signed-off-by: David-Sarah Hopwood <david-sarah@jacaranda.org>
2014-04-09 01:33:55 +01:00
David-Sarah Hopwood 512cc28663 OpenStack: support HP Cloud Object Storage.
Also make the choice of auth protocol for Rackspace configurable via
openstack.provider, and change the reauth period to 11 hours.

Signed-off-by: David-Sarah Hopwood <david-sarah@jacaranda.org>
2014-04-09 01:33:55 +01:00
David-Sarah Hopwood 9f6d12691e leasedb/accounting crawler: only treat stable shares as disappeared or unleased.
fixes #1921

Signed-off-by: David-Sarah Hopwood <david-sarah@jacaranda.org>
2014-04-09 01:33:55 +01:00
David-Sarah Hopwood 70b8d5ac67 docs: add references to OpenStack/cloud backend in configuration.rst and running.rst.
Signed-off-by: David-Sarah Hopwood <david-sarah@jacaranda.org>
2014-04-09 01:33:55 +01:00
David-Sarah Hopwood ea8ec9c137 docs/backends/cloud.rst: add documentation for OpenStack config parameters.
Signed-off-by: David-Sarah Hopwood <david-sarah@jacaranda.org>
2014-04-09 01:33:55 +01:00
Daira Hopwood c24a0b8270 Add documentation for each storage backend (rebased).
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2014-04-09 00:43:30 +01:00
David-Sarah Hopwood 79e4766b22 Remove the [storage]expire.{mutable,immutable} options.
Signed-off-by: David-Sarah Hopwood <david-sarah@jacaranda.org>
2014-04-09 00:26:04 +01:00
David-Sarah Hopwood 5da509a7c2 docs/garbage-collection.rst: update text for leasedb changes.
Signed-off-by: David-Sarah Hopwood <david-sarah@jacaranda.org>
2014-04-09 00:26:04 +01: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
the real nejucomo 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 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