Homeserver Module
=================

Homeserver is a module, whose main purpose is to expose Meadow to the outside world
(via RESTful HTTP API). It's API reference is currently available at
https://homeserverapi.docs.apiary.io.

By default, the homeserver instance will be available on port 8421.


application.yaml
----------------

Recommended basic configuration example:

.. code-block:: YAML

    homeserver:
        login: <usernane>:<password>


Full configuration example:

.. code-block:: YAML

    homeserver:
        login: user:password
        metadata_authority: true
        storage: ./homeserver

:login:
    Admin user login. If ``null``, no authentication is required.

    Default: ``null`` (no authentication)

:metadata_authority:
    If ``true``, homeserver will be the one who resolves all metadata requests on
    Meadow. You most likely do not want to change this (nor explicitely specify this).

    Default: ``true``

:storage:
    What subfolder in the storage directory should be used for this module.

    Default: ``./<module name>``