Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
- add badges
- remove `wildcard` branch reference
  • Loading branch information
abmruman authored Feb 13, 2020
1 parent f00cd1b commit 9c320be
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# Traefik v2.1 (docker-compose)

Run traefik:2.1 load balancer and reverse proxy server using docker-compose. Get SSL/TLS certificates automatically using traefik dynamic configurations. Automatically obtain wildcard/SANs certificates for your domain using traefik (lego) with DNS TXT record propagation (**branch [`wildcard`](https://github.com/abmruman/traefik-docker-compose/tree/wildcard)**)
[![Build Status](https://travis-ci.com/abmruman/traefik-docker-compose.svg?branch=master)](https://travis-ci.com/abmruman/traefik-docker-compose)
[![GitHub license](https://img.shields.io/github/license/abmruman/traefik-docker-compose)](https://github.com/abmruman/traefik-docker-compose/blob/master/LICENSE)
[![GitHub issues](https://img.shields.io/github/issues/abmruman/traefik-docker-compose)](https://github.com/abmruman/traefik-docker-compose/issues)

Run traefik:2.1 load balancer and reverse proxy server using docker-compose. Get SSL/TLS certificates automatically using traefik dynamic configurations. Automatically obtain wildcard/SANs certificates for your domain using traefik (lego) with DNS TXT record propagation

## Instructions

Expand Down Expand Up @@ -30,8 +34,6 @@ Run traefik:2.1 load balancer and reverse proxy server using docker-compose. Get

## Widcard/SANs certificate

### branch [`wildcard`](https://github.com/abmruman/traefik-docker-compose/tree/wildcard)

**To obtain wildcard/SANs certificate, you must have access to your provider's (i.e. digitalocean) dns records with `READ` & `WRITE` permission.**

**Note: Letsencrypt uses [rate limiting](https://letsencrypt.org/docs/rate-limits/), Certificates per Registered Domain (50 per week), to ensure fair usage. So, the `CA_SERVER` is set to `staging` server (gives you a fake certificate issued by `Fake LE Intermediate X1`) in the `env file` so that you dont burn out your limit testing initially. If you don't care about the limit or 50 per week is a lot for you, change it to actual server and roll with it. Otherwise, Change all the config in `.env` file, test using staging server. Then, change it to actual server (commented `CA_SERVER` in env file) when everything is functional.**
Expand Down Expand Up @@ -62,7 +64,7 @@ Follow the steps below:

12. Run `docker-compose up`

13. You will see `"legolog: [INFO] [exp.abmruman.xyz] Server responded with a certificate."` if successful
13. You will see `"legolog: [INFO] [domain.tld] Server responded with a certificate."` if successful

14. Browse to your dashboard to make sure if the certificates are working (maybe refresh the page few times with `ctrl + shift + r`)

Expand All @@ -84,15 +86,15 @@ Follow the steps below:

- To stop the service use `sudo systemctl stop traefik.service` or `sudo service traefik stop`

## Træfɪk
## What is Træfɪk?

![Træfɪk](https://docs.traefik.io/assets/img/traefik.logo.png)

[Træfɪk](https://github.com/containous/traefik) is a modern HTTP reverse proxy and load balancer that makes deploying microservices easy.
Træfik integrates with your existing infrastructure components ([Docker](https://www.docker.com/), [Swarm mode](https://docs.docker.com/engine/swarm/), [Kubernetes](https://kubernetes.io), [Marathon](https://mesosphere.github.io/marathon/), [Consul](https://www.consul.io/), [Etcd](https://coreos.com/etcd/), [Rancher](https://rancher.com), [Amazon ECS](https://aws.amazon.com/ecs), ...) and configures itself automatically and dynamically.
Telling Træfik where your orchestrator is could be the _only_ configuration step you need to do.

## Docker Compose
## What is Docker Compose?

![Docker Compose](https://raw.githubusercontent.com/docker/compose/master/logo.png "Docker Compose Logo")

Expand All @@ -111,6 +113,4 @@ CI workflows. You can learn more about each case in
Any contribution to this project is warmly welcomed. I did what I could to cover possible edge cases and make it so that you don't have to edit the compose file if you don't want to, but if you find any weakness or mistake, please let me know.

There are over 50 providers for dns-challenge, I only tested 2 of them.
If you happen to use one of the others, feel free to include them in the environment example file or compose file if needed. I will be happy to accept any PR.

Also, there are other aspects of traefik v2 that I couldn't or didn't include, It would be great if you could help me out :)
If you happen to use one of the others, feel free to include them in the environment example file ([env.example](/env.example)) or [compose file](/docker-compose.yml). I will be happy to recieve any PR :)

0 comments on commit 9c320be

Please sign in to comment.