# @panosoft/chronicle-server

> An HTTPS Chronicle Server.

Latest version **0.1.1** (published 2016-02-04) · ISC license · 0 weekly downloads

## Install

```sh
npm install @panosoft/chronicle-server
pnpm add @panosoft/chronicle-server
yarn add @panosoft/chronicle-server
bun add @panosoft/chronicle-server
```

Provides the command `chronicle-server`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2016-02-04 |
| First published | 2016-01-25 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | panosoft |

## Links

- npm: https://www.npmjs.com/package/@panosoft/chronicle-server
- Repository: https://github.com/panosoft/chronicle-server
- Homepage: https://github.com/panosoft/chronicle-server#readme
- Issues: https://github.com/panosoft/chronicle-server/issues
- npm.io page: https://npm.io/package/@panosoft/chronicle-server

## Dependencies (8)

- [co](https://npm.io/package/co.md) ^4.6.0
- [is_js](https://npm.io/package/is_js.md) ^0.7.6
- [ramda](https://npm.io/package/ramda.md) ^0.19.1
- [bunyan](https://npm.io/package/bunyan.md) ^1.5.1
- [co-body](https://npm.io/package/co-body.md) ^4.0.0
- [mime-types](https://npm.io/package/mime-types.md) ^2.1.9
- [@panosoft/chronicle](https://npm.io/package/@panosoft/chronicle.md) ^0.10.3
- [@panosoft/https-server](https://npm.io/package/@panosoft/https-server.md) ^0.1.5

## Recent versions

- 0.1.1 (latest) — 2016-02-04
- 0.1.0 — 2016-01-25

## README

# Chronicle Server

> An HTTPS Chronicle report server.

[![npm version](https://img.shields.io/npm/v/@panosoft/chronicle-server.svg)](https://www.npmjs.com/package/@panosoft/chronicle-server)
[![Travis](https://img.shields.io/travis/panosoft/chronicle-server.svg)](https://travis-ci.org/panosoft/chronicle-server)

# Installation

```sh
npm install -g @panosoft/chronicle-server
```

# Usage

```sh
Usage: chronicle-server --key <path> --cert <path> [options]

An HTTPS Chronicle Server.

Options:

  -h, --help                    output usage information
  -V, --version                 output the version number
  -k, --key   <path>            Path to the private key of the server in PEM format.
  -c, --cert  <path>            Path to the certificate key of the server in PEM format.
  -p, --port  <port>            The port to accept connections on. Default: 8443.
  -i, --interface  <interface>  The interface to accept connections on. Default: 0.0.0.0.
```

# HTTPS API

## run

Run a report with a set of parameters.

### Request

- Pathname: `/`
- Method: `POST`
- Headers:
  - `Content-Type` - `'application/json'`
- Body:
  - `report` - {String} The url of the report bundle to run.
  - `[parameters]` - {Object} The parameters to pass to report at runtime.

### Responses

__Success__

- Status Code: `200`
- Headers:
  - `Request-Id` - {String} The unique request identifier.
  - `Content-Type` - `'application/json'`
- Body:
  - `result` - {\*} The report output.

__Error__

- Status Code: `500`
- Headers:
  - `Request-Id` - {String} The unique request identifier.
  - `Content-Type` - `'application/json'`
- Body:
  - `error` - {String} The error message.

---
_Source: https://npm.io/package/@panosoft/chronicle-server · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._