Skip to content
(perl) A metabase relay server
Perl
Find file
Pull request Compare This branch is 3 commits ahead, 20 commits behind bingos:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
bin
lib/App/Metabase
t
tools
Changes
MANIFEST
Makefile.PL
README

README

NAME
    metabase-relayd - A relay server for Metabase

SYNOPSIS
     metabase-relayd [options]

     Options:
       --debug         - display interesting things;
       --help            - Display program usage;
       --version     - Display program version;
       --url URI     - The URI of a Metabase server to use;
       --idfile    - The path to an ID file to use;
       --dbfile    - The path to the database file to use;
       --address   - A particular IP address to listen on;
       --port      - The TCP port to listen on;
       --multiple  - Whether to use multiple HTTP clients;
       --no-relay  - Whether to disable report submissions to the Metabase

DESCRIPTION
    metabase-relayd is a Metabase relay server that acts an intermediate
    between Test::Reporter::Transport::Socket based CPAN Tester clients and
    a Metabase server.

COMMAND LINE OPTIONS
    Command line options override options given in the "CONFIGURATION FILE"

    "--debug"
        Turns on all output.

    "--help"
        Displays program usage and exits.

    "--version"
        Displays the program version and exits.

    "--idfile FILE"
        Specify a Metabase ID file to use.

    "--dbfile FILE"
        Specify the file that DBD::SQLite will use for the queue storage.

    "--url URI"
        The URL of a Metabase server to send reports to.

    "--address IP_ADDRESS"
        Specify a particular IP address for the listening socket to bind to.
        The default is INADDR_ANY.

    "--port TCP_PORT"
        Specify the TCP port for the listening socket to bind to. The
        default is 0, ie. pick a random port.

    "--multiple"
        By default a single POE::Component::Client::HTTP instance is created
        and used to send each report. Enabling this option means that a new
        instance of POE::Component::Client::HTTP will be created for each
        report submitted.

    "--no-relay"
        By default recieved reports will be relayed to Metabase. If this
        option is set, they will only be queued locally and may be submitted
        later.

CONFIGURATION FILE
    A number of the above options may be specified in a configuration file,
    "relayd", that is stored in the ".metabase" directory. See "ENVIRONMENT"
    for where the ".metabase" directory is located and how to effect its
    location.

    Command line options will override options from the configuration file.

    The configuration file is parsed using Config::Tiny.

    A subset of the command line options can be specified in the
    configuration file:

    "debug=BOOL"
        Set to a true value to turn on all output.

          debug=1

    "idfile=FILE"
        Specify a Metabase ID file to use.

          idfile=/home/bingos/.metabase/id.json

    "dbfile=FILE"
        Specify the file that DBD::SQLite will use for the queue storage.

          dbfile=/home/bingos/.metabase/relaydb

    "url=URI"
        The URL of a Metabase server to send reports to.

          url=https://metabase.example.url/

    "address=IP_ADDRESS"
        Specify a particular IP address for the listening socket to bind to.
        The default is INADDR_ANY.

          address=192.168.0.254

    "port=TCP_PORT"
        Specify the TCP port for the listening socket to bind to. The
        default is 0, ie. pick a random port.

          port=8080

    "multiple=BOOL"
        By default a single POE::Component::Client::HTTP instance is created
        and used to send each report. Enabling this option means that a new
        instance of POE::Component::Client::HTTP will be created for each
        report submitted.

          multiple=1

    "no_relay=BOOL"
        By default recieved reports will be relayed to Metabase. If this
        option is set, they will only be queued locally and may be submitted
        later.

          no_relay=1

ENVIRONMENT
    "metabase-relayd" uses the ".metabase" directory to locate the
    configuration file, "relayd".

    This is usually located in the current user's home directory. Setting
    the environment variable "PERL5_MBRELAYD_DIR" will effect where the
    ".metabase" directory is located.

KUDOS
    Thanks go to Ricardo SIGNES for CPAN::Mini which inspired the design of
    this script/module.

AUTHOR
    Chris "BinGOs" Williams <chris@bingosnet.co.uk>

LICENSE
    Copyright © Chris Williams

    This module may be used, modified, and distributed under the same terms
    as Perl itself. Please see the license that came with your Perl
    distribution for details.

SEE ALSO
    <http://www.cpantesters.org/> - CPAN Testers: Index

    <http://wiki.cpantesters.org/> - CPAN Testers Wiki

    <http://stats.cpantesters.org/> - CPAN Testers Statistics

    Metabase

    DBD::SQLite

    Config::Tiny

    POE::Component::Metabase::Relay::Server

Something went wrong with that request. Please try again.