hg-review/_sources/webui.txt @ 1cfaa32d931d

Web Interface
=============

The web interface of hg-review is probably what you're going to use the most.

Running Locally
---------------

To start the web interface for a local repository that you want to review you
can run ``hg review --web``. Visit http://localhost:8080/ to use it.

When you add comments or signoffs hg-review will use your normal Mercurial
username as the author.

This command can take a few extra options:

``--address ADDRESS``
    The address to bind to. Use ``0.0.0.0`` if you want other people to be able
    to access it.

    **Be careful!** Because the web interface uses your Mercurial username by
    default, binding to ``0.0.0.0`` will let anyone add comments and signoffs
    in your name! You'll probably want to use the ``--read-only`` option to
    prevent this.

    Default: ``127.0.0.1``

``--port PORT``
    The port to listen on.

    Default: ``8080``

``--read-only``
    Run the server in read-only mode. This will not allow data to be pushed or
    pulled, comments to be made or signoffs to be added.

    This can be useful when combined with ``--address`` to let other people
    view the UI without letting them add comments in your name.

    Default: ``false``

``--allow-anon``
    Allow comments (not not signoffs) to be added even if ``--read-only`` is
    used, and set the username to ``Anonymous <anonymous@example.com>`` instead
    of your Mercurial username.

    This option is most useful when you're deploying a permanent web interface
    to a server and want to allow anonymous viewers to add comments. See the
    :ref:`deployment` section for more information.

    Default: ``false``


.. _deployment:

Deployment to a Server
----------------------