Merge pull request #506 from LeastAuthority/2932.encourage-zcash-workflow

Encourage Zcash workflow

NEWS.rst

@@ -43,6 +43,8 @@ configurable (`PR472`_).
 A PyInstaller-based build is now available (`PR421`_). A "Docker
 compose" setup for development purposes is now available (`PR445`_).
 
+There is now a recommended workflow for Zcash-based donations to support
+storage server operators (`PR506`_).
 
 Bug Fixes in Core
 -----------------
@@ -145,6 +147,7 @@ everyone! A complete list of these PRs and contributions:
 `PR499`_: `exarkun`_ (with `meejah`_)
 `PR501`_: `exarkun`_ (with `meejah`_)
 `PR502`_: `exarkun`_ (with `meejah`_)
+`PR506`_: `exarkun`_ (with `crwood`_, `nejucomo`_)
 
 
 Developer and Internal Changes
@@ -236,10 +239,12 @@ improvements which shouldn't have any user-visible effects:
 .. _PR474: https://github.com/tahoe-lafs/tahoe-lafs/pull/474
 .. _PR482: https://github.com/tahoe-lafs/tahoe-lafs/pull/482
 .. _PR502: https://github.com/tahoe-lafs/tahoe-lafs/pull/502
+.. _PR506: https://github.com/tahoe-lafs/tahoe-lafs/pull/506
 .. _AnBuKu: https://github.com/AnBuKu
 .. _ValdikSS: https://github.com/ValdikSS
 .. _bookchin: https://github.com/bookchin
 .. _crwood: https://github.com/crwood
+.. _nejucomo: https://github.com/nejucomo
 .. _daira: https://github.com/daira
 .. _david415: https://github.com/david415
 .. _exarkun: https://github.com/exarkun

docs/accepting-donations.rst

@@ -0,0 +1,78 @@
+========================
+Storage Server Donations
+========================
+
+The following is a configuration convention which allows users to anonymously support the operators of storage servers.
+Donations are made using `Zcash shielded transactions`_ to limit the amount of personal information incidentally conveyed.
+
+Sending Donations
+=================
+
+To support a storage server following this convention, you need several things:
+
+* a Zcash wallet capable of sending shielded transactions
+  (at least until Zcash 1.1.1 this requires a Zcash full node)
+* a shielded address with sufficient balance
+* a running Tahoe-LAFS client node which knows about the recipient storage server
+
+For additional protection, you may also wish to operate your Zcash wallet and full node using Tor.
+
+Find Zcash Shielded Address
+---------------------------
+
+To find an address at which a storage server operator wishes to receive donations,
+launch the Tahoe-LAFS web UI::
+
+  $ tahoe webopen
+
+Inspect the page for the storage server area.
+This will have a heading like *Connected to N of M known storage servers*.
+Each storage server in this section will have a nickname.
+A storage server with a nickname beginning with ``zcash:`` is signaling it accepts Zcash donations.
+Copy the full address following the ``zcash:`` prefix and save it for the next step.
+This is the donation address.
+Donation addresses beginning with ``z`` are shielded.
+It is recommended that all donations be sent from and to shielded addresses.
+
+Send the Donation
+-----------------
+
+First, select a donation amount.
+Next, use a Zcash wallet to send the selected amount to the donation address.
+Using the Zcash cli wallet, this can be done with commands like::
+
+  $ DONATION_ADDRESS="..."
+  $ AMOUNT="..."
+  $ YOUR_ADDRESS="..."
+  $ zcash-cli z_sendmany $YOUR_ADDRESS "[{\"address\": \"$DONATION_ADDRESS\", \"amount\": $AMOUNT}]"
+
+Remember that you must also have funds to pay the transaction fee
+(which defaults to 0.0001 ZEC in mid-2018).
+
+Receiving Donations
+===================
+
+To receive donations from users following this convention, you need the following:
+
+* a Zcash shielded address
+
+Configuring Tahoe-LAFS
+----------------------
+
+The Zcash shielded address is placed in the storage server's ``nickname`` field.
+Edit ``tahoe.cfg`` and edit the ``nickname`` field in the ``node`` section like so::
+
+  [node]
+  nickname = zcash:zcABCDEF....
+
+Then restart the storage server.
+
+Further Reading
+===============
+
+To acquaint yourself with the security and privacy properties of Zcash,
+refer to the `Zcash documentation`_.
+
+.. _Zcash shielded transactions: https://z.cash/support/security/privacy-security-recommendations.html#transaction
+
+.. _Zcash documentation: http://zcash.readthedocs.io/en/latest/

docs/configuration.rst

@@ -683,6 +683,8 @@ Client Configuration
     location to prefer their local servers so that they can maintain access to
     all of their uploads without using the internet.
 
+In addition,
+see :doc:`accepting-donations` for a convention for donating to storage server operators.
 
 Frontend Configuration
 ======================
@@ -793,6 +795,8 @@ Storage Server Configuration
     (i.e. ``BASEDIR/storage``), but it can be placed elsewhere. Relative paths
     will be interpreted relative to the node's base directory.
 
+In addition,
+see :doc:`accepting-donations` for a convention encouraging donations to storage server operators.
 
 Running A Helper
 ================

docs/index.rst

@@ -32,6 +32,7 @@ Contents:
 
    backdoors
    donations
+   accepting-donations
    expenses
    cautions
    write_coordination