# proxigen

> ### Usage ```bash yarn global add proxigen proxigen start ```

Latest version **1.0.1** (published 2021-03-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install proxigen
pnpm add proxigen
yarn add proxigen
bun add proxigen
```

Provides the command `proxigen`.

## 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.1 |
| Published | 2021-03-19 |
| First published | 2020-05-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 3.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | iamfat |

## Links

- npm: https://www.npmjs.com/package/proxigen
- npm.io page: https://npm.io/package/proxigen

## Dependencies (4)

- [yaml](https://npm.io/package/yaml.md) ^1.10.0
- [chalk](https://npm.io/package/chalk.md) ^4.0.0
- [redbird](https://npm.io/package/redbird.md) ^0.10.0
- [minimist](https://npm.io/package/minimist.md) ^1.2.5

## Recent versions

- 1.0.1 (latest) — 2021-03-19
- 1.0.0 — 2020-05-27

## README

# ProxiGen - a proxy client for host remapping powered by RedBird

### Usage
```bash
yarn global add proxigen
proxigen start
```

### Configuration
```yaml
# ~/.proxigenrc in YAML format
server:
  port: 80
mappings:
  - from: tank.giot.in
    to: http://localhost:3000
```

### SSL
1. Generate certifications with certbot and openssl
    ```bash
    # use certbot to generate pems firstly.
    # TODO: cerbot example

    # since redbird used by proxigen does not support privkey.pem directly, we need to convert it into rsa key
    openssl rsa -in privkey.pem -out privkey.rsa.pem
    ```
2. Edit `~/.proxigenrc` file
    ```yaml
    server:
      ssl:
        port: 443
    mappings:
      - from: tank.giot.in/gsen
        to: http://localhost:3000
        options:
          ssl:
            key: '/your/path/to/privkey.rsa.pem'
            cert: '/your/path/to/fullchain.pem'
    ```

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