============================
Setup notes for grid-updates
============================

See `README.txt`_  and the `man page`_
for more information about grid-updates.

Requirements
------------

Python version 2.6 and later, not including Python 3.0 or 3.1. A Python
installation is not required for Windows users when using the py2exe version.

Installation
------------

Those with a supported version of Python can install grid-updates with the
command ``python setup.py install`` from within the source archive.

Debian users can build packages with the command
``fakeroot debian/rules binary``. This will build a package that can be
installed using ``dpkg``. This package will include the script and its
documentation.

Windows users have the following available options:

-  Binary installer for use on systems without Python (``grid-updates-$ver.py2exe.exe``)
-  Installer for systems with Python (``grid-updates-$ver.win32.exe``)
-  Installation from the source archive (``python setup.py install`` as above)

In short: if you're running Windows and don't know which file to get, download
the py2exe version.


Consider running ``grid-updates --patch-tahoe`` after installation (not yet
available for Tahoe-LAFS 1.10).  This will apply a small patch to Tahoe-LAFS's
web console to allow displaying news from grid-updates in an Iframe. The web
console can be restored to its original state with ``grid-updates --undo-tahoe-patch``.

Permissions
-----------

In order for this script to work, it needs to have read and write permission
for the Tahoe-LAFS node's directory. This directory is typically located at
``%APPDATA%\.tahoe`` for Windows users and ``~/.tahoe`` for other systems.

If asked to, ``grid-updates`` will update your introducers file and make a
backup of it. When fetching NEWS, the script will write a plain text version to
``~/.tahoe/NEWS``.  Additionally, an HTML version and an Atom news feed will be
saved to your Tahoe node's ``web.static`` directory (typically
``~/.tahoe/public_html``). NEWS.html and NEWS.atom can be viewed in the node's
`/static`_ directory, or (having patched Tahoe's Web UI) right on your node's
`front page`_

.. _README.txt: README.txt
.. _man page: man/grid-updates.1.md
.. _/static: http://127.0.0.1:3456/static/
.. _front page: http://127.0.0.1:3456/
