# easy-portforward

> Port forward connections tool

Latest version **3.1.1** (published 2023-05-26) · GPL-3 license · 0 weekly downloads

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

## Install

```sh
npm install easy-portforward
pnpm add easy-portforward
yarn add easy-portforward
bun add easy-portforward
```

Provides the commands `epf`, `easy-portforward`.

## Health

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

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 3.1.1 |
| Published | 2023-05-26 |
| First published | 2022-04-27 |
| Weekly downloads | 0 |
| License | GPL-3 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=14.0.0 |
| Dependencies | 7 |
| Unpacked size | 1.7 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Luis Arias |
| Maintainers | ariassd |
| Keywords | rancher, portforward |

## Links

- npm: https://www.npmjs.com/package/easy-portforward
- Repository: https://github.com/ariassd/easy-portforward
- Issues: https://github.com/ariassd/easy-portforward/issues
- npm.io page: https://npm.io/package/easy-portforward

## Dependencies (7)

- [open](https://npm.io/package/open.md) ^8.4.0
- [chalk](https://npm.io/package/chalk.md) ^4.1.1
- [express](https://npm.io/package/express.md) ^4.17.1
- [minimist](https://npm.io/package/minimist.md) ^1.2.5
- [socket.io](https://npm.io/package/socket.io.md) ^4.5.3
- [readline-sync](https://npm.io/package/readline-sync.md) ^1.4.10
- [socket.io-client](https://npm.io/package/socket.io-client.md) ^2.4.0

## Recent versions

- 3.1.1 (latest) — 2023-05-26
- 3.1.0-rc.2 (rc) — 2023-01-16
- 3.1.0-alpha.3 (alpha) — 2022-12-10
- 3.1.0 — 2023-01-31
- 3.1.0-rc.1 — 2022-12-25
- 3.1.0-alpha.2 — 2022-11-07
- 3.1.0-alpha.1 — 2022-11-06
- 2.1.0 — 2022-05-01
- 2.0.1 — 2022-04-27

## README

![](assets/header.png)

# Easy port-forward connections manager

## Description

Package is not longer supported

This is a tiny tool installed via npm that allows you to manage and connect kubernetes services using port forward in an easy way.

![](assets/screenshot.png)

## Requirement

- Kubectl
- Previous authorization and rancher configurations
- VPN

## Install

Install globally from one of the following sources
`npm i -g easy-portforward`

## Configuration

1. Download the configuration file from rancher.
2. Save the configuration file in `~/.easy-portforward/store`
3. Create the database with port forward connections. `~/.easy-portforward/store`

```json
{
  "environment": {
    "config": "sandbox.yml",
    "name": "Development environment",
    "acronym": "DEV",
    "portRange": 21
  },
  "services": [
    {
      "description": "API Rest service",
      "owner": "Team number 1",
      "namespace": "< Rancher namespace >",
      "label": "< pod label name >",
      "labelValue": "< pod label value >",
      "type": "Https api rest service",
      "ports": "X001:80", //👈 ports mapping separated by the colon symbol ':' first and second port should be a valid port number
      // You can use optionally an X to represent the port range X will be replaced by the value in `environment.portRange`
      "verified": false
    }
  ]
}
```

## Running the scripts

Before running the script is important to check you are connected to the VPN using the official software `Open VPN`

```bash
# Start using user interface
$ epf
```

## Useful commands

```bash

# Start using shell
$ epf --shell

# Help
$ epf --help

# Help
$ epf --config

# List ports
epf --ports

# Show verbose mode
epf --verbose

# Use a gauzy script with variables
epf --verbose --gauzy

```

## To send params when you run in develop

Add the symbol '--' between the script call `npm run start:dev` and the params like this

```bash
## Run UI mode
npm run start:dev

## Run Shell mode
npm run start:dev -- --shell
npm run start:dev -- --verbose
```

## Developer

- Author - Luis Arias 2021 <<ariassd@gmail.com>>
  [GitHub profile](https://github.com/ariassd)

## License

This software is licensed under [MIT License](LICENSE)

![](assets/open-source.png)

May 2021

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