github.com/hellofresh/janus@v0.0.0-20230925145208-ce8de8183c67/README.md (about)

     1  <p align="center">
     2    <img height="150" src="./janus-logo.png"  alt="Janus" title="Janus">
     3  </p>
     4  
     5  [![Build Status](https://travis-ci.org/hellofresh/janus.svg?branch=master)](https://travis-ci.org/hellofresh/janus)
     6  [![codecov](https://codecov.io/gh/hellofresh/janus/branch/master/graph/badge.svg)](https://codecov.io/gh/hellofresh/janus)
     7  [![GoDoc](https://godoc.org/github.com/hellofresh/janus?status.svg)](https://godoc.org/github.com/hellofresh/janus)
     8  [![Go Report Card](https://goreportcard.com/badge/github.com/hellofresh/janus)](https://goreportcard.com/report/github.com/hellofresh/janus)
     9  [![Join us on slack](https://img.shields.io/badge/chat-on%20slack-brightgreen.svg)](https://join.slack.com/t/janus-gw/shared_invite/enQtNTM1MDE3Mjg0ODIxLTVhNmQwODBmYTE1MmI5MDZiY2ZhN2ZmOGFiMGZmZTZmMzMxMTQ1MzA0NzY4ODA5Zjg1YzczNzg0ZjcwYjQwMjA)
    10  
    11  
    12  > An API Gateway written in Go
    13  
    14  This is a lightweight API Gateway and Management Platform that enables you to control who accesses your API, when they access it and how they access it. Janus will also record detailed analytics on how your users are interacting with your API and when things go wrong.
    15  
    16  Go version 1.9 or later is required to build master, the current development version. Janus is officially supported on `linux/amd64`, `linux/i386`, `linux/arm64`, `darwin/i386`, `darwin/amd64`, `windows/i386` and `windows/amd64`.
    17  
    18  ## Why Janus?
    19  
    20  > In ancient Roman religion and myth, Janus (/ˈdʒeɪnəs/; Latin: Ianus, pronounced [ˈjaː.nus]) is the god of beginnings,
    21  gates, transitions, time, doorways, passages, and endings. He is usually depicted as having two faces since he
    22  looks to the future and to the past. [Wikipedia](https://en.wikipedia.org/wiki/Janus)
    23  
    24  We thought it would be nice to name the project after the God of the Gates :smile:
    25  
    26  ## What is an API Gateway?
    27  
    28  An API Gateway sits in front of your application(s) and/or services and manages the heavy lifting of authorisation,
    29  access control and throughput limiting to your services. Ideally, it should mean that you can focus on creating
    30  services instead of implementing management infrastructure. For example, if you have written a really awesome
    31  web service that provides geolocation data for all the cats in NYC, and you want to make it public,
    32  integrating an API gateway is a faster, more secure route than writing your own authorisation middleware.
    33  
    34  ## Key Features
    35  
    36  This API Gateway offers powerful, yet lightweight features that allows fine-grained control over your API ecosystem.
    37  
    38  * No dependency hell, single binary made with go
    39  * REST API, full programatic access to the internals makes it easy to manage your API users, keys and API Configuration from within your systems
    40  * Hot-reloading of configuration. No need to restart the process
    41  * Graceful shutdown of http connections
    42  * [OpenTracing](http://opentracing.io/) support for Distributed tracing (Supports Google Cloud Platform and Jaeger)
    43  * HTTP/2 support
    44  * Circuit Breaker support that can be configured for each API
    45  * Retry mechanism to make your endpoints more resilient
    46  * Rate Limiting, easily rate limit your API users, rate limiting is granular and can be applied on a per-key basis
    47  * CORS Filter, enable cors for your API, or even for specific endpoints
    48  * Multiple auth protocols, out of the box, we support JWT, OAuth 2.0 and Basic Auth access methods
    49  * Small [official](https://hub.docker.com/repository/docker/hellofreshtech/janus) docker image included
    50  
    51  ## Installation
    52  
    53  > Note: All examples here and in the documentation will be using [HTTPie](https://httpie.org/) for simplicity. But all requests can easily be converted to `curl` if needed.
    54  
    55  ### Docker
    56  
    57  The simplest way of installing Janus is to run the docker image for it. You can check our [examples](/examples) folder and you can find some good examples. All you got to do is:
    58  
    59  ```sh
    60  cd examples/front-proxy
    61  
    62  docker-compose up -d
    63  ```
    64  
    65  Now you should be able to get a response from the gateway.
    66  
    67  Try the following command:
    68  
    69  ```sh
    70  http http://localhost:8081
    71  ```
    72  
    73  ### Manual
    74  
    75  You can get the binary and play with it in your own environment (or even deploy it where ever you like).
    76  Just go to the [releases](https://github.com/hellofresh/janus/releases) page and download the latest one for your platform.
    77  
    78  ## Getting Started
    79  
    80  Check out our [quick start guide](https://hellofresh.gitbooks.io/janus/quick_start) to get up to speed with Janus.
    81  
    82  ## Contributing
    83  
    84  To start contributing, please check [CONTRIBUTING](CONTRIBUTING.md).
    85  
    86  ## Documentation
    87  
    88  * Janus Docs: https://hellofresh.gitbooks.io/janus
    89  * Janus Go Docs: https://godoc.org/github.com/hellofresh/janus
    90  * Go lang: https://golang.org/
    91  
    92  ##
    93  <p align="center">
    94      <a href="https://hellofresh.com" style="text-decoration:none; margin-right:2rem;">
    95      <img height="110" src="https://www.hellofresh.de/images/hellofresh/press/HelloFresh_Logo.png">
    96    </a>
    97  </p>