Commit Graph

197 Commits

Author SHA1 Message Date
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
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
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
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
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
david-sarah
f19620301e docs/frontends/FTP-and-SFTP.rst: remove outdated allmydata.com reference. fixes #1743 2012-05-18 22:56:18 +00: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
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
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
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
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
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
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
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
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
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
david-sarah
8d45f91bf0 docs: fix some broken .rst links. refs #1542 2011-09-24 22:10:01 -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
33461a775e doc: formatting: reflow to fill-column=77 2011-08-09 06:25:10 -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
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
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
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
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
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
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
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
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
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
341cad80ff Fix a link from webapi.rst to FTP-and-SFTP.rst. refs #1225 2010-12-11 21:34:35 -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
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
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
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
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
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
5872f6c8cf webapi.txt: fix grammatical error. 2010-08-09 23:41:27 -07:00
david-sarah
4002c7aeb0 webapi.txt: fix statement about leap seconds. 2010-06-18 20:56:03 -07:00
david-sarah
4712875193 dirnode.py: stop writing 'ctime' and 'mtime' fields. Includes documentation and test changes. 2010-06-18 16:01:19 -07:00
david-sarah
29a9059c94 FTP-and-SFTP.txt: add Known Issues section. 2010-06-18 17:43:11 -07:00
david-sarah
e05c6c2c7d FTP-and-SFTP.txt: remove description of public key format that is not actually implemented. Document that SFTP does not support server private keys with passphrases, and that FTP cannot list directories containing mutable files. 2010-06-18 17:17:38 -07:00
david-sarah
22738db577 CLI.txt: introduce 'create-alias' before 'add-alias', document Unicode argument support, and other minor updates. 2010-06-10 15:55:47 -07:00
david-sarah
d7d0ae3c2c FTP-and-SFTP.txt: minor technical correction to doc for 'no-write' flag. 2010-06-06 23:16:00 -07:00
Francois Deppierraz
496802420e Fix handling of correctly encoded unicode filenames (#534)
Tahoe CLI commands working on local files, for instance 'tahoe cp' or 'tahoe
backup', have been improved to correctly handle filenames containing non-ASCII
characters.
  
In the case where Tahoe encounters a filename which cannot be decoded using the
system encoding, an error will be returned and the operation will fail.  Under
Linux, this typically happens when the filesystem contains filenames encoded
with another encoding, for instance latin1, than the system locale, for
instance UTF-8.  In such case, you'll need to fix your system with tools such
as 'convmv' before using Tahoe CLI.
  
All CLI commands have been improved to support non-ASCII parameters such as
filenames and aliases on all supported Operating Systems except Windows as of
now.
2010-05-19 17:43:56 -07:00
david-sarah
29a06457d2 dirnode.py: fix a bug in the no-write change for Adder, and improve test coverage. Add a 'metadata' argument to create_subdirectory, with documentation. Also update some comments in test_dirnode.py made stale by the ctime/mtime change. 2010-06-01 20:26:41 -07:00
david-sarah
de95140b7b SFTP: changes for #1063 ('no-write' field) including comment:1 (clearing owner write permission diminishes to a read cap). Includes documentation changes, but not tests for the new behaviour. 2010-05-31 22:11:39 -07:00
david-sarah
87ddf54ed8 Minor documentation tweaks. 2010-06-02 22:44:58 -07:00
freestorm77
9ad0a93d49 doc_reformat_FTP-and-SFTP.txt
- Added heading format begining and ending by "=="
   - Added Index
   - Added Title
          
   Note: No change are made in paragraphs content
2010-04-24 05:13:34 -07:00
freestorm77
0641059ce6 doc_reformat_CLI.txt
- Added heading format begining and ending by "=="
     - Added Index
     - Added Title
          
     Note: No change are made in paragraphs content
2010-04-24 05:15:12 -07:00
Brian Warner
cc2fcd700c docs/FTP: the Twisted patch (t3462) has landed, will be in the next release 2010-02-23 16:04:02 -05:00
Kevan Carstensen
09177a6e19 Update docs/frontends/webapi.txt to reflect the new expiration times in #577 2010-02-20 17:07:16 -08:00
david-sarah
e2ee725d7d Fix invalid trailing commas in JSON example 2010-01-29 12:17:42 -08:00
david-sarah
f1fd703ded Fix example JSON in webapi.txt that cannot occur in practice 2010-01-28 19:27:42 -08:00
david-sarah
3e35959e9b Add mutable field to t=json output for unknown nodes, when mutability is known 2010-01-28 19:14:24 -08:00
david-sarah
b9eda4de6a Address comments by Kevan on 833 and add test for stripping spaces 2010-01-27 15:06:42 -08:00