# bayard-rest

## DESCRIPTION

Bayard REST server

## USAGE

bayard-rest [OPTIONS]

## FLAGS

- `-h`, `--help`
  Prints help information.

- `-v`, `--version`
  Prints version information.

## OPTIONS

- `-H`, `--host` `<HOST>`
  Hostname or IP address. [default: 0.0.0.0]

- `-p`, `--port` `<PORT>`
  HTTP service port number. [default: 8000]

- `-i`, `--index-address` `<ADDRESS>`
  Index service address. [default: 0.0.0.0:5000]

- `-w`, `--worker-threads` `<THREADS>`
  Number of HTTP worker threads. By default http server uses number of available logical cpu as threads count. [default: 8]

- `-o`, `--cors-origin` `<ORIGIN>`
  Add an origin that are allowed to make requests.

- `-m`, `--cors-methods` `<METHODS>`
  Set a list of methods which the allowed origins are allowed to access for requests.

- `-l`, `--cors-headers` `<HEADERS>`
  Set a list of header field names which can be used when this resource is accessed by allowed origins.

- `-c`, `--cert-file` `<PATH>`
  Path to the TLS certificate file.

- `-k`, `--key-file` `<PATH>`
  Path to the TLS key file.

## EXAMPLES

To start a server with default options:

    $ bayard --host=192.168.1.22 \
             --port=8001 \
             --index-address=192.168.1.12:5001