[mirrorbrain-commits] r8104 - in /trunk/docs: changes.rst configuration.rst

Author: poeml
Date: Thu Sep  2 21:34:13 2010
New Revision: 8104

URL: http://svn.mirrorbrain.org/viewvc/mirrorbrain?rev=8104&view=rev
Log:
docs/configuration: more documentation on magnet links

Modified:
    trunk/docs/changes.rst
    trunk/docs/configuration.rst

Modified: trunk/docs/changes.rst
URL: http://svn.mirrorbrain.org/viewvc/mirrorbrain/trunk/docs/changes.rst?rev=8104&r1=8103&r2=8104&view=diff
==============================================================================
--- trunk/docs/changes.rst (original)
+++ trunk/docs/changes.rst Thu Sep  2 21:34:13 2010
_at_@ -77,8 +77,9 @@
   memory for large rows from database; this may be worked around in the future.
 
 
-* Support for `Magnet <http://magnet-uri.sourceforge.net/>`_ links (`issue 38`_).
-  See :ref:`magnet_links`.
+* Initial support for `Magnet links <http://magnet-uri.sourceforge.net/>`_.
+  This largely closes `issue 38`_, but requires further testing/finetuning. See
+  :ref:`magnet_links` for documentation.
 
 
 * :program:`mb list`:

Modified: trunk/docs/configuration.rst
URL: http://svn.mirrorbrain.org/viewvc/mirrorbrain/trunk/docs/configuration.rst?rev=8104&r1=8103&r2=8104&view=diff
==============================================================================
--- trunk/docs/configuration.rst (original)
+++ trunk/docs/configuration.rst Thu Sep  2 21:34:13 2010
_at_@ -188,13 +188,28 @@
 Magnet links
 ------------
 
-Hashes are hex-encoded, because Base32 encoding would be awkward to add and
-there seems to be a transition to hex encoding.
-
-The ``urn:sha1`` scheme is currently also not supported, because it is required
-to be Base32-encoded. Base32 encoding could be added in the future, of course.
-Contributions welcome!
-
+The Magnet URI scheme allows to reference a file for download via P2P networks.
+See `Wikipedia <http://en.wikipedia.org/wiki/Magnet_URI_scheme>`_ and the
+`project website <http://magnet-uri.sourceforge.net/>`_.
+
+Magnet links are automatically included in Metalinks (v3 Metalinks as well as
+IETF Metalinks). They also appear in the mirror list.
+
+Magnet links can contain a BitTorrent tracker URL. MirrorBrain includes tracker
+URLs configured via the Apache ``MirrorBrainTrackerURL`` directive into magnet
+links. This means that multiple trackers can be listed. Configuring tracker
+URLs is explained in the :ref:`configuring_torrent_generation` section.
+
+A magnet link can be requested from MirrorBrain simply by appending ``.magnet``
+or ``?magnet`` to an URL.
+
+Implementation notes:
+
+- Hashes are hex-encoded, because Base32 encoding would be awkward to add and
+  there seems to be a transition to hex encoding.
+- The ``urn:sha1`` scheme is currently also not supported, because it is
+  required to be Base32-encoded. Base32 encoding could be added in the future,
+  of course.  Contributions welcome!
 
 
 




_______________________________________________
mirrorbrain-commits mailing list
Archive: http://mirrorbrain.org/archive/mirrorbrain-commits/

Note: To remove yourself from this list, send a mail with the content
 	unsubscribe
to the address mirrorbrain-commits-request_at_mirrorbrain.org