github.com/avenga/couper@v1.12.2/README.md (about)

     1  # Couper
     2  
     3  ![Go](https://github.com/avenga/couper/workflows/Go/badge.svg)
     4  [![Go Report](https://goreportcard.com/badge/github.com/avenga/couper)](https://goreportcard.com/report/github.com/avenga/couper)
     5  ![Docker](https://github.com/avenga/couper/workflows/Docker/badge.svg)
     6  
     7  ![Couper](docs/website/public/img/couper-logo.svg)
     8  
     9  **Couper** is a lightweight API gateway designed to support developers in building and operating API-driven Web projects.
    10  
    11  ## Getting started
    12  
    13  * The quickest way to start is to use our [Docker image](https://hub.docker.com/r/avenga/couper).
    14    * or via [homebrew](https://brew.sh/): `brew tap avenga/couper && brew install couper`
    15  * The [documentation](https://docs.couper.io/) gives an introduction to Couper.
    16  * Check out the [example repository](https://github.com/avenga/couper-examples) to learn about Couper's features in detail.
    17  * Use-cases can be found on [couper.io](https://couper.io).
    18  
    19  ## Features
    20  
    21  Couper …
    22  
    23  * is a proxy component connecting clients with (micro) services
    24  * adds access control and observability to the project
    25  * needs no special development skills
    26  * is easy to configure & integrate
    27  * runs on Linux, Mac OS X, Windows, Docker and Kubernetes.
    28  
    29  Key features are:
    30  
    31  * **Easy Configuration & Deployment**
    32  * HTTP Request Routing / Forwarding
    33  * Custom Requests and Responses
    34  * Request / Response Manipulation
    35  * Centralized **Access-Control** Layer:
    36    * Basic-Auth
    37    * JWT  Validation & Signing
    38    * Single Sign On with SAML2
    39    * OAuth2 Client Credentials
    40    * OpenID-connect
    41  * **Configurable Service Connectivity**
    42  * Upstream Validation & CORS
    43  * SPA & Web Serving
    44    * inject server data / environment variables to your SPA
    45  * Error Handling
    46  * Observability
    47    * Prometheus exporter
    48  * Security with mTLS support as server and for backend services
    49  
    50  The full list of features of Couper 1.x is [here](FEATURES.md) or at [couper.io](https://couper.io/en/features).
    51  
    52  ## Developers
    53  
    54  *Developers* requiring [Go](https://golang.org/) to start with `make build`.
    55  Couper requires a [configuration file](./docs/README.md#configuration-file). You can start with a simple one and use:
    56  
    57  ```ps
    58  ./couper run -f public/couper.hcl
    59  ```
    60  
    61  ## Contributing
    62  
    63  Thanks for your interest in contributing.
    64  
    65  If you have any questions or feedback you are welcome to start a [discussion](https://github.com/avenga/couper/discussions).
    66  
    67  If you have an issue please open an [issue](https://github.com/avenga/couper/issues).