NAME

dcdb-www-server.perl - standalone HTTP server for DiaColloDB indices

SYNOPSIS

 dcdb-www-server.perl [OPTIONS...] DBURL

 General Options:
  -help                           ##-- show short usage summary
  -man                            ##-- show longer help message
  -version                        ##-- show version & exit

 Server Configuration Options:
  -bind HOST                      ##-- override host to bind (default=127.0.0.1)
  -port PORT                      ##-- override port to bind (default=6066)
  -wwwdir DIR                     ##-- override WWW wrapper directory (default=shared)

 Logging Options:                 ##-- see Log::Log4perl(3pm)
  -log-level LEVEL                ##-- set minimum log level (default=INFO)
  -log-option OPT=VALUE           ##-- set any logging option (e.g. -log-option file=server.log)

DESCRIPTION

dcdb-www-server.perl is a command-line utility for starting a standalone HTTP server to provide a DiaColloDB web-service and HTTP-based user interface using the DiaColloDB::WWW::Server module. After successful startup, point your browser at http://HOST:PORT (by default http://127.0.0.1:6066) to use.

OPTIONS AND ARGUMENTS

Arguments

DBURL

DiaColloDB database URL to be wrapped, which must be supported by DiaColloDB::Client, i.e. must use one of the supported schemes file://, rcfile://, http://, and list://. If no scheme is specified, file:// is assumed. Typically, DBURL is simply the path to a localDiaColloDB index directory as created by dcdb-create.perl(1).

General Options

-help

Display a short help message and exit.

-man

Display a longer help message and exit.

-version

Display program and module version information and exit.

Server Options

-bind HOST

Set local hostname or IP address to listen on; default=127.0.0.1 just binds the loopback address. If you're feeling adventurous, you can specify -bind=0.0.0.0 to bind all IP addresses assigned to the local machine.

-port PORT

Set local port to listen on; default=6066.

-wwwdir DIR

Override WWW wrapper directory. If unspecified, the default templates installed with the DiaColloDB::WWW distribution are used. You can create a copy of the default wrapper directory with the dcdb-www-create.perl(1) script and edit the dstar.rc and/or dstar/corpus.ttk files to override the default variables (e.g. corpus label, ddc server, KWIC query root, etc.).

Logging Options

The DTA::CAB family of modules uses the Log::Log4perl logging mechanism. See Log::Log4perl(3pm) for details on the general logging mechanism.

-log-level LEVEL

Set minimum log level. Has no effect if you also specify "-log-config". Known levels: (trace|debug|info|warn|error|fatal).

-log-option OPT=VALUE

Set any DiaColloDB::Logger option, e.g. -log-option file=server.log.

ACKNOWLEDGEMENTS

Perl by Larry Wall.

AUTHOR

Bryan Jurish <moocow@cpan.org>

COPYRIGHT AND LICENSE

Copyright (C) 2016 by Bryan Jurish

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.14.2 or, at your option, any later version of Perl 5 you may have available.

SEE ALSO

DiaColloDB::WWW::Server(3pm), DiaColloDB::WWW::CGI(3pm), DiaColloDB(3pm), HTTP::Daemon(3pm), perl(1), ...