GLYCAM Traefik V3 Proxy

This is the git repository for the GLYCAM Traefik V3 Reverse Proxy.

Quick Start

git clone https://github.com/GLYCAM-Web/GLYCAM_Traefik_V3_Proxy.git

cd GLYCAM_Traefik_V3_Proxy

echo "export LE_EMAIL='insert-your@email.address'" > config.bash

## Optionally, if you want to do a dry run:
export TEST="YES"

bash start.sh

Files and Directories List

Contained herein

• docker-compose.traefik.swarm.yml

  YAML compose file used by Docker to deploy the Traefik Reverse Proxy in Swarm.

• .gitignore

  List of file/directory patterns for git to ignore.

• LICENSE

  The license for the repo.

• README.md

  This file.

• start.sh*

• stop.sh

  Start or stop the service.

• test-whoami.sh

  A mechanism for testing the traefik installation. Note: we have made no attempt for it to work except as a local curl/wget.

• Examples/

  These files are described in the README.md file in this directory.

  • docker-compose.proxy.swarm.base.port.yml

  • docker-compose.proxy.swarm.traefik.https.yml

  • docker-compose.proxy.swarm.traefik.ratelimits.yml

  • README.md

You must create

• config.bash

  Contains information needed at startup.

Created at startup, if not already present

• acme/

  Contains encryption info. This directory is made by the start.sh script.

  • acme.json

  The file that stores the encryption data for serving https. This file must be generated by Traefik. Getting it started can be a challenge. Please see the documentation for Traefik and Lets Encrypt for clarity.

  If it is not present at startup, the script will issue a warning and wait for your response. It's really important.

• logs/

  Logs from Traefik. Log rotation is enabled. This directory is created by start.sh.

  • traefik.log

    The current traefik log. Others should be time-stamped and compressed (gzip). Traefik will generate and maintain this file.

  • ./logs/start_STDOUT_${DATE}.log ./logs/start_STDERR_${DATE}.log ./logs/stop_STDOUT_${DATE}.log ./logs/stop_STDERR_${DATE}.log

    Logs written by this script upon startup or shutdown.

• ACCESS_LOGS/

  Logs of accesses from outside the swarm. Includes the name of the host requested. Log rotation needs to be configured separately. This directory is created by start.sh.

  • access.log

    The current access.log. The logs are verbose and can become large quickly. For production, implement log rotation or, better, deploy a cloud-based logs management system. This log is created and maintained by Traefik.

History and Inspirations

This repo is an evolution from a repo for Traefik V2:

[https://github.com/GLYCAM-Web/GLYCAM_Traefik_Proxy]

That repo was inspired by the resources below.

BashfulBandit's Docker-Traefic repo: [https://github.com/BashfulBandit/docker-traefik]

A useful post in the Conainous community forums: [https://community.containo.us/t/swarm-mode-giving-404/2746/2]