@andriepu/floo
A powerful proxy service
Last updated 7 months ago by andriepu .
MIT · Repository · Original npm · Tarball · package.json
$ cnpm install @andriepu/floo 
SYNC missed versions from official npm registry.

Floo

"Floo is a powerful proxy service used for mocking any requests."

Installation

Install floo globally.

$ npm i -g @andriepu/floo

Add FLOO_ROOT into the last line of your shell environment file (e.g. .bashrc, .zshrc, etc.) based on where you install the package.

export FLOO_ROOT="$(npm root -g)/@andriepu/floo"

Initial Setup

$ floo config

And then, you will be prompted by some questions that you need to adjust with your local environment.

Any config will be saved on your $HOME directory, under the file named config.json inside .floo/ folder. If you want to change any of your config, you can edit it manually or simply re-run this comamnd again.

Usage

  • Starting service:
$ floo start

Once the service started, you can configure your local routings by visiting http://localhost:{{$FRONTEND_PORT}}.

There will be some basic menu that you can access via sidebar:

  • Routings:

    List of routing urls grouped by its subdomain containing data about url to be proxied and how will the request will be handled. URL that can be proxied will be based on http://*.{{$PROXY_HOST}}:{{$PROXY_PORT}}}.

    There will be some informations that you need to provide in order to create a new routing:

    Field Name Description Required
    Host Subdomain of the target path Yes
    Path Path of target. Leave it blank if you want to cover all the paths. The default matching used here is based on path-to-regexp expression which is used by Express. But if you want to use pure regex, you must put down your regex path between ^ and / No
    Path Method HTTP method to access the URL. You can select ALL option if you want to cover all methods Yes
    Response Type Method used to response to the requested url. Detail about this information will be explained later Yes

    Response Type

    • Dummy:

      This type of response can be used when you have a raw text of response. This can be very useful if the target response is always simple and static.

      Field Name Description Required
      Mime Type MIME Type of dummy response Yes
      Response Raw text of dummy response Yes
    • Proxy:

      This type of response can be used if you want to forward request to a specific server.

      Field Name Description Required
      Proxy Server Server to handle request. Lis of this servers can be configured in Servers menu in sidebar Yes
      Auth Mask Credential used on requested server No
      Modify Path Whether you want to modify request path or not No
      Modify Response Whether you want to modify response or not No
      Websocket Whether you want to proxy websocket or not No
      Cache Response Whether you want to cache the first respnse as a Dummy response and switch the response type to Dummy as well No
  • Routing Order:

    Floo will process the request based on the first match of the order. From this menu, you can config the matching order.

  • Servers:

    List of proxy servers.

    There will be some informations that you need to provide in order to create a new server:

    Field Nome Description Required
    Domain Server domain Yes
    Alias Server alias No
    Authentication Authentication method that can be used to access server resource No

Current Tags

  • 0.2.6                                ...           latest (7 months ago)

8 Versions

  • 0.2.6                                ...           7 months ago
  • 0.2.5                                ...           7 months ago
  • 0.2.4                                ...           7 months ago
  • 0.2.3                                ...           7 months ago
  • 0.2.2                                ...           a year ago
  • 0.2.1                                ...           a year ago
  • 0.2.0                                ...           a year ago
  • 0.1.0                                ...           a year ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 8
Last Month 24
Dependencies (33)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |