Skip to content

Latest commit

 

History

History
106 lines (82 loc) · 4.08 KB

README.md

File metadata and controls

106 lines (82 loc) · 4.08 KB

nano-gateway

NPM version Build status Node version Docker Hub XO code style License

Lightweight API gateway for home-scale projects.

Features:

  • Single-file YAML configuration
  • HTTPS support
  • Secure endpoints with API key
  • URL rewriting
  • Less than 60 LOC 😄

Installation

npm install -g nano-gateway

Usage

Usage: nanog [--config file.yml] [--keygen]

Use the nanog command to start the gateway.

By default, it will use the config.yml configuration in the current working directory, but any file can be specified using either the NANO_GATEWAY_CONFIG environment variable or the --config option.

The --keygen will generate a suitable API key to use in your configuration.

Configuration

Here is an example config.yml configuration:

http:                 # optional, enable HTTP gateway
  port: 8080          # optional, specify port for HTTP (default is 8080)
https:                # optional, enable HTTPS gateway
  cert: 'cert.pem'    # required, certificate path
  key: 'privkey.pem'  # required, private key path
  ca: 'chain.pem'     # optional, override trusted CA certificates
  port: 8443          # optional, specify port for HTTPS (default is 8443)
auth: true            # optional, enable API key authorization by default for all services
apiKey: '123456'      # required if auth is enabled, use nanog --keygen to generate a new key
services:             # required, define here the services to proxify
  ip:                           # required, service name
    path: '/ip'                 # required, endpoint(s) (use Express route syntax, see npmjs.com/path-to-regexp)
    url: 'https://httpbin.org'  # required, target url for
    auth: false                 # optional, authorization can be set or overriden by service
  quote:                        # another service, add as many as you need
    path: '/jokes/*'            # matches any routes under /jokes/
    rewrite: '/jokes/random'    # optional, rewrite URL (for syntax, see npmjs.com/express-urlrewrite)
    url: 'https://api.chucknorris.io'

API key

Endpoints secured by API key can be consumed either by using an apiKey query parameter:

curl https://gateway.com/endpoint?apiKey=<your_api_key>

or by using an Authorization header:

curl -H "Authorization: <your_api_key>" https://gateway.com/endpoint

Note: It is strongly recommended to use only HTTPS with API keys, otherwise your credentials will circulate in clear over the network and may be intercepted.

HTTPS

To enable HTTPS you need a valid SSL certificate.

Free LetsEncrypt certificates can be obtained using certbot.

For testing purposes, you can also generate a self-signed certificate using this command:

openssl req -nodes -new -x509 -keyout privkey.pem -out cert.pem

After you have your certificate, use it in your configuration like this:

https:
  cert: 'cert.pem'
  key: 'privkey.pem'
  ca: 'chain.pem' # optional, override trusted CA certificates

Running on Docker

A minimal Docker image based on node:alpine is also available for deployment.

You just need to map a folder with a config.yml file in it to the /config volume:

docker pull sinedied/nano-gateway
docker run --d -v <your_config_dir>:/config -p 8443:8443 --name nano-gateway sinedied/nano-gateway