# winston-zulip

> A zulip transport for Winston

Latest version **0.0.7** (published 2017-04-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install winston-zulip
pnpm add winston-zulip
yarn add winston-zulip
bun add winston-zulip
```

## 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.0.7 |
| Published | 2017-04-21 |
| First published | 2017-04-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.8.0 |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | huneau romain |
| Maintainers | huneau |
| Keywords | logging, sysadmin, tools, winston, zulip |

## Links

- npm: https://www.npmjs.com/package/winston-zulip
- Repository: https://github.com/huneau/winston-zulip
- Homepage: https://github.com/huneau/winston-zulip#readme
- Issues: https://github.com/huneau/winston-zulip/issues
- npm.io page: https://npm.io/package/winston-zulip

## Dependencies (2)

- [winston](https://npm.io/package/winston.md) 2.3.1
- [zulip-js](https://npm.io/package/zulip-js.md) 1.0.12

## Alternatives

- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads

## Recent versions

- 0.0.7 (latest) — 2017-04-21
- 0.0.6 — 2017-04-19
- 0.0.5 — 2017-04-19
- 0.0.4 — 2017-04-19
- 0.0.3 — 2017-04-19
- 0.0.2 — 2017-04-19
- 0.0.1 — 2017-04-19

## README

# winston-zulip
A [winston logger](https://github.com/winstonjs/winston) for zulip.

## Usage
```javacript
const winston = require('winston');
require('winston-zulip');


winston.add(winston.transports.Zulip, {
  zulipUsername: '<username>',
  zulipApikey: '<apikey>',
  zulipRealm: '<your domain>',
  zulipTo: 'my awesome collegue',
  zulipSubject: 'admin rights'
});

winston.log('info', 'Hello distributed log files!');
```

## apikey creation 

`http://yourdomain/#settings`

![apikeycreation][https://github.com/huneau/winston-zulip/zulip-apikey.png]

You can create your own apikey or create a bot and retreive it own apikey. For both of these solution, you can download a file that refer all needed variable.

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