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: 1
   :caption: Preliminaries

   about

.. toctree::
   :maxdepth: 1
   :caption: Running Tahoe-LAFS

   INSTALL
   running
   configuration
   servers
   frontends/CLI
   frontends/webapi
   frontends/FTP-and-SFTP
   frontends/download-status
   magic-wormhole-invites
   known_issues

.. toctree::
   :maxdepth: 1
   :caption: Miscellaneous Information

   contributing
   CODE_OF_CONDUCT
   release-checklist

.. toctree::
   :maxdepth: 1
   :caption: Technical Notes

   architecture
   helper
   convergence-secret
   garbage-collection

.. toctree::
   :maxdepth: 1
   :caption: Community Information

   backdoors
   donations
   accepting-donations
   expenses

.. toctree::
   :maxdepth: 1
   :caption: Developer Information

   cautions
   write_coordination
   backupdb

   developer-guide

   anonymity-configuration

   nodekeys
   performance
   logging
   stats

   desert-island
   debian
   windows
   OS-X
   build/build-pyOpenSSL

.. toctree::
   :maxdepth: 1
   :caption: Specifications

   specifications/index
   proposed/index

.. toctree::
   :maxdepth: 1
   :caption: Of historical interest

   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::`
Manual: add some broad categories 2021-04-02 20:26:44 +00:00			`:maxdepth: 1`
			`:caption: Preliminaries`
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			`about`
Manual: add some broad categories 2021-04-02 20:26:44 +00:00
			`.. toctree::`
			`:maxdepth: 1`
			`:caption: Running Tahoe-LAFS`

docs: add sphinx index.rst, improve headers 2016-03-30 04:46:11 +00:00			`INSTALL`
			`running`
			`configuration`
Manual: move "architecture" under "running" 2021-04-02 20:51:30 +00:00			`servers`
docs: add sphinx index.rst, improve headers 2016-03-30 04:46:11 +00:00			`frontends/CLI`
			`frontends/webapi`
			`frontends/FTP-and-SFTP`
			`frontends/download-status`
Manual: move "magic wormhole invites" down 2021-04-02 20:54:13 +00:00			`magic-wormhole-invites`
Manual: move "known issues" under "running" 2021-04-02 20:27:24 +00:00			`known_issues`
docs: add sphinx index.rst, improve headers 2016-03-30 04:46:11 +00:00
Manual: add some broad categories 2021-04-02 20:26:44 +00:00			`.. toctree::`
			`:maxdepth: 1`
			`:caption: Miscellaneous Information`

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
Manual: add some broad categories 2021-04-02 20:26:44 +00:00			`.. toctree::`
			`:maxdepth: 1`
			`:caption: Technical Notes`

Manual: move "architecture" under "technical notes" 2021-04-02 20:48:07 +00:00			`architecture`
docs: add sphinx index.rst, improve headers 2016-03-30 04:46:11 +00:00			`helper`
			`convergence-secret`
			`garbage-collection`

Manual: add some broad categories 2021-04-02 20:26:44 +00:00			`.. toctree::`
			`:maxdepth: 1`
			`:caption: Community Information`

docs: add sphinx index.rst, improve headers 2016-03-30 04:46:11 +00:00			`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`
Manual: add some broad categories 2021-04-02 20:26:44 +00:00
			`.. toctree::`
			`:maxdepth: 1`
			`:caption: Developer Information`

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`

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`

			`desert-island`
			`debian`
			`windows`
			`OS-X`
			`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
Manual: add some broad categories 2021-04-02 20:26:44 +00:00			`.. toctree::`
			`:maxdepth: 1`
			`:caption: Specifications`

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`
Manual: add some broad categories 2021-04-02 20:26:44 +00:00
			`.. toctree::`
			`:maxdepth: 1`
			`:caption: Of historical interest`

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			`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`