Commit Graph

197 Commits

Author SHA1 Message Date
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
david-sarah
56c00cb381 Miscellaneous documentation, test, and code formatting tweaks. 2010-01-26 23:03:09 -08:00
david-sarah
6057bc02cc Prevent mutable objects from being retrieved from an immutable directory, and associated forward-compatibility improvements. 2010-01-26 22:44:30 -08:00
Brian Warner
b4d3e23024 docs: fix references to --no-storage, explanation of [storage] section 2010-01-27 12:09:56 -08:00
david-sarah
5c5a6fe610 Patch to accept t=set-children as well as t=set_children 2010-01-23 19:00:20 -08:00
david-sarah
87f1bae7fe Add create-node CLI command, and make create-client equivalent to create-node --no-storage (fixes #760) 2010-01-15 21:20:55 -08:00
Brian Warner
a6e25d0d2c FTP-and-SFTP.txt: fix ssh-keygen pointer 2009-12-06 21:28:03 -08:00
Brian Warner
31c9cb760a update "tahoe backup" docs, and webapi.txt's mkdir-with-children 2009-11-27 00:59:00 -05:00
Brian Warner
6e7fb1006d Use DIR-IMM and t=mkdir-immutable for "tahoe backup", for #828 2009-11-18 11:28:13 -08:00
Brian Warner
f85690697a Add t=mkdir-immutable to the webapi. Closes #607.
* change t=mkdir-with-children to not use multipart/form encoding. Instead,
  the request body is all JSON. t=mkdir-immutable uses this format too.
* make nodemaker.create_immutable_dirnode() get convergence from SecretHolder,
  but let callers override it
* raise NotDeepImmutableError instead of using assert()
* add mutable= argument to DirectoryNode.create_subdirectory(), default True
2009-11-17 23:09:00 -08:00
Brian Warner
768c76aa5f webapi: use t=mkdir-with-children instead of a children= arg to t=mkdir .
This is safer: in the earlier API, an old webapi server would silently ignore
the initial children, and clients trying to set them would have to fetch the
newly-created directory to discover the incompatibility. In the new API,
clients using t=mkdir-with-children against an old webapi server will get a
clear error.
2009-10-25 18:13:21 -07:00
Brian Warner
b30041c5ec webapi: t=mkdir now accepts initial children, using the same JSON that t=json
emits.

client.create_dirnode(initial_children=) now works.
2009-10-12 19:34:44 -07:00
Brian Warner
f03e87d081 webapi.txt: document t=set_children, other small edits 2009-10-09 13:04:46 -07:00
Brian Warner
ad45511156 ftpd: update docs, point to Twisted ticket for the proposed patch 2009-07-31 11:32:26 -07:00
Brian Warner
bf1e61c8f3 Touch up #705 changes:
webapi.txt: clarify replace=only-files argument, mention replace= on POST t=uri
 test_cli.py: insert whitespace between logical operations
 web.common.parse_replace_arg: make it case-insensitive, to match the docs
2009-07-20 11:38:03 -04:00
kevan
3a9f1f2952 Update webapi docs to reference new PUT behavior. 2009-07-19 20:44:47 -07:00
Brian Warner
ef1b6ae8e3 Tolerate unknown URI types in directory structures. Part of #683.
The idea is that future versions of Tahoe will add new URI types that this
version won't recognize, but might store them in directories that we *can*
read. We should handle these "objects from the future" as best we can.
Previous releases of Tahoe would just explode. With this change, we'll
continue to be able to work with everything else in the directory.

The code change is to wrap anything we don't recognize as an UnknownNode
instance (as opposed to a FileNode or DirectoryNode). Then webapi knows how
to render these (mostly by leaving fields blank), deep-check knows to skip
over them, deep-stats counts them in "count-unknown". You can rename and
delete these things, but you can't add new ones (because we wouldn't know how
to generate a readcap to put into the dirnode's rocap slot, and because this
lets us catch typos better).
2009-07-02 18:07:49 -07:00
Zooko O'Whielacronx
9729753692 dirnode: add 'tahoe'/'linkcrtime' and 'tahoe'/'linkmotime' to take the place of what 'mtime'/'ctime' originally did, and make the 'tahoe' subdict be unwritable through the set_children API
Also add extensive documentation in docs/frontends/webapi.txt about the behaviors of these values.  See ticket #628.
2009-04-11 15:52:05 -07:00
Zooko O'Whielacronx
664b69dd8d docs: webapi.txt edits to explain a few things better, adjust indentation, editing 2009-04-11 15:48:28 -07:00
Zooko O'Whielacronx
37c6e77764 wui: edit some of the human-readable parts of the wui such as button labels
(The word "parent" suggests that you can go up a directory hierarchy -- perhaps that word is vestigial.)
2009-04-07 11:54:59 -07:00
Brian Warner
f42e3bb107 web: full patch for HTML-vs-plaintext traceback renderings, improve test coverage of exception rendering 2009-03-03 21:56:30 -07:00
Brian Warner
fd4ceb6a87 webapi: modify streaming deep-manifest/deep-checker to emit an ERROR: line if they encounter an unrecoverable+untraversable directory. For #590. 2009-02-24 23:13:35 -07:00
Alberto Berti
82352add22 Added documentation for '--exclude' and friends cli backup command. 2009-02-24 09:30:49 -07:00
Brian Warner
bce4a5385b add --add-lease to 'tahoe check', 'tahoe deep-check', and webapi. 2009-02-17 19:32:43 -07:00
Brian Warner
fde2289e7b CLI #590: convert 'tahoe deep-check' to streaming form, improve display, add tests 2009-02-17 17:15:11 -07:00
Brian Warner
476a5c8fac webapi #590: add streaming deep-check. Still need a CLI tool to use it. 2009-02-16 23:35:53 -07:00
Brian Warner
177ffa0870 docs/CLI: document 'tahoe backup' 2009-02-05 22:14:45 -07:00
Brian Warner
4e572a5f24 webapi: add verifycap (spelled 'verify_url') to the t=json output on files and directories. Closes #559. 2009-02-03 19:22:48 -07:00
Brian Warner
af8d282f46 CLI.txt: improve docs on 'tahoe manifest' to cover --verify-cap, --repair-cap, and streaming JSON 2009-01-23 16:59:39 -07:00
Brian Warner
26260374e9 #590: add webish t=stream-manifest 2009-01-22 22:01:36 -07:00
Zooko O'Whielacronx
7d91dc5efe rollback the feature of making "ambient upload authority" configurable
This reverses some, but not all, of the changes that were committed in the following set of patches.

rolling back:

Sun Jan 18 09:54:30 MST 2009  toby.murray
  * add 'web.ambient_upload_authority' as a paramater to tahoe.cfg

    M ./src/allmydata/client.py -1 +3
    M ./src/allmydata/test/common.py -7 +9
    A ./src/allmydata/test/test_ambient_upload_authority.py
    M ./src/allmydata/web/root.py +12
    M ./src/allmydata/webish.py -1 +4
Sun Jan 18 09:56:08 MST 2009  zooko@zooko.com
  * trivial: whitespace
  I ran emacs's "M-x whitespace-cleanup" on the files that Toby's recent patch had touched that had trailing whitespace on some lines.

    M ./src/allmydata/test/test_ambient_upload_authority.py -9 +8
    M ./src/allmydata/web/root.py -2 +1
    M ./src/allmydata/webish.py -2 +1
Mon Jan 19 14:16:19 MST 2009  zooko@zooko.com
  * trivial: remove unused import noticed by pyflakes

    M ./src/allmydata/test/test_ambient_upload_authority.py -1
Mon Jan 19 21:38:35 MST 2009  toby.murray
  * doc: describe web.ambient_upload_authority

    M ./docs/configuration.txt +14
    M ./docs/frontends/webapi.txt +11
Mon Jan 19 21:38:57 MST 2009  zooko@zooko.com
  * doc: add Toby Murray to the CREDITS

    M ./CREDITS +4
2009-01-20 20:47:35 -07:00
toby.murray
c5a5b22c17 doc: describe web.ambient_upload_authority 2009-01-19 22:38:35 -07:00
Brian Warner
4334ee056b webapi.txt: explain POST /uri/?t=upload, thanks to Toby Murray for the catch 2009-01-14 18:08:03 -07:00
Zooko O'Whielacronx
0a2895e17a docs: rename wapi.txt to webapi.txt
Because Brian argues that the file contains a description of the wui as well as of the wapi, and because the name "webapi.txt" might be more obvious to the untrained eye.
2009-01-14 13:53:48 -07:00
Zooko O'Whielacronx
c360bf604a docs: rename frontends/webapi.txt to frontends/wapi.txt
rename CLI.txt to frontends/CLI.txt
change a few mentions of "webapi" to "wapi"
fixes #582
2009-01-13 20:51:43 -07:00
Brian Warner
7ee336b274 webapi/deep-manifest t=JSON: don't return the (large) manifest/SI/verifycap lists unless the operation has completed, to avoid the considerable CPU+memory cost of creating the JSON (for 330k dirnodes, it could take two minutes to generate 275MB of JSON). They must be paid eventually, but not on every poll 2009-01-08 19:59:32 -07:00
Zooko O'Whielacronx
5e6f90a015 rename "checker results" to "check results", because it is more parallel to "check-and-repair results" 2009-01-06 13:37:03 -07:00
Brian Warner
d1d2d0b686 webapi.txt: minor edits 2008-12-08 15:32:56 -07:00
Brian Warner
2a640af485 docs/webapi.txt: update helper section to discuss tahoe.cfg 2008-12-02 19:07:26 -07:00
Brian Warner
ed211e8574 docs/webapi.txt: update to discuss tahoe.cfg, not BASEDIR/webport 2008-12-02 19:06:12 -07:00
Zooko O'Whielacronx
fe6abac87b wui/wapi: change the default port number from 8123 to 3456 to avoid conflict with TorButton
See ticket #536 for details.
2008-11-25 17:57:37 -07:00
Brian Warner
bc53c24003 dirnode manifest: add verifycaps, both to internal API and to webapi. This will give the manual-GC tools more to work with, so they can estimate how much space will be freed. 2008-11-24 14:40:46 -07:00
Brian Warner
b84c2c6541 manifest: add storage-index strings to the json results 2008-11-19 16:00:27 -07:00
Brian Warner
815e0673e6 manifest: include stats in results. webapi is unchanged. 2008-11-19 15:03:47 -07:00
Brian Warner
7932fadb5e webapi: add 'summary' string to checker results JSON 2008-11-18 18:28:26 -07:00
Brian Warner
994d97c644 webapi: introducer stats: add 'announcement_distinct_hosts' to the t=json form, to show how many distinct hosts are providing e.g. storage services 2008-11-18 15:30:15 -07:00
Brian Warner
7c4856c222 SFTP/FTP: merge user/account code, merge docs 2008-11-05 19:25:58 -07:00
Brian Warner
fc04afa5dd docs: move webapi/ftp/sftp into a new frontends/ directory 2008-11-05 17:30:50 -07:00