0.0.3 • Published 3 years ago

@flowtr/proxybyrd v0.0.3

Weekly downloads
6
License
GPL-v3.0-or-later
Repository
-
Last release
3 years ago

ProxyByrd

Introduction

This is a package inspired by nano-gateway but that has been rewritten in typescript with extra features. ProxyByrd lets you serve your websites with HTML and PHP (php coming soon), as well as proxy to other web servers.

Usage

Installation

# NPM
npm i -g @flowtr/proxybyrd
# Yarn
yarn global add @flowtr/proxybyrd
# PNPM
pnpm i -g @flowtr/proxybyrd

Run

You can run ProxyByrd with its CLI command, optionally specifying the config file path. It currently only supports yaml/yml but I plan on adding json5 and toml support.

proxybyrd -c config.yml

Example Configuration

http:
    port: 8080
auth: false
apiKey: "123456"
services:
    index:
        path: "/"
        to:
            type: "render"
            path: "test.html"

Issues

Let me know if you have any issues here.