Add title and description metadata to documentation pages
This commit is contained in:
parent
ffdd693ff6
commit
7c4bf602f0
116 changed files with 573 additions and 2 deletions
|
@ -4,6 +4,7 @@
|
|||
"MD009": false,
|
||||
"MD013": false,
|
||||
"MD024": false,
|
||||
"MD025": false,
|
||||
"MD026": false,
|
||||
"MD033": false,
|
||||
"MD034": false,
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Advocation Documentation"
|
||||
description: "There are many ways to contribute to Traefik Proxy. If you're talking about Traefik, let us know and we'll promote your enthusiasm!"
|
||||
---
|
||||
|
||||
# Advocating
|
||||
|
||||
Spread the Love & Tell Us about It
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Building & Testing Documentation"
|
||||
description: "Compile and test your own Traefik Proxy! Learn how to build your own Traefik binary from the sources, and read the technical documentation."
|
||||
---
|
||||
|
||||
# Building and Testing
|
||||
|
||||
Compile and Test Your Own Traefik!
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Data Collection Documentation"
|
||||
description: "To learn more about how Traefik is being used and improve it, we collect anonymous usage statistics from running instances. Read the technical documentation."
|
||||
---
|
||||
|
||||
# Data Collection
|
||||
|
||||
Understanding How Traefik is Being Used
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Contribution Documentation"
|
||||
description: "Found something unclear in the Traefik Proxy documentation and want to give a try at explaining it better? Read the guide to building documentation."
|
||||
---
|
||||
|
||||
# Documentation
|
||||
|
||||
Features Are Better When You Know How to Use Them
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Maintainer's Guidelines Documentation"
|
||||
description: "Interested in contributing more to the community and becoming a Traefik Proxy maintainer? Read the guide to becoming a part of the core team."
|
||||
---
|
||||
|
||||
# Maintainer's Guidelines
|
||||
|
||||
![Maintainer's Guidelines](../assets/img/maintainers-guidelines.png)
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Maintainers Documentation"
|
||||
description: "Traefik Proxy is an open source software with a thriving community of contributors and maintainers. Read the list of maintainers on this page."
|
||||
---
|
||||
|
||||
# Maintainers
|
||||
|
||||
## The Team
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Submitting Issues Documentation"
|
||||
description: "Help us help you! Learn how to submit an issue, following the guidelines, so the Traefik Proxy team can help. Read the technical documentation."
|
||||
---
|
||||
|
||||
# Submitting Issues
|
||||
|
||||
Help Us Help You!
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Pull Requests Documentation"
|
||||
description: "Looking to contribute to Traefik Proxy? This guide will show you the guidelines for submitting a PR in our contributors guide repository."
|
||||
---
|
||||
|
||||
# Submitting Pull Requests
|
||||
|
||||
A Quick Guide for Efficient Contributions
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Security Documentation"
|
||||
description: "Security is a key part of Traefik Proxy. Read the technical documentation to learn about security advisories, CVE, and how to report a vulnerability."
|
||||
---
|
||||
|
||||
# Security
|
||||
|
||||
## Security Advisories
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Contribution Documentation"
|
||||
description: "Thank you to all those who have contributed! Traefik Proxy is an open-source project that thrives with the support of our passionate community."
|
||||
---
|
||||
|
||||
# Thank You!
|
||||
|
||||
_You_ Made It
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Concepts Documentation"
|
||||
description: "Get started with Traefik Proxy. Read the technical documentation for an introduction into the key concepts behind our open source edge router."
|
||||
---
|
||||
|
||||
# Concepts
|
||||
|
||||
Everything You Need to Know
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Configuration Documentation"
|
||||
description: "Get started with Traefik Proxy. This page will introduce you to the dynamic routing and startup configurations. Read the technical documentation."
|
||||
---
|
||||
|
||||
# Configuration Introduction
|
||||
|
||||
How the Magic Happens
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Getting Started FAQ"
|
||||
description: "Check out our FAQ page for answers to commonly asked questions on getting started with Traefik Proxy. Read the technical documentation."
|
||||
---
|
||||
|
||||
# FAQ
|
||||
|
||||
## Why is Traefik Answering `XXX` HTTP Response Status Code?
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Installation Documentation"
|
||||
description: "There are several flavors to choose from when installing Traefik Proxy. Get started with Traefik Proxy, and read the technical documentation."
|
||||
---
|
||||
|
||||
# Install Traefik
|
||||
|
||||
You can install Traefik with the following flavors:
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Getting Started Quickly"
|
||||
description: "Looking to get started with Traefik Proxy quickly? Read the technical documentation to learn a simple use case that leverages Docker."
|
||||
---
|
||||
|
||||
# Quick Start
|
||||
|
||||
A Simple Use Case Using Docker
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Let's Encrypt Documentation"
|
||||
description: "Learn how to configure Traefik Proxy to use an ACME provider like Let's Encrypt for automatic certificate generation. Read the technical documentation."
|
||||
---
|
||||
|
||||
# Let's Encrypt
|
||||
|
||||
Automatic HTTPS
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Proxy HTTPS & TLS Overview |Traefik Docs"
|
||||
description: "Traefik supports HTTPS & TLS, which concerns roughly two parts of the configuration: routers, and the TLS connection. Read the documentation to learn more."
|
||||
---
|
||||
|
||||
# HTTPS & TLS
|
||||
|
||||
Overview
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik TLS Documentation"
|
||||
description: "Learn how to configure the transport layer security (TLS) connection in Traefik Proxy. Read the technical documentation."
|
||||
---
|
||||
|
||||
# TLS
|
||||
|
||||
Transport Layer Security
|
||||
|
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
title: "Traefik Proxy Documentation"
|
||||
description: "Traefik Proxy, an open source Edge Router, auto-discovers configurations and supports major orchestrators, like Kubernetes. Read the technical documentation."
|
||||
---
|
||||
|
||||
# Welcome
|
||||
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik AddPrefix Documentation"
|
||||
description: "Learn how to implement the HTTP AddPrefix middleware in Traefik Proxy to updates request paths before being forwarded. Read the technical documentation."
|
||||
---
|
||||
|
||||
# Add Prefix
|
||||
|
||||
Prefixing the Path
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik BasicAuth Documentation"
|
||||
description: "The HTTP basic authentication (BasicAuth) middleware in Traefik Proxy restricts access to your Services to known users. Read the technical documentation."
|
||||
---
|
||||
|
||||
# BasicAuth
|
||||
|
||||
Adding Basic Authentication
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Buffering Documentation"
|
||||
description: "The HTTP buffering middleware in Traefik Proxy limits the size of requests that can be forwarded to Services. Read the technical documentation."
|
||||
---
|
||||
|
||||
# Buffering
|
||||
|
||||
How to Read the Request before Forwarding It
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Command Line Documentation"
|
||||
description: "The HTTP chain middleware lets you define reusable combinations of other middleware, to reuse the same groups. Read the technical documentation."
|
||||
---
|
||||
|
||||
# Chain
|
||||
|
||||
When One Isn't Enough
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik CircuitBreaker Documentation"
|
||||
description: "The HTTP circuit breaker in Traefik Proxy prevents stacking requests to unhealthy Services, resulting in cascading failures. Read the technical documentation."
|
||||
---
|
||||
|
||||
# CircuitBreaker
|
||||
|
||||
Don't Waste Time Calling Unhealthy Services
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Compress Documentation"
|
||||
description: "Traefik Proxy's HTTP middleware lets you compress responses before sending them to the client. Read the technical documentation."
|
||||
---
|
||||
|
||||
# Compress
|
||||
|
||||
Compress Responses before Sending them to the Client
|
||||
|
@ -173,4 +178,4 @@ http:
|
|||
[http.middlewares]
|
||||
[http.middlewares.test-compress.compress]
|
||||
minResponseBodyBytes = 1200
|
||||
```
|
||||
```
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik ContentType Documentation"
|
||||
description: "Traefik Proxy's HTTP middleware can automatically specify the content-type header if it has not been defined by the backend. Read the technical documentation."
|
||||
---
|
||||
|
||||
# ContentType
|
||||
|
||||
Handling Content-Type auto-detection
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik DigestAuth Documentation"
|
||||
description: "Traefik Proxy's HTTP DigestAuth middleware restricts access to your services to known users. Read the technical documentation."
|
||||
---
|
||||
|
||||
# DigestAuth
|
||||
|
||||
Adding Digest Authentication
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik ErrorPage Documentation"
|
||||
description: "In Traefik Proxy, the ErrorPage middleware returns custom pages according to configured ranges of HTTP Status codes. Read the technical documentation."
|
||||
---
|
||||
|
||||
# ErrorPage
|
||||
|
||||
It Has Never Been Easier to Say That Something Went Wrong
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik ForwardAuth Documentation"
|
||||
description: "In Traefik Proxy, the HTTP ForwardAuth middleware delegates authentication to an external Service. Read the technical documentation."
|
||||
---
|
||||
|
||||
# ForwardAuth
|
||||
|
||||
Using an External Service to Forward Authentication
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Headers Documentation"
|
||||
description: "In Traefik Proxy, the HTTP headers middleware manages the headers of requests and responses. Read the technical documentation."
|
||||
---
|
||||
|
||||
# Headers
|
||||
|
||||
Managing Request/Response headers
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik InFlightReq Documentation"
|
||||
description: "Traefik Proxy's HTTP middleware lets you limit the number of simultaneous in-flight requests. Read the technical documentation."
|
||||
---
|
||||
|
||||
# InFlightReq
|
||||
|
||||
Limiting the Number of Simultaneous In-Flight Requests
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik HTTP Middlewares IPWhiteList"
|
||||
description: "Learn how to use IPWhiteList in HTTP middleware for limiting clients to specific IPs in Traefik Proxy. Read the technical documentation."
|
||||
---
|
||||
|
||||
# IPWhiteList
|
||||
|
||||
Limiting Clients to Specific IPs
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Proxy HTTP Middleware Overview"
|
||||
description: "Read the official Traefik Proxy documentation for an overview of the available HTTP middleware."
|
||||
---
|
||||
|
||||
# HTTP Middlewares
|
||||
|
||||
Controlling connections
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik PassTLSClientCert Documentation"
|
||||
description: "In Traefik Proxy's HTTP middleware, the PassTLSClientCert adds selected data from passed client TLS certificates to headers. Read the technical documentation."
|
||||
---
|
||||
|
||||
# PassTLSClientCert
|
||||
|
||||
Adding Client Certificates in a Header
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik RateLimit Documentation"
|
||||
description: "Traefik Proxy's HTTP RateLimit middleware ensures Services receive fair amounts of requests. Read the technical documentation."
|
||||
---
|
||||
|
||||
# RateLimit
|
||||
|
||||
To Control the Number of Requests Going to a Service
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik RedirectRegex Documentation"
|
||||
description: "In Traefik Proxy's HTTP middleware, RedirectRegex redirecting clients to different locations. Read the technical documentation."
|
||||
---
|
||||
|
||||
# RedirectRegex
|
||||
|
||||
Redirecting the Client to a Different Location
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik RedirectScheme Documentation"
|
||||
description: "In Traefik Proxy's HTTP middleware, RedirectScheme redirects clients to different schemes/ports. Read the technical documentation."
|
||||
---
|
||||
|
||||
# RedirectScheme
|
||||
|
||||
Redirecting the Client to a Different Scheme/Port
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik ReplacePath Documentation"
|
||||
description: "In Traefik Proxy's HTTP middleware, ReplacePath updates paths before forwarding requests. Read the technical documentation."
|
||||
---
|
||||
|
||||
# ReplacePath
|
||||
|
||||
Updating the Path Before Forwarding the Request
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik ReplacePathRegex Documentation"
|
||||
description: "In Traefik Proxy's HTTP middleware, ReplacePathRegex updates paths before forwarding requests, using a regex. Read the technical documentation."
|
||||
---
|
||||
|
||||
# ReplacePathRegex
|
||||
|
||||
Updating the Path Before Forwarding the Request (Using a Regex)
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik HTTP Retry Documentation"
|
||||
description: "Configure Traefik Proxy's HTTP Retry middleware, so you can retry requests to a backend server until it succeeds. Read the technical documentation."
|
||||
---
|
||||
|
||||
# Retry
|
||||
|
||||
Retrying until it Succeeds
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik StripPrefix Documentation"
|
||||
description: "In Traefik Proxy's HTTP middleware, StripPrefix removes prefixes from paths before forwarding requests. Read the technical documentation."
|
||||
---
|
||||
|
||||
# StripPrefix
|
||||
|
||||
Removing Prefixes From the Path Before Forwarding the Request
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik StripPrefixRegex Documentation"
|
||||
description: "In Traefik Proxy's HTTP middleware, StripPrefixRegex removes prefixes from paths before forwarding requests, using regex. Read the technical documentation."
|
||||
---
|
||||
|
||||
# StripPrefixRegex
|
||||
|
||||
Removing Prefixes From the Path Before Forwarding the Request (Using a Regex)
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Proxy Middleware Overview"
|
||||
description: "There are several available middleware in Traefik Proxy used to modify requests or headers, take charge of redirections, add authentication, and so on."
|
||||
---
|
||||
|
||||
# Middlewares
|
||||
|
||||
Tweaking the Request
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik TCP Middlewares IPWhiteList"
|
||||
description: "Learn how to use IPWhiteList in TCP middleware for limiting clients to specific IPs in Traefik Proxy. Read the technical documentation."
|
||||
---
|
||||
|
||||
# IPWhiteList
|
||||
|
||||
Limiting Clients to Specific IPs
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Proxy TCP Middleware Overview"
|
||||
description: "Read the official Traefik Proxy documentation for an overview of the available TCP middleware."
|
||||
---
|
||||
|
||||
# TCP Middlewares
|
||||
|
||||
Controlling connections
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik V2 Migration Documentation"
|
||||
description: "Migrate from Traefik Proxy v1 to v2 and update all the necessary configurations to take advantage of all the improvements. Read the technical documentation."
|
||||
---
|
||||
|
||||
# Migration Guide: From v1 to v2
|
||||
|
||||
How to Migrate from Traefik v1 to Traefik v2.
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Migration Documentation"
|
||||
description: "Learn the steps needed to migrate to new Traefik Proxy v2 versions, i.e. v2.0 to v2.1 or v2.1 to v2.2. Read the technical documentation."
|
||||
---
|
||||
|
||||
# Migration: Steps needed between the versions
|
||||
|
||||
## v2.0 to v2.1
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Access Logs Documentation"
|
||||
description: "Access logs are a key part of observability in Traefik Proxy. Read the technical documentation to learn their configurations, rotations, and time zones."
|
||||
---
|
||||
|
||||
# Access Logs
|
||||
|
||||
Who Calls Whom?
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Logs Documentation"
|
||||
description: "Logs are a key part of observability in Traefik Proxy. Read the technical documentation to learn their configurations, rotations, and time zones."
|
||||
---
|
||||
|
||||
# Logs
|
||||
|
||||
Reading What's Happening
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Datadog Metrics Documentation"
|
||||
description: "Traefik Proxy supports Datadog for backend metrics. Read the technical documentation to enable Datadog for observability."
|
||||
---
|
||||
|
||||
# Datadog
|
||||
|
||||
To enable the Datadog:
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik InfluxDB Documentation"
|
||||
description: "Traefik supports several metrics backends, including InfluxDB. Learn how to implement it for observability in Traefik Proxy. Read the technical documentation."
|
||||
---
|
||||
|
||||
# InfluxDB
|
||||
|
||||
To enable the InfluxDB:
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Metrics Overview"
|
||||
description: "Traefik Proxy supports four metrics backend systems: Datadog, InfluxDB, Prometheus, and StatsD. Read the full documentation to get started."
|
||||
---
|
||||
|
||||
# Metrics
|
||||
|
||||
Traefik supports 4 metrics backends:
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Prometheus Documentation"
|
||||
description: "Traefik supports several metrics backends, including Prometheus. Learn how to implement it for observability in Traefik Proxy. Read the technical documentation."
|
||||
---
|
||||
|
||||
# Prometheus
|
||||
|
||||
To enable the Prometheus:
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik StatsD Documentation"
|
||||
description: "Traefik supports several metrics backends, including StatsD. Learn how to implement it for observability in Traefik Proxy. Read the technical documentation."
|
||||
---
|
||||
|
||||
# StatsD
|
||||
|
||||
To enable the Statsd:
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Datadog Tracing Documentation"
|
||||
description: "Traefik Proxy supports Datadog for tracing. Read the technical documentation to enable Datadog for observability."
|
||||
---
|
||||
|
||||
# Datadog
|
||||
|
||||
To enable the Datadog tracer:
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Elastic Documentation"
|
||||
description: "Traefik supports several tracing backends, including Elastic. Learn how to implement it for observability in Traefik Proxy. Read the technical documentation."
|
||||
---
|
||||
|
||||
# Elastic
|
||||
|
||||
To enable the Elastic tracer:
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Haystack Documentation"
|
||||
description: "Traefik supports several tracing backends, including Haystack. Learn how to implement it for observability in Traefik Proxy. Read the technical documentation."
|
||||
---
|
||||
|
||||
# Haystack
|
||||
|
||||
To enable the Haystack tracer:
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Instana Documentation"
|
||||
description: "Traefik supports several tracing backends, including Instana. Learn how to implement it for observability in Traefik Proxy. Read the technical documentation."
|
||||
---
|
||||
|
||||
# Instana
|
||||
|
||||
To enable the Instana tracer:
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Jaeger Documentation"
|
||||
description: "Traefik supports several tracing backends, including Jaeger. Learn how to implement it for observability in Traefik Proxy. Read the technical documentation."
|
||||
---
|
||||
|
||||
# Jaeger
|
||||
|
||||
To enable the Jaeger tracer:
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Tracing Overview"
|
||||
description: "The Traefik Proxy tracing system allows developers to visualize call flows in their infrastructure. Read the full documentation."
|
||||
---
|
||||
|
||||
# Tracing
|
||||
|
||||
Visualize the Requests Flow
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Zipkin Documentation"
|
||||
description: "Traefik supports several tracing backends, including Zipkin. Learn how to implement it for observability in Traefik Proxy. Read the technical documentation."
|
||||
---
|
||||
|
||||
# Zipkin
|
||||
|
||||
To enable the Zipkin tracer:
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik API Documentation"
|
||||
description: "Traefik Proxy exposes information through API handlers. Learn about the security, configuration, and endpoints of APIs. Read the technical documentation."
|
||||
---
|
||||
|
||||
# API
|
||||
|
||||
Traefik exposes a number of information through an API handler, such as the configuration of all routers, services, middlewares, etc.
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik CLI Documentation"
|
||||
description: "Learn the basics of the Traefik Proxy command line interface (CLI). Read the technical documentation."
|
||||
---
|
||||
|
||||
# CLI
|
||||
|
||||
The Traefik Command Line
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Dashboard Documentation"
|
||||
description: "The dashboard shows you the current active routes handled by Traefik Proxy in one central place. Read the technical documentation to learn its operations."
|
||||
---
|
||||
|
||||
# The Dashboard
|
||||
|
||||
See What's Going On
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Ping Documentation"
|
||||
description: "In Traefik Proxy, Ping lets you check the health of your Traefik instances. Read the technical documentation for configuration examples and options."
|
||||
---
|
||||
|
||||
# Ping
|
||||
|
||||
Checking the Health of Your Traefik Instances
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Plugins Documentation"
|
||||
description: "Learn how to connect Traefik Proxy with Pilot, a SaaS platform that offers features for metrics, alerts, and plugins. Read the technical documentation."
|
||||
---
|
||||
|
||||
# Plugins and Traefik Pilot
|
||||
|
||||
Traefik Pilot is a software-as-a-service (SaaS) platform that connects to Traefik to extend its capabilities.
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Consul Catalog Configuration Discovery"
|
||||
description: "Learn how to use Consul Catalog as a provider for configuration discovery in Traefik Proxy. Read the technical documentation."
|
||||
---
|
||||
|
||||
# Traefik & Consul Catalog
|
||||
|
||||
A Story of Tags, Services & Instances
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Consul Documentation"
|
||||
description: "Use Consul as a provider for configuration discovery in Traefik Proxy. Automate and store your configurations with Consul. Read the technical documentation."
|
||||
---
|
||||
|
||||
# Traefik & Consul
|
||||
|
||||
A Story of KV store & Containers
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Docker Documentation"
|
||||
description: "Learn how to achieve configuration discovery in Traefik through Docker. Read the technical documentation."
|
||||
---
|
||||
|
||||
# Traefik & Docker
|
||||
|
||||
A Story of Labels & Containers
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik AWS ECS Documentation"
|
||||
description: "Configuration discovery in Traefik is achieved through Providers. Read the technical documentation for leveraging AWS ECS in Traefik."
|
||||
---
|
||||
|
||||
# Traefik & AWS ECS
|
||||
|
||||
A Story of Labels & Elastic Containers
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Etcd Documentation"
|
||||
description: "Use Etcd as a provider for configuration discovery in Traefik Proxy. Automate and store your configurations with Etcd. Read the technical documentation."
|
||||
---
|
||||
|
||||
# Traefik & Etcd
|
||||
|
||||
A Story of KV store & Containers
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik File Documentation"
|
||||
description: "The file provider in Traefik Proxy lets you define the dynamic configuration in a YAML or TOML file. Read the technical documentation."
|
||||
---
|
||||
|
||||
# Traefik & File
|
||||
|
||||
Good Old Configuration File
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik HTTP Documentation"
|
||||
description: "Provide your dynamic configuration via an HTTP(S) endpoint and let Traefik Proxy do the rest. Read the technical documentation."
|
||||
---
|
||||
|
||||
# Traefik & HTTP
|
||||
|
||||
Provide your [dynamic configuration](./overview.md) via an HTTP(S) endpoint and let Traefik do the rest!
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Kubernetes IngressRoute & Traefik CRD"
|
||||
description: "The Traefik team developed a Custom Resource Definition (CRD) for an IngressRoute type, to provide a better way to configure access to a Kubernetes cluster."
|
||||
---
|
||||
|
||||
# Traefik & Kubernetes
|
||||
|
||||
The Kubernetes Ingress Controller, The Custom Resource Way.
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Kubernetes Gateway API Documentation"
|
||||
description: "Learn how to use the Kubernetes Gateway API as a provider for configuration discovery in Traefik Proxy. Read the technical documentation."
|
||||
---
|
||||
|
||||
# Traefik & Kubernetes with Gateway API
|
||||
|
||||
The Kubernetes Gateway API, The Experimental Way.
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Kubernetes Ingress Documentation"
|
||||
description: "Understand the requirements, routing configuration, and how to set up Traefik Proxy as your Kubernetes Ingress Controller. Read the technical documentation."
|
||||
---
|
||||
|
||||
# Traefik & Kubernetes
|
||||
|
||||
The Kubernetes Ingress Controller.
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Configuration for Marathon"
|
||||
description: "Traefik Proxy can be configured to use Marathon as a provider. Read the technical documentation to learn how."
|
||||
---
|
||||
|
||||
# Traefik & Marathon
|
||||
|
||||
Traefik can be configured to use Marathon as a provider.
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Configuration Discovery Overview"
|
||||
description: "Configuration discovery in Traefik is achieved through Providers. The providers are infrastructure components. Read the documentation to learn more."
|
||||
---
|
||||
|
||||
# Overview
|
||||
|
||||
Traefik's Many Friends
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: ""Traefik Configuration Discovery: Rancher""
|
||||
description: "Read the official Traefik documentation to learn how to expose Rancher services by default in Traefik Proxy."
|
||||
---
|
||||
|
||||
# Traefik & Rancher
|
||||
|
||||
A Story of Labels, Services & Containers
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Redis Documentation"
|
||||
description: "For configuration discovery in Traefik Proxy, you can store your configurations in Redis. Read the technical documentation."
|
||||
---
|
||||
|
||||
# Traefik & Redis
|
||||
|
||||
A Story of KV store & Containers
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik ZooKeeper Documentation"
|
||||
description: "For configuration discovery in Traefik Proxy, you can store your configurations in ZooKeeper. Read the technical documentation."
|
||||
---
|
||||
|
||||
# Traefik & ZooKeeper
|
||||
|
||||
A Story of KV Store & Containers
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Consul Configuration Documentation"
|
||||
description: "View the reference for performing dynamic configurations with Traefik Proxy and Consul Catalog. Read the technical documentation."
|
||||
---
|
||||
|
||||
# Consul Catalog Configuration Reference
|
||||
|
||||
Dynamic configuration with Consul Catalog
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Docker Configuration Documentation"
|
||||
description: "Reference dynamic configuration with Docker labels in Traefik Proxy. Read the technical documentation."
|
||||
---
|
||||
|
||||
# Docker Configuration Reference
|
||||
|
||||
Dynamic configuration with Docker Labels
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik AWS ECS Configuration Documentation"
|
||||
description: "Learn how to do dynamic configuration in Traefik Proxy with AWS ECS. Read the technical documentation."
|
||||
---
|
||||
|
||||
# ECS Configuration Reference
|
||||
|
||||
Dynamic configuration with ECS provider
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik File Dynamic Configuration"
|
||||
description: "This guide will provide you with the YAML and TOML files for dynamic configuration in Traefik Proxy. Read the technical documentation."
|
||||
---
|
||||
|
||||
# File Configuration Reference
|
||||
|
||||
Dynamic configuration with files
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Kubernetes CRD Documentation"
|
||||
description: "Learn about the definitions, resources, and RBAC of dynamic configuration with Kubernetes CRD in Traefik Proxy. Read the technical documentation."
|
||||
---
|
||||
|
||||
# Kubernetes Configuration Reference
|
||||
|
||||
Dynamic configuration with Kubernetes Custom Resource
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Kubernetes Routing"
|
||||
description: "Reference the dynamic configuration with the Kubernetes Gateway provider in Traefik Proxy. Read the technical documentation."
|
||||
---
|
||||
|
||||
# Kubernetes Configuration Reference
|
||||
|
||||
Dynamic configuration with Kubernetes Gateway provider.
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Dynamic Configuration with KV stores"
|
||||
description: "Read the technical documentation to learn the Traefik Dynamic Configuration with KV stores."
|
||||
---
|
||||
|
||||
# KV Configuration Reference
|
||||
|
||||
Dynamic configuration with KV stores.
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Dynamic Configuration with Marathon Labels"
|
||||
description: "Traefik Proxy can be configured to use Marathon as a provider. Read the technical documentation on the Traefik dynamic configuration with Marathon Labels."
|
||||
---
|
||||
|
||||
# Marathon Configuration Reference
|
||||
|
||||
Dynamic configuration with Marathon Labels
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Dynamic Configuration with Rancher"
|
||||
description: "Read the official Traefik documentation to learn more on dynamic configuration in Traefik Proxy with Rancher Labels."
|
||||
---
|
||||
|
||||
# Rancher Configuration Reference
|
||||
|
||||
Dynamic configuration with Rancher Labels
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik CLI Flags Documentation"
|
||||
description: "Reference the CLI flags for static configuration in Traefik Proxy. Read the technical documentation."
|
||||
---
|
||||
|
||||
# Static Configuration: CLI
|
||||
|
||||
--8<-- "content/reference/static-configuration/cli-ref.md"
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Environment Variables Documentation"
|
||||
description: "Reference the environment variables for static configuration in Traefik Proxy. Read the technical documentation."
|
||||
---
|
||||
|
||||
# Static Configuration: Environment variables
|
||||
|
||||
--8<-- "content/reference/static-configuration/env-ref.md"
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik File Static Configuration"
|
||||
description: "Reference the YAML and TOML files for static configuration in Traefik Proxy. Read the technical documentation."
|
||||
---
|
||||
|
||||
# Static Configuration: File
|
||||
|
||||
```yml tab="YAML"
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Static Configuration Overview"
|
||||
description: "Read the official Traefik documentation to get started with static configuration in Traefik Proxy."
|
||||
---
|
||||
|
||||
# Static Configuration
|
||||
|
||||
- [File](./file.md)
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik EntryPoints Documentation"
|
||||
description: "For routing and load balancing in Traefik Proxy, EntryPoints define which port will receive packets and whether in UDP or TCP. Read the technical documentation."
|
||||
---
|
||||
|
||||
# EntryPoints
|
||||
|
||||
Opening Connections for Incoming Requests
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Routing & Load Balancing Overview |Traefik Docs"
|
||||
description: "Read the official Traefik documentation to learn more on the Traefik Proxy architecture and the components that enable the routes to be created."
|
||||
---
|
||||
|
||||
# Overview
|
||||
|
||||
What's Happening to the Requests?
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Consul Catalog Routing"
|
||||
description: "Learn how to use Consul Catalog as a provider for routing configurations in Traefik Proxy. Read the technical documentation."
|
||||
---
|
||||
|
||||
# Traefik & Consul Catalog
|
||||
|
||||
A Story of Tags, Services & Instances
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik Docker Routing Documentation"
|
||||
description: "This guide will teach you how to attach labels to your containers, to route traffic and load balance with Traefik and Docker."
|
||||
---
|
||||
|
||||
# Traefik & Docker
|
||||
|
||||
A Story of Labels & Containers
|
||||
|
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: "Traefik ECS Documentation"
|
||||
description: "AWS ECS is a provider for routing and load balancing in Traefik Proxy. Read the technical documentation to get started."
|
||||
---
|
||||
|
||||
# Traefik & ECS
|
||||
|
||||
A Story of Labels & Elastic Containers
|
||||
|
|
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue