# winston-s3

> S3 transport for Winston

Latest version **1.0.0** (published 2015-07-20) · BSD license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2015-07-20 |
| First published | 2013-01-09 |
| Weekly downloads | 0 |
| License | BSD |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 10 |
| Author | Andrew Harvey |
| Maintainers | pinion, davidbanham |
| Keywords | winston, s3, logging |

## Links

- npm: https://www.npmjs.com/package/winston-s3
- Repository: https://github.com/PinionTech/winston-s3
- Issues: https://github.com/PinionTech/winston-s3/issues
- npm.io page: https://npm.io/package/winston-s3

## Dependencies (6)

- [knox](https://npm.io/package/knox.md) ~0.9.1
- [temp](https://npm.io/package/temp.md) ~0.5.0
- [findit](https://npm.io/package/findit.md) ~0.1.2
- [winston](https://npm.io/package/winston.md) ~0.7.2
- [node-uuid](https://npm.io/package/node-uuid.md) ~1.4.0
- [coffee-script](https://npm.io/package/coffee-script.md) ~1.4.0

## 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

- 1.0.0 (latest) — 2015-07-20
- 0.2.0 — 2014-11-08
- 0.1.1 — 2014-09-09
- 0.1.0 — 2014-01-14
- 0.0.16 — 2013-12-17
- 0.0.15 — 2013-11-22
- 0.0.13 — 2013-01-14
- 0.0.12 — 2013-01-11
- 0.0.11 — 2013-01-10
- 0.0.10 — 2013-01-10
- 0.0.9 — 2013-01-10
- 0.0.8 — 2013-01-10
- 0.0.7 — 2013-01-10
- 0.0.6 — 2013-01-10
- 0.0.5 — 2013-01-10
- … 4 more at https://npm.io/package/winston-s3/versions

## README

winston-s3
===============

A full featured S3 transport for winston

## Install

```bash
npm i -S winston winston-s3
```

## Setup

```js
var winston = require('winston')
  , winstonS3 = require('winston-s3')

winston.add(winstonS3, {
  key: 's3-key'
  , secret: 's3-secret'
  , bucket: 'bucket-name'
  
  // optional
  , maxSize: 20 * 1024 * 1024 // default
  , id: '' // defaults to the hostname
  , nested: false
  , path: // defaults to 's3Logs'
  , temp: false
  , debug: false
  , headers: {} //headers that will be passed along to knox for the http requests
})

```

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