README.md

Couper Example Collection

Couper is designed to support developers building and operating API-driven Web projects by offering security and observability functionality in a frontend gateway component.

This collection of examples highlights Couper's features with small, ready-to-use examples. If you have any questions or feedback you are welcome to start a discussion.

Getting started

To run the examples you need Couper. It is available as docker image from Docker Hub

This requires a working Docker setup on your computer. Please visit the get started guide to get prepared.

To run the examples, clone the repository:

$ git clone https://github.com/coupergateway/couper-examples.git
Cloning into 'couper-examples'...

change into the couper-examples directory:

cd couper-examples

Choose an example, change to its directory:

cd simple-fileserving

and run

docker-compose pull && docker-compose up

Press CTRL+C to exit.

Examples

File & Web Serving

• Simple File-Serving
• SPA Serving
  • Apply bootstrap_data to your SPA

Requests & Responses

• Proxy API Requests
• Custom Requests
• Multiple Requests
• Static Responses
• Backend Validation
• Path Parameter
• Query Parameter Manipulation
• Sending JSON Content
• Sending Form Content
• Redirects
• Request Sequences

Authorization & Authentication

• JWT Access Control
• Sending JWT Claims Upstream
• Permissions
• Permissions (Role-based Access Control)
• Permissions (Map)
• Creating JWT
• Backend Authorization using OAuth2
• Single-Sign-On with SAML
• Error Handling for Access Controls
• Userinfo Endpoint
• OpenID Connect

Running Couper

• Environment based configuration
• Handling configuration files
• Environment Variables
• Emitting Environment Variables
• Using docker
• Using docker-compose
• Kubernetes
• Linking Docker Containers
• Custom Logging