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/FTP-and-SFTP
   frontends/download-status
   magic-wormhole-invites
   anonymity-configuration
   known_issues

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

   architecture
   helper
   convergence-secret
   garbage-collection
   filesystem-notes
   key-value-store
   frontends/webapi
   write_coordination
   cautions
   backupdb
   nodekeys
   performance
   logging
   stats

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

   specifications/index
   proposed/index

.. toctree::
   :maxdepth: 1
   :caption: Notes of Community Interest

   backdoors
   donations
   accepting-donations
   expenses

.. toctree::
   :maxdepth: 1
   :caption: Notes for Contributors

   contributing
   CODE_OF_CONDUCT
   developer-guide
   release-checklist
   desert-island

.. toctree::
   :maxdepth: 1
   :caption: Of Historical Interest

   historical/configuration
   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
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/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 "anonymity configuration" under "running" 2021-04-02 21:06:58 +00:00			`anonymity-configuration`
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: 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: move filesystem notes under technical notes 2021-04-02 21:11:36 +00:00			`filesystem-notes`
Manual: move k-v store notes under technical notes 2021-04-02 21:23:41 +00:00			`key-value-store`
Manual: move web API under technical notes 2021-04-02 22:23:48 +00:00			`frontends/webapi`
Manual: move write coordination under tech notes 2021-04-02 22:28:13 +00:00			`write_coordination`
Manual: move cautions under tech notes 2021-04-02 22:35:44 +00:00			`cautions`
Manual: move backupdb under tech notes 2021-04-02 22:36:09 +00:00			`backupdb`
Manual: move nodekeys under tech notes 2021-04-02 22:36:38 +00:00			`nodekeys`
Manual: move performance under tech notes 2021-04-02 22:37:55 +00:00			`performance`
Manual: move logging under tech notes 2021-04-02 22:38:28 +00:00			`logging`
Manual: move stats under tech notes 2021-04-02 22:40:19 +00:00			`stats`
docs: add sphinx index.rst, improve headers 2016-03-30 04:46:11 +00:00
Manual: move specifications up 2021-04-02 23:03:12 +00:00			`.. toctree::`
			`:maxdepth: 1`
			`:caption: Specifications`

			`specifications/index`
			`proposed/index`

Manual: add some broad categories 2021-04-02 20:26:44 +00:00			`.. toctree::`
			`:maxdepth: 1`
Manual: re-title community section 2021-04-02 23:02:52 +00:00			`:caption: Notes of Community Interest`
Manual: add some broad categories 2021-04-02 20:26:44 +00:00
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
Manual: move community information up 2021-04-02 22:34:53 +00:00			`.. toctree::`
			`:maxdepth: 1`
Manual: merge contributor notes 2021-04-02 22:43:53 +00:00			`:caption: Notes for Contributors`
Manual: move community information up 2021-04-02 22:34:53 +00:00
			`contributing`
			`CODE_OF_CONDUCT`
Manual: move developer guide up 2021-04-02 21:05:01 +00:00			`developer-guide`
Manual: move release checklist down 2021-04-02 22:56:27 +00:00			`release-checklist`
docs: add sphinx index.rst, improve headers 2016-03-30 04:46:11 +00:00			`desert-island`
Manual: move debian notes under history 2021-04-02 21:59:26 +00:00
Manual: add some broad categories 2021-04-02 20:26:44 +00:00			`.. toctree::`
			`:maxdepth: 1`
Manual: capitalize history section header 2021-04-02 22:46:49 +00:00			`:caption: Of Historical Interest`
Manual: add some broad categories 2021-04-02 20:26:44 +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			`historical/configuration`
Manual: move debian notes under history 2021-04-02 21:59:26 +00:00			`debian`
Manual: move windows notes under history 2021-04-02 22:00:21 +00:00			`windows`
Manual: move OS X notes under history 2021-04-02 22:00:41 +00:00			`OS-X`
Manual: move pyOpenSSL on Windows under history 2021-04-02 22:25:38 +00:00			`build/build-pyOpenSSL`