https://github.com/panosoft/chronicle-server

https://github.com/panosoft/chronicle-server

Last synced: 12 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/panosoft/chronicle-server
• Owner: panosoft
• Created: 2016-01-14T22:08:20.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2016-02-04T22:58:39.000Z (almost 9 years ago)
• Last Synced: 2024-12-11T03:57:46.599Z (about 1 month ago)
• Language: JavaScript
• Size: 23.4 KB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

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  --cert  [options]

An HTTPS Chronicle Server.

Options:

  -h, --help                    output usage information

  -V, --version                 output the version number

  -k, --key               Path to the private key of the server in PEM format.

  -c, --cert              Path to the certificate key of the server in PEM format.

  -p, --port              The port to accept connections on. Default: 8443.

  -i, --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.