Skip to content

Commit 63683d3

Browse files
authored
doc: add YAML sample.
1 parent 4953445 commit 63683d3

File tree

2 files changed

+155
-1
lines changed

2 files changed

+155
-1
lines changed

docs/content/getting-started/install-traefik.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,10 @@ You can install Traefik with the following flavors:
99

1010
## Use the Official Docker Image
1111

12-
Choose one of the [official Docker images](https://hub.docker.com/_/traefik) and run it with the [sample configuration file](https://raw.githubusercontent.com/traefik/traefik/v2.3/traefik.sample.toml):
12+
Choose one of the [official Docker images](https://hub.docker.com/_/traefik) and run it with one sample configuration file:
13+
14+
* [TOML](https://raw.githubusercontent.com/traefik/traefik/v2.3/traefik.sample.toml)
15+
* [YAML](https://raw.githubusercontent.com/traefik/traefik/v2.3/traefik.sample.yml)
1316

1417
```bash
1518
docker run -d -p 8080:8080 -p 80:80 \

traefik.sample.yml

+151
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
################################################################
2+
#
3+
# Configuration sample for Traefik v2.
4+
#
5+
# For Traefik v1: https://github.com/traefik/traefik/blob/v1.7/traefik.sample.toml
6+
#
7+
################################################################
8+
9+
################################################################
10+
# Global configuration
11+
################################################################
12+
global:
13+
checkNewVersion: true
14+
sendAnonymousUsage: true
15+
16+
################################################################
17+
# EntryPoints configuration
18+
################################################################
19+
20+
# EntryPoints definition
21+
#
22+
# Optional
23+
#
24+
entryPoints:
25+
web:
26+
address: :80
27+
28+
websecure:
29+
address: :443
30+
31+
################################################################
32+
# Traefik logs configuration
33+
################################################################
34+
35+
# Traefik logs
36+
# Enabled by default and log to stdout
37+
#
38+
# Optional
39+
#
40+
#log:
41+
# Log level
42+
#
43+
# Optional
44+
# Default: "ERROR"
45+
#
46+
# level: DEBUG
47+
48+
# Sets the filepath for the traefik log. If not specified, stdout will be used.
49+
# Intermediate directories are created if necessary.
50+
#
51+
# Optional
52+
# Default: os.Stdout
53+
#
54+
# filePath: log/traefik.log
55+
56+
# Format is either "json" or "common".
57+
#
58+
# Optional
59+
# Default: "common"
60+
#
61+
# format: json
62+
63+
################################################################
64+
# Access logs configuration
65+
################################################################
66+
67+
# Enable access logs
68+
# By default it will write to stdout and produce logs in the textual
69+
# Common Log Format (CLF), extended with additional fields.
70+
#
71+
# Optional
72+
#
73+
#accessLog:
74+
# Sets the file path for the access log. If not specified, stdout will be used.
75+
# Intermediate directories are created if necessary.
76+
#
77+
# Optional
78+
# Default: os.Stdout
79+
#
80+
# filePath: /path/to/log/log.txt
81+
82+
# Format is either "json" or "common".
83+
#
84+
# Optional
85+
# Default: "common"
86+
#
87+
# format: json
88+
89+
################################################################
90+
# API and dashboard configuration
91+
################################################################
92+
93+
# Enable API and dashboard
94+
#
95+
# Optional
96+
#
97+
#api:
98+
# Enable the API in insecure mode
99+
#
100+
# Optional
101+
# Default: false
102+
#
103+
# insecure: true
104+
105+
# Enabled Dashboard
106+
#
107+
# Optional
108+
# Default: true
109+
#
110+
# dashboard: false
111+
112+
################################################################
113+
# Ping configuration
114+
################################################################
115+
116+
# Enable ping
117+
#ping:
118+
# Name of the related entry point
119+
#
120+
# Optional
121+
# Default: "traefik"
122+
#
123+
# entryPoint: traefik
124+
125+
################################################################
126+
# Docker configuration backend
127+
################################################################
128+
129+
#providers:
130+
# Enable Docker configuration backend
131+
# docker:
132+
# Docker server endpoint. Can be a tcp or a unix socket endpoint.
133+
#
134+
# Required
135+
# Default: "unix:///var/run/docker.sock"
136+
#
137+
# endpoint: tcp://10.10.10.10:2375
138+
139+
# Default host rule.
140+
#
141+
# Optional
142+
# Default: "Host(`{{ normalize .Name }}`)"
143+
#
144+
# defaultRule: Host(`{{ normalize .Name }}.docker.localhost`)
145+
146+
# Expose containers by default in traefik
147+
#
148+
# Optional
149+
# Default: true
150+
#
151+
# exposedByDefault: false

0 commit comments

Comments
 (0)