Add partners, move contributing
This commit is contained in:
parent
71b0e27517
commit
ec16011e31
4 changed files with 92 additions and 77 deletions
78
.github/CONTRIBUTING.md
vendored
Normal file
78
.github/CONTRIBUTING.md
vendored
Normal file
|
@ -0,0 +1,78 @@
|
||||||
|
# Contributing
|
||||||
|
|
||||||
|
### Building
|
||||||
|
|
||||||
|
You need either [Docker](https://github.com/docker/docker) and `make`, or `go` and `glide` in order to build traefik.
|
||||||
|
|
||||||
|
#### Setting up your `go` environment
|
||||||
|
|
||||||
|
- You need `go` v1.5
|
||||||
|
- You need to set `export GO15VENDOREXPERIMENT=1` environment variable
|
||||||
|
- You need `go-bindata` to be able to use `go generate` command (needed to build) : `go get github.com/jteeuwen/go-bindata/...`.
|
||||||
|
- If you clone Træfɪk into something like `~/go/src/github.com/traefik`, your `GOPATH` variable will have to be set to `~/go`: export `GOPATH=~/go`.
|
||||||
|
|
||||||
|
#### Using `Docker` and `Makefile`
|
||||||
|
|
||||||
|
You need to run the `binary` target. This will create binaries for Linux platform in the `dist` folder.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ make binary
|
||||||
|
docker build -t "traefik-dev:no-more-godep-ever" -f build.Dockerfile .
|
||||||
|
Sending build context to Docker daemon 295.3 MB
|
||||||
|
Step 0 : FROM golang:1.5
|
||||||
|
---> 8c6473912976
|
||||||
|
Step 1 : RUN go get github.com/Masterminds/glide
|
||||||
|
[...]
|
||||||
|
docker run --rm -v "/var/run/docker.sock:/var/run/docker.sock" -it -e OS_ARCH_ARG -e OS_PLATFORM_ARG -e TESTFLAGS -v "/home/emile/dev/go/src/github.com/emilevauge/traefik/"dist":/go/src/github.com/emilevauge/traefik/"dist"" "traefik-dev:no-more-godep-ever" ./script/make.sh generate binary
|
||||||
|
---> Making bundle: generate (in .)
|
||||||
|
removed 'gen.go'
|
||||||
|
|
||||||
|
---> Making bundle: binary (in .)
|
||||||
|
|
||||||
|
$ ls dist/
|
||||||
|
traefik*
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Using `glide`
|
||||||
|
|
||||||
|
The idea behind `glide` is the following :
|
||||||
|
|
||||||
|
- when checkout(ing) a project, **run `glide up --quick`** to install
|
||||||
|
(`go get …`) the dependencies in the `GOPATH`.
|
||||||
|
- if you need another dependency, import and use it in
|
||||||
|
the source, and **run `glide get github.com/Masterminds/cookoo`** to save it in
|
||||||
|
`vendor` and add it to your `glide.yaml`.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ glide up --quick
|
||||||
|
# generate
|
||||||
|
$ go generate
|
||||||
|
# Simple go build
|
||||||
|
$ go build
|
||||||
|
# Using gox to build multiple platform
|
||||||
|
$ gox "linux darwin" "386 amd64 arm" \
|
||||||
|
-output="dist/traefik_{{.OS}}-{{.Arch}}"
|
||||||
|
# run other commands like tests
|
||||||
|
$ go test ./...
|
||||||
|
ok _/home/vincent/src/github/vdemeester/traefik 0.004s
|
||||||
|
```
|
||||||
|
|
||||||
|
### Tests
|
||||||
|
|
||||||
|
You can run unit tests using the `test-unit` target and the
|
||||||
|
integration test using the `test-integration` target.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ make test-unit
|
||||||
|
docker build -t "traefik-dev:your-feature-branch" -f build.Dockerfile .
|
||||||
|
# […]
|
||||||
|
docker run --rm -it -e OS_ARCH_ARG -e OS_PLATFORM_ARG -e TESTFLAGS -v "/home/vincent/src/github/vdemeester/traefik/dist:/go/src/github.com/emilevauge/traefik/dist" "traefik-dev:your-feature-branch" ./script/make.sh generate test-unit
|
||||||
|
---> Making bundle: generate (in .)
|
||||||
|
removed 'gen.go'
|
||||||
|
|
||||||
|
---> Making bundle: test-unit (in .)
|
||||||
|
+ go test -cover -coverprofile=cover.out .
|
||||||
|
ok github.com/emilevauge/traefik 0.005s coverage: 4.1% of statements
|
||||||
|
|
||||||
|
Test success
|
||||||
|
```
|
91
README.md
91
README.md
|
@ -4,6 +4,8 @@ ___
|
||||||
[![Build Status](https://travis-ci.org/emilevauge/traefik.svg?branch=master)](https://travis-ci.org/emilevauge/traefik)
|
[![Build Status](https://travis-ci.org/emilevauge/traefik.svg?branch=master)](https://travis-ci.org/emilevauge/traefik)
|
||||||
[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://github.com/EmileVauge/traefik/blob/master/LICENSE.md)
|
[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://github.com/EmileVauge/traefik/blob/master/LICENSE.md)
|
||||||
[![Join the chat at https://traefik.herokuapp.com](https://img.shields.io/badge/style-register-green.svg?style=social&label=Slack)](https://traefik.herokuapp.com)
|
[![Join the chat at https://traefik.herokuapp.com](https://img.shields.io/badge/style-register-green.svg?style=social&label=Slack)](https://traefik.herokuapp.com)
|
||||||
|
[![Twitter](https://img.shields.io/twitter/follow/traefikproxy.svg?style=social)](https://twitter.com/intent/follow?screen_name=traefikproxy)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Træfɪk is a modern HTTP reverse proxy and load balancer made to deploy microservices with ease.
|
Træfɪk is a modern HTTP reverse proxy and load balancer made to deploy microservices with ease.
|
||||||
|
@ -54,28 +56,28 @@ You can access to a simple HTML frontend of Træfik.
|
||||||
- The simple way: grab the latest binary from the [releases](https://github.com/emilevauge/traefik/releases) page and just run it with the [sample configuration file](https://raw.githubusercontent.com/EmileVauge/traefik/master/traefik.sample.toml):
|
- The simple way: grab the latest binary from the [releases](https://github.com/emilevauge/traefik/releases) page and just run it with the [sample configuration file](https://raw.githubusercontent.com/EmileVauge/traefik/master/traefik.sample.toml):
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
./traefik traefik.toml
|
./traefik -c traefik.toml
|
||||||
```
|
```
|
||||||
|
|
||||||
- Use the tiny Docker image:
|
- Use the tiny Docker image:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
docker run -d -p 8080:8080 -p 80:80 -v $PWD/traefik.toml:/traefik.toml emilevauge/traefik
|
docker run -d -p 8080:8080 -p 80:80 -v $PWD/traefik.toml:/etc/traefik/traefik.toml emilevauge/traefik
|
||||||
```
|
```
|
||||||
|
|
||||||
- From sources:
|
- From sources:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
git clone https://github.com/EmileVauge/traefik
|
git clone https://github.com/emilevauge/traefik
|
||||||
```
|
```
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
You can find the complete documentation [here](docs/index.md).
|
You can find the complete documentation [here](docs/index.md).
|
||||||
|
|
||||||
## Benchmarks
|
## Contributing
|
||||||
|
|
||||||
Refer to the [benchmarks section](docs/index.md#benchmarks) in the documentation.
|
Please refer to [this section](.github/CONTRIBUTING.md).
|
||||||
|
|
||||||
## Træfɪk here and there
|
## Træfɪk here and there
|
||||||
|
|
||||||
|
@ -91,81 +93,16 @@ These projects use Træfɪk internally. If your company uses Træfɪk, we would
|
||||||
![Web UI Providers](docs/img/apollo-logo.png)
|
![Web UI Providers](docs/img/apollo-logo.png)
|
||||||
> Apollo is an open source project to aid with building and deploying IAAS and PAAS services. It is particularly geared towards managing containerized applications across multiple hosts, and big data type workloads. Apollo leverages other open source components to provide basic mechanisms for deployment, maintenance, and scaling of infrastructure and applications.
|
> Apollo is an open source project to aid with building and deploying IAAS and PAAS services. It is particularly geared towards managing containerized applications across multiple hosts, and big data type workloads. Apollo leverages other open source components to provide basic mechanisms for deployment, maintenance, and scaling of infrastructure and applications.
|
||||||
|
|
||||||
## Contributing
|
## Partners
|
||||||
|
|
||||||
### Building
|
[![Zenika](docs/img/zenika.logo.png)](https://zenika.com)
|
||||||
|
|
||||||
You need either [Docker](https://github.com/docker/docker) and `make`, or `go` and `glide` in order to build traefik.
|
Zenika is one of the leading providers of professional Open Source services and agile methodologies in
|
||||||
|
Europe. We provide consulting, development, training and support for the world’s leading Open Source
|
||||||
|
software products.
|
||||||
|
|
||||||
#### Setting up your `go` environment
|
|
||||||
|
|
||||||
- You need `go` v1.5
|
|
||||||
- You need to set `export GO15VENDOREXPERIMENT=1` environment variable
|
|
||||||
- You need `go-bindata` to be able to use `go generate` command (needed to build) : `go get github.com/jteeuwen/go-bindata/...`.
|
|
||||||
- If you clone Træfɪk into something like `~/go/src/github.com/traefik`, your `GOPATH` variable will have to be set to `~/go`: export `GOPATH=~/go`.
|
|
||||||
|
|
||||||
#### Using `Docker` and `Makefile`
|
[![Asteris](docs/img/asteris.logo.png)](https://aster.is)
|
||||||
|
|
||||||
You need to run the `binary` target. This will create binaries for Linux platform in the `dist` folder.
|
Founded in 2014, Asteris creates next-generation infrastructure software for the modern datacenter. Asteris writes software that makes it easy for companies to implement continuous delivery and realtime data pipelines. We support the HashiCorp stack, along with Kubernetes, Apache Mesos, Spark and Kafka. We're core committers on mantl.io, consul-cli and mesos-consul.
|
||||||
|
|
||||||
```bash
|
|
||||||
$ make binary
|
|
||||||
docker build -t "traefik-dev:no-more-godep-ever" -f build.Dockerfile .
|
|
||||||
Sending build context to Docker daemon 295.3 MB
|
|
||||||
Step 0 : FROM golang:1.5
|
|
||||||
---> 8c6473912976
|
|
||||||
Step 1 : RUN go get github.com/Masterminds/glide
|
|
||||||
[...]
|
|
||||||
docker run --rm -v "/var/run/docker.sock:/var/run/docker.sock" -it -e OS_ARCH_ARG -e OS_PLATFORM_ARG -e TESTFLAGS -v "/home/emile/dev/go/src/github.com/emilevauge/traefik/"dist":/go/src/github.com/emilevauge/traefik/"dist"" "traefik-dev:no-more-godep-ever" ./script/make.sh generate binary
|
|
||||||
---> Making bundle: generate (in .)
|
|
||||||
removed 'gen.go'
|
|
||||||
|
|
||||||
---> Making bundle: binary (in .)
|
|
||||||
|
|
||||||
$ ls dist/
|
|
||||||
traefik*
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Using `glide`
|
|
||||||
|
|
||||||
The idea behind `glide` is the following :
|
|
||||||
|
|
||||||
- when checkout(ing) a project, **run `glide up --quick`** to install
|
|
||||||
(`go get …`) the dependencies in the `GOPATH`.
|
|
||||||
- if you need another dependency, import and use it in
|
|
||||||
the source, and **run `glide get github.com/Masterminds/cookoo`** to save it in
|
|
||||||
`vendor` and add it to your `glide.yaml`.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ glide up --quick
|
|
||||||
# generate
|
|
||||||
$ go generate
|
|
||||||
# Simple go build
|
|
||||||
$ go build
|
|
||||||
# Using gox to build multiple platform
|
|
||||||
$ gox "linux darwin" "386 amd64 arm" \
|
|
||||||
-output="dist/traefik_{{.OS}}-{{.Arch}}"
|
|
||||||
# run other commands like tests
|
|
||||||
$ go test ./...
|
|
||||||
ok _/home/vincent/src/github/vdemeester/traefik 0.004s
|
|
||||||
```
|
|
||||||
|
|
||||||
### Tests
|
|
||||||
|
|
||||||
You can run unit tests using the `test-unit` target and the
|
|
||||||
integration test using the `test-integration` target.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
$ make test-unit
|
|
||||||
docker build -t "traefik-dev:your-feature-branch" -f build.Dockerfile .
|
|
||||||
# […]
|
|
||||||
docker run --rm -it -e OS_ARCH_ARG -e OS_PLATFORM_ARG -e TESTFLAGS -v "/home/vincent/src/github/vdemeester/traefik/dist:/go/src/github.com/emilevauge/traefik/dist" "traefik-dev:your-feature-branch" ./script/make.sh generate test-unit
|
|
||||||
---> Making bundle: generate (in .)
|
|
||||||
removed 'gen.go'
|
|
||||||
|
|
||||||
---> Making bundle: test-unit (in .)
|
|
||||||
+ go test -cover -coverprofile=cover.out .
|
|
||||||
ok github.com/emilevauge/traefik 0.005s coverage: 4.1% of statements
|
|
||||||
|
|
||||||
Test success
|
|
||||||
```
|
|
||||||
|
|
BIN
docs/img/asteris.logo.png
Normal file
BIN
docs/img/asteris.logo.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 10 KiB |
BIN
docs/img/zenika.logo.png
Normal file
BIN
docs/img/zenika.logo.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 9 KiB |
Loading…
Reference in a new issue