Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/szuecs/skipper
An HTTP router, built with Go, that acts as a reverse proxy with support for custom route definitions
https://github.com/szuecs/skipper
Last synced: 3 months ago
JSON representation
An HTTP router, built with Go, that acts as a reverse proxy with support for custom route definitions
- Host: GitHub
- URL: https://github.com/szuecs/skipper
- Owner: szuecs
- License: other
- Fork: true (zalando/skipper)
- Created: 2016-06-03T16:25:57.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-06-20T11:00:34.000Z (over 8 years ago)
- Last Synced: 2024-06-20T11:50:50.823Z (6 months ago)
- Language: Go
- Homepage:
- Size: 4.33 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/zalando/skipper)
[](https://godoc.org/github.com/zalando/skipper/proxy)
[](https://raw.githubusercontent.com/zalando/skipper/master/LICENSE)
[](https://goreportcard.com/report/zalando/skipper)
[](http://gocover.io/github.com/zalando/skipper)
# Skipper
Skipper is an HTTP router built on top of a reverse proxy with the ability to modifying requests and
responses with filters. You can use it out of the box or add your own custom filters and predicates.
### What Skipper Does
- identifies routes based on the requests' properties, such as path, method, host and headers
- routes each request to the configured server endpoint
- allows modification of requests and responds with filters that are independently configured for each route
- optionally acts as a final endpoint (shunt)
- updates the routing rules without restarting, while supporting multiple types of data sources — including [etcd](https://github.com/coreos/etcd), [Innkeeper](https://github.com/zalando/innkeeper) and static files
Skipper provides a default executable command with a few built-in filters,
however, its primary use case is to be extended with custom filters,
predicates or data sources. See more in the
[Documentation](https://godoc.org/github.com/zalando/skipper)
#### Inspiration
Skipper's design is largely inspired by [Vulcand](https://github.com/vulcand/vulcand).
### Getting Started
#### Prerequisites/Requirements
In order to build and run Skipper, only the latest version of Go needs to be installed.
Skipper can use Innkeeper or Etcd as data sources for routes. See more
details in the [Documentation](https://godoc.org/github.com/zalando/skipper).
#### Installation
Skipper is 'go get' compatible. If needed, create a Go workspace first:
mkdir ws
cd ws
export GOPATH=$(pwd)
export PATH=$PATH:$GOPATH/bin
Get the Skipper packages:
go get github.com/zalando/skipper/...
#### Running
Create a file with a route:
echo 'hello: Path("/hello") -> "https://www.example.org"' > example.eskip
Optionally, verify the file's syntax:
eskip check example.eskip
Start Skipper and make an HTTP request:
skipper -routes-file example.eskip &
curl localhost:9090/hello
#### Working with the code
Getting the code with the test dependencies (`-t` switch):
go get -t github.com/zalando/skipper/...
Build all packages:
cd src/github.com/zalando/skipper
go install ./...
Test all packages:
etcd/install.sh
go test ./...
### Documentation
Skipper's [godoc](https://godoc.org/github.com/zalando/skipper) page includes detailed information on these topics:
- The Routing Mechanism
- Matching Requests
- Filters - Augmenting Requests
- Service Backends
- Route Definitions
- Data Sources
- Extending It with Customized Predicates, Filters, and Builds
- Proxy Packages
- Logging and Metrics
- Performance Considerations