tahoe-lafs/docs/index.rst


Tahoe-LAFS
==========

.. Please view a nicely formatted version of this documentation at
   http://tahoe-lafs.readthedocs.io/en/latest/

Contents:

.. toctree::
   :maxdepth: 2

   about-tahoe
   Installation/install-tahoe
   Installation/install-on-windows
   Installation/install-on-linux
   Installation/install-on-desert-island
   running
   magic-wormhole-invites
   configuration
   architecture

   frontends/CLI
   frontends/webapi
   frontends/FTP-and-SFTP
   frontends/download-status

   known_issues
   contributing
   CODE_OF_CONDUCT
   release-checklist

   servers
   helper
   convergence-secret
   garbage-collection

   backdoors
   donations
   accepting-donations
   expenses
   cautions
   write_coordination
   backupdb

   developer-guide
   ticket-triage

   anonymity-configuration

   nodekeys
   performance
   logging
   stats

   debian
   build/build-pyOpenSSL

   specifications/index
   proposed/index
   filesystem-notes
   historical/configuration
   key-value-store

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
docs: run sphinx-quickstart, move old Makefile * .gitignore: add docs/_build (sphinx output directory) 2016-03-26 18:22:19 +00:00
docs: add sphinx index.rst, improve headers 2016-03-30 04:46:11 +00:00			`Tahoe-LAFS`
			`==========`
docs: run sphinx-quickstart, move old Makefile * .gitignore: add docs/_build (sphinx output directory) 2016-03-26 18:22:19 +00:00
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 08:11:51 +00:00			`.. Please view a nicely formatted version of this documentation at`
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-28 06:10:07 +00:00			`http://tahoe-lafs.readthedocs.io/en/latest/`
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 08:11:51 +00:00
docs: run sphinx-quickstart, move old Makefile * .gitignore: add docs/_build (sphinx output directory) 2016-03-26 18:22:19 +00:00			`Contents:`

			`.. toctree::`
			`:maxdepth: 2`

Installation Guide Revamp 2021-07-08 07:16:00 +00:00			`about-tahoe`
			`Installation/install-tahoe`
			`Installation/install-on-windows`
			`Installation/install-on-linux`
			`Installation/install-on-desert-island`
docs: add sphinx index.rst, improve headers 2016-03-30 04:46:11 +00:00			`running`
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 2016-10-07 18:15:05 +00:00			`magic-wormhole-invites`
docs: add sphinx index.rst, improve headers 2016-03-30 04:46:11 +00:00			`configuration`
			`architecture`

			`frontends/CLI`
			`frontends/webapi`
			`frontends/FTP-and-SFTP`
			`frontends/download-status`

			`known_issues`
Include contribution guidelines for real This warning should go away with this commit: WARNING: toctree contains reference to nonexisting document u'.github/CONTRIBUTING' 2021-01-05 01:38:44 +00:00			`contributing`
as far as I can tell there is nothing magic about putting it in .github 2020-07-01 19:48:39 +00:00			`CODE_OF_CONDUCT`
Include release checklist 2021-01-05 01:44:13 +00:00			`release-checklist`
docs: add sphinx index.rst, improve headers 2016-03-30 04:46:11 +00:00
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 19:37:40 +00:00			`servers`
docs: add sphinx index.rst, improve headers 2016-03-30 04:46:11 +00:00			`helper`
			`convergence-secret`
			`garbage-collection`

			`backdoors`
			`donations`
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 19:24:10 +00:00			`accepting-donations`
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 21:48:13 +00:00			`expenses`
docs: add sphinx index.rst, improve headers 2016-03-30 04:46:11 +00:00			`cautions`
			`write_coordination`
			`backupdb`

Add new developer guide with instructions on using pre-commit. 2020-09-03 22:59:46 +00:00			`developer-guide`
Add newline and toctree heading 2021-04-04 16:03:12 +00:00			`ticket-triage`
Add new developer guide with instructions on using pre-commit. 2020-09-03 22:59:46 +00:00
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 01:11:32 +00:00			`anonymity-configuration`

docs: add sphinx index.rst, improve headers 2016-03-30 04:46:11 +00:00			`nodekeys`
			`performance`
			`logging`
			`stats`

			`debian`
			`build/build-pyOpenSSL`
docs: run sphinx-quickstart, move old Makefile * .gitignore: add docs/_build (sphinx output directory) 2016-03-26 18:22:19 +00:00
format docs for Sphinx Added indexes, fixed cross-references. Also a few pip-related cleanups I noticed along the way. 2016-03-30 07:55:21 +00:00			`specifications/index`
			`proposed/index`
			`filesystem-notes`
			`historical/configuration`
			`key-value-store`

docs: run sphinx-quickstart, move old Makefile * .gitignore: add docs/_build (sphinx output directory) 2016-03-26 18:22:19 +00:00			`Indices and tables`
			`==================`

			* :ref:`genindex`
			* :ref:`modindex`
			* :ref:`search`