# tymly-runner

> A tool for running tymlys

Latest version **0.0.8** (published 2018-03-20) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install tymly-runner
pnpm add tymly-runner
yarn add tymly-runner
bun add tymly-runner
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.0.8 |
| Published | 2018-03-20 |
| First published | 2018-03-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 32.9 KB |
| Known vulnerabilities | 0 (+9 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 121 |
| Author | Reece Brend |
| Maintainers | timneedham |

## Links

- npm: https://www.npmjs.com/package/tymly-runner
- Repository: https://github.com/wmfs/tymly
- Homepage: https://github.com/wmfs/tymly#readme
- Issues: https://github.com/wmfs/tymly/issues
- npm.io page: https://npm.io/package/tymly-runner

## Dependencies (6)

- [boom](https://npm.io/package/boom.md) 7.2.0
- [debug](https://npm.io/package/debug.md) 3.1.0
- [tymly](https://npm.io/package/tymly.md) ^0.0.17
- [config](https://npm.io/package/config.md) 1.30.0
- [lodash](https://npm.io/package/lodash.md) 4.17.5
- [safe-buffer](https://npm.io/package/safe-buffer.md) 5.1.1

## Recent versions

- 0.0.8 (latest) — 2018-03-20

## README

# Tymly-runner
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com) [![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/wmfs/tymly/blob/master/packages/tymly-runner/LICENSE)

> A configurable environment for running [Tymly](http://www.tymlyjs.io) instances.

## <a name="tests"></a>Tests
```bash
$ npm test
```

## Environment Variables

Before starting, please set following environment variables:

| Variable Name          | Description |
| ---------------------- | ----------- |
| PG_CONNECTION_STRING   |  Connection string pointing to a specific PostgreSQL database, e.g. `PG_CONNECTION_STRING=postgres://postgres:postgres@localhost:5432/my_test_db`. | 
| TYMLY_AUTH_SECRET     |  A secret or private key used when [signing JWT Tokens](https://www.npmjs.com/package/jsonwebtoken#jwtsignpayload-secretorprivatekey-options-callback). For example `TYMLY_AUTH_SECRET=Shh!`. |
| TYMLY_AUTH_AUDIENCE   |  Specifies an audience (`aud`) alongisde `TYMLY_AUTH_SECRET` when signing a JWT, e.g. `TYMLY_AUTH_AUDIENCE="I am the audience!".` 
| TYMLY_PLUGINS_PATH    |  Plugin directories to use at boot-time, `;` delimited if multiple sources. For example: `TYMLY_PLUGINS_PATH="/plugins/production/*-plugin;/plugins/development/*-plugin"`. |
| TYMLY_BLUEPRINTS_PATH |  Exactly the same as `TYMLY_PLUGINS_PATH`, but used to specifiy the location(s) of blueprints to load at boot time, e.g. `TYMLY_BLUEPRINTS_PATH="/blueprints/production/*-blueprint;/plugins/development/*-blueprint"`. |
| TYMLY_ADMIN_USERID    |  Identifies a username (that will be decoded from incoming JWT tokens) which should be treated as an administrator. For example: `TYMLY_ADMIN_USERID=bigboss`.|
| TYMLY_ADMIN_ROLES     |  Indicates which roles should be automatically granted to the user identified by `TYMLY_ADMIN_USERID` (delimited by `,`). For example: `TYMLY_ADMIN_ROLES=tymly_admin`. |
| DEBUG                  |  We use the [debug](https://www.npmjs.com/package/debug) package, where Tymly plugin and state names equate to debug modules, for example: `DEBUG=tymly,processingCscFiles,-express`.

## Starting 

```bash
$ npm run start
```

## <a name="license"></a>License
[MIT](https://github.com/wmfs/tymly-runner/blob/master/LICENSE)

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