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