https://github.com/aravinth2094/goginx

A simpler version of Nginx, BUT MORE
https://github.com/aravinth2094/goginx

discovery discovery-service eureka gin go goginx golang nginx proxy reverse-proxy

Last synced: 25 days ago
JSON representation

A simpler version of Nginx, BUT MORE

• Host: GitHub
• URL: https://github.com/aravinth2094/goginx
• Owner: aravinth2094
• License: mit
• Created: 2021-09-17T14:23:22.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-03-07T02:34:17.000Z (almost 2 years ago)
• Last Synced: 2024-11-14T14:30:23.350Z (about 1 month ago)
• Topics: discovery, discovery-service, eureka, gin, go, goginx, golang, nginx, proxy, reverse-proxy
• Language: Go
• Homepage:
• Size: 140 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Actions Status](https://github.com/aravinth2094/goginx/workflows/Go%20Build/badge.svg)](https://github.com/aravinth2094/goginx/actions)

[![Go Report Card](https://goreportcard.com/badge/github.com/aravinth2094/goginx)](https://goreportcard.com/report/github.com/aravinth2094/goginx)

# Goginx

A simpler version of Nginx, BUT MORE.

## Features

* Upstreams

* Discovery Server (```POST /discovery { service, host, port }```)

* Custom HTTP Headers

* File Server

* Whitelist

* Compression

* CORS

* Secure HTTP Headers

* Remote configuration file

* Timeout

* Cache

* Logging

## Installation

* Install golang

* Install goreleaser

* Install make

```shell

go get

make build

```

## Goginx Configuration

Run using

```shell

goginx -c config.json

```

```shell

goginx -c https:///config.json

```

or if you have ```goginx.json``` in the current directory

```shell

goginx

```

Help Menu

```shell

Usage of goginx:

  -V    Validate configuration file

  -c string

        Goginx configuration file location (default "goginx.json")

  -h    Print this help

```

Basic Sample goginx.json file

```json

{

    "routes" : [

        {

            "path" : "/search",

            "forwardUrl" : "https://httpbin.org/anything",

            "allowedMethods": [ "GET", "POST" ]

        }

    ]

}

```

Advanced Sample goginx.json file

```json

{

    "listen" : ":443",

    "certificate" : "cert.pem",

    "key" : "key.pem",

    "log" : "goginx.log",

    "whitelist": [

        "127.0.0.1",

        "192.168.1.0/24"

    ],

    "compression" : true,

    "upstreams" : {

        "httpbin" : [

            "https://httpbin.org"

        ]

    },

    "discovery" : true,

    "routes" : [

        {

            "path" : "/search",

            "forwardUrl" : "httpbin:/anything",

            "allowedMethods": [ "GET", "POST" ],

            "forwardIp": true,

            "appendPath": false,

            "customHeaders" : {

                "X-Custom-Header1" : "Custom-Header1-Value",

                "X-Custom-Header2" : "Custom-Header2-Value"

            },

            "secureHeaders" : true,

            "cors" : {

                "origin" : "*",

                "methods" : "GET, POST",

                "credentials": true,

                "maxAge": "86400",

                "allowedHeaders": "Content-Type, Content-Length, Accept-Encoding, X-CSRF-Token, Authorization",

                "cacheControl": "no-cache",

                "vary": "Accept-Encoding"

            },

            "cache" : 60,

            "timeout" : 5000

        },

        {

            "path" : "/downloads",

            "forwardUrl" : "file://dist"

        }

    ]

}

```