perlancar

NAME

peri-htserve - Serve Perl modules over HTTP(S) using Riap::HTTP protocol

VERSION

This document describes version 0.04 of peri-htserve (from Perl distribution App-PerinciUtils), released on 2015-05-23.

SYNOPSIS

 # serve modules over HTTP, using default options (HTTP port 5000)
 $ peri-htserve Foo::Bar Baz::*

 # you can now do
 $ curl 'http://localhost:5000/api/Baz/SubMod/func1?arg1=1&arg2=2'
 [200,"OK",{"The":"result","...":"..."}]

 # or use the Perl client
 $ perl -MPerinci::Access -e'
     my $pa = Perinci::Access->new;
     my $res = $pa->request(call=>"http://localhost:5000/api/Foo/Bar/func2");'


 ### some other peri-htserve options:

 # change ports/etc (see http_ports, https_ports, and unix_sockets in Gepok doc)
 $ peri-htserve --http-ports "localhost:5000,*:80" ...

 # see all available options
 $ peri-htserve --help

DESCRIPTION

For now, please see source code for more details (or --help).

OPTIONS

* marks required options.

Configuration options

--config-path=filename

Set path to configuration file.

Can be specified multiple times.

--config-profile=s

Set configuration profile to use.

--no-config

Do not use any configuration file.

Environment options

--no-env

Do not read environment for default options.

Output options

--format=s

Choose output format, e.g. json, text.

Default value:

 undef
--json

Set output format to json.

--naked-res

When outputing as JSON, strip result envelope.

Default value:

 0

By default, when outputing as JSON, the full enveloped result is returned, e.g.:

    [200,"OK",[1,2,3],{"func.extra"=>4}]

The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:

    [1,2,3]

Other options

--daemonize, -D

If true, will daemonize into background.

--gepok-http-ports=s

Will be passed to Gepok.

--gepok-https-ports=s

Will be passed to Gepok.

--gepok-ssl-cert-file=s

Will be passed to Gepok.

--gepok-ssl-key-file=s

Will be passed to Gepok.

--gepok-start-servers=i

Will be passed to Gepok.

--gepok-unix-sockets=s

Will be passed to Gepok.

--help, -h, -?

Display help message and exit.

--library-json=s, -I

Add directory to library search path, a la Perl's -I (JSON-encoded).

See --library.

--library=s@

Add directory to library search path, a la Perl's -I.

Note that some modules are already loaded before this option takes effect. To make sure some directories are processed, you can use `PERL5OPT` or explicitly use `perl` and use its `-I` option.

Can be specified multiple times.

--metadb=s

Path to SQLite Rinci metadata database.

This is an experimental option for testing serving metadata from database. If set, will use `Perinci::Access::Schemeless::DBI` (with option `fallback_on_completion`) instead of `Perinci::Access::Schemeless` for the Riap client.

--module-or-package-json=s

List of modules to load (or package to allow and search) (JSON-encoded).

See --module-or-package.

--module-or-package=s@*

List of modules to load (or package to allow and search).

Either specify exact module name like `Foo::Bar`, or a wildcard pattern of modules like `Foo::Bar::*` (in which `Module::List` will be used to load all modules under `Foo::Bar::`) or a package name using `+Foo::Bar` syntax. If you specify package name, module with the same name will not be loaded. Can be used to allow and search an already loaded package (e.g. through `-M` or through other modules).

Can be specified multiple times.

--no-enable-logging
--parse-form

Passed to Plack::Middleware::PeriAHS::ParseRequest.

--parse-path-info

Passed to Plack::Middleware::PeriAHS::ParseRequest.

--parse-reform

Passed to Plack::Middleware::PeriAHS::ParseRequest.

--password=s

Protect with HTTP authentication, specify password.

--require-json=s, -m

Require a Perl module, a la Perl's -m (JSON-encoded).

See --require.

--require=s@

Require a Perl module, a la Perl's -m.

Can be specified multiple times.

--riap-access-log-histories=i

Number of old Riap request access log files to keep.

Default is to use File::Write::Rotate's default (10).

--riap-access-log-path=s

Path for Riap request access log file.

Default is ~/peri-htserve-riap_access.log

--riap-access-log-size=i

Maximum size for Riap request access log file.

Default is to use File::Write::Rotate's default (10485760, a.k.a. 10MB).

If size exceeds this, file will be rotated.

--server=s

Choose PSGI server.

Default value:

 "Gepok"

Valid values:

 ["Starman","Gepok"]

Currently only Starman or Gepok is supported. Default is Gepok.

--starman-host=s

Will be passed to Starman.

--starman-port=i

Will be passed to Starman.

--use-json=s, -M

Use a Perl module, a la Perl's -M (JSON-encoded).

See --use.

--use=s@

Use a Perl module, a la Perl's -M.

Can be specified multiple times.

--user=s

Protect with HTTP authentication, specify username.

--version, -v

Display program's version and exit.

QUICK TIPS

Complex argument

In raw HTTP, you can send complex argument by encoding it in JSON, e.g.:

 $ curl 'http://localhost:5000/api/Foo/Bar/func?array:j=[1,2,3]'

Notice the ":j" suffix after parameter name.

SEE ALSO

Riap::HTTP

Perinci::Access, Perinci::Access::HTTP::Client

PSGI servers used: Gepok, Starman

Plack::Runner

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

 complete -C peri-htserve peri-htserve

in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is recommended, however, that you install shcompgen which allows you to activate completion scripts for several kinds of scripts on multiple shells. Some CPAN distributions (those that are built with Dist::Zilla::Plugin::GenShellCompletion) will even automatically enable shell completion for their included scripts (using shcompgen) at installation time, so you can immadiately have tab completion.

tcsh

To activate tcsh completion for this script, put:

 complete peri-htserve 'p/*/`peri-htserve`/'

in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is also recommended to install shcompgen (see above).

other shells

For fish and zsh, install shcompgen as described above.

ENVIRONMENT

  • PERI_HTSERVE_OPT

    Specify additional command-line options

CONFIGURATION FILE

This script can read configuration file, which by default is searched at ~/.config/peri-htserve.conf, ~/peri-htserve.conf or /etc/peri-htserve.conf (can be changed by specifying --config-path). All found files will be read and merged.

To disable searching for configuration files, pass --no-config.

Configuration file is in the format of IOD, which is basically INI with some extra features.

You can put multiple profiles in a single file by using section names like [profile=SOMENAME]. Those sections will only be read if you specify the matching --config-profile SOMENAME.

List of available configuration parameters:

 daemonize (see --daemonize)
 enable_logging (see --no-enable-logging)
 format (see --format)
 gepok_http_ports (see --gepok-http-ports)
 gepok_https_ports (see --gepok-https-ports)
 gepok_ssl_cert_file (see --gepok-ssl-cert-file)
 gepok_ssl_key_file (see --gepok-ssl-key-file)
 gepok_start_servers (see --gepok-start-servers)
 gepok_unix_sockets (see --gepok-unix-sockets)
 library (see --library)
 metadb (see --metadb)
 module_or_package (see --module-or-package)
 naked_res (see --naked-res)
 parse_form (see --parse-form)
 parse_path_info (see --parse-path-info)
 parse_reform (see --parse-reform)
 password (see --password)
 require (see --require)
 riap_access_log_histories (see --riap-access-log-histories)
 riap_access_log_path (see --riap-access-log-path)
 riap_access_log_size (see --riap-access-log-size)
 server (see --server)
 starman_host (see --starman-host)
 starman_port (see --starman-port)
 use (see --use)
 user (see --user)

FILES

~/.config/peri-htserve.conf

~/peri-htserve.conf

/etc/peri-htserve.conf

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-PerinciUtils.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-PerinciUtils.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-PerinciUtils

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2015 by perlancar@cpan.org.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.