https://github.com/cenk1cenk2/docker-nginx-ingress

An ingress controller for docker-compose stacks via using stream functionality of Nginx.
https://github.com/cenk1cenk2/docker-nginx-ingress

Last synced: about 4 hours ago
JSON representation

An ingress controller for docker-compose stacks via using stream functionality of Nginx.

• Host: GitHub
• URL: https://github.com/cenk1cenk2/docker-nginx-ingress
• Owner: cenk1cenk2
• Created: 2022-04-10T11:58:51.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-06T17:57:55.000Z (12 days ago)
• Last Synced: 2024-11-06T18:54:03.987Z (12 days ago)
• Language: Go
• Homepage:
• Size: 198 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# docker-nginx-ingress

[![pipeline status](https://gitlab.kilic.dev/docker/nginx-ingress/badges/main/pipeline.svg)](https://gitlab.kilic.dev/docker/nginx-ingress/-/commits/main) [![Docker Pulls](https://img.shields.io/docker/pulls/cenk1cenk2/nginx-ingress)](https://hub.docker.com/repository/docker/cenk1cenk2/nginx-ingress) [![Docker Image Size (latest by date)](https://img.shields.io/docker/image-size/cenk1cenk2/nginx-ingress)](https://hub.docker.com/repository/docker/cenk1cenk2/nginx-ingress) [![Docker Image Version (latest by date)](https://img.shields.io/docker/v/cenk1cenk2/nginx-ingress)](https://hub.docker.com/repository/docker/cenk1cenk2/nginx-ingress) [![GitHub last commit](https://img.shields.io/github/last-commit/cenk1cenk2/docker-nginx-ingress)](https://github.com/cenk1cenk2/docker-nginx-ingress)

## Description

Nginx ingress controller for docker-compose stacks, where it takes in a JSON environment variable for the defined containers and load-balances them through streams of Nginx.

- [CLI Documentation](./CLI.md)

- [Setup](#setup)

- [Environment Variables](#environment-variables)

  - [`NGINX_INGRESS`](#nginx_ingress)

  - [CLI](#cli)

## Setup

You can run this application as a `docker-compose` stack. The image is hosted as `cenk1cenk2/nginx-ingress` on DockerHub. Check out the [docker-compose](./docker-compose.yml) file for example configuration.

## Environment Variables

### `NGINX_INGRESS`

The environment variable `NGINX_INGRESS` is an array of objects in the JSON form to define the endpoints and load-balanced containers.

```jsonc

[

  {

    "server": {

      "listen": "string", // listen port and type for endpoint

      "options": {

        // key-value pairs of options that should be passed to "server" configuration of Nginx

      }

    },

    "upstream": {

      "servers": [

        // string slice of balanced servers

      ],

      "options": {

        // key-value pairs of options that should be passed to "upstream" configuration of Nginx

      }

    }

  }

]

```

| Flag / Environment |  Description   |  Type    | Required | Default |

|---------------- | --------------- | --------------- |  --------------- |  --------------- |

| `$NGINX_INGRESS` | The configuration for the ingress operation of Nginx. | `String`
`json({ server: struct { listen: string, options: map[string]string }, upstream: struct { servers: []string, options: map[string]string } })` | `true` |  |

### CLI

| Flag / Environment |  Description   |  Type    | Required | Default |

|---------------- | --------------- | --------------- |  --------------- |  --------------- |

| `$LOG_LEVEL` | Define the log level for the application. | `String`
`enum("panic", "fatal", "warn", "info", "debug", "trace")` | `false` | info |

| `$ENV_FILE` | Environment files to inject. | `StringSlice` | `false` |  |