forked from ContainerSSH/containerssh.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
283 lines (283 loc) · 12.9 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
site_name: "ContainerSSH: Launch containers on demand"
site_description: "ContainerSSH is a standalone, customizable SSH server that launches containers in Kubernetes, Docker, Podman, and can proxy to external SSH servers."
site_url: "https://containerssh.io/"
repo_url: "https://github.com/containerssh/containerssh.github.io/"
edit_uri: "edit/main/docs/"
markdown_extensions:
- admonition
- attr_list
- def_list
- meta
- pymdownx.tabbed:
alternate_style: true
- pymdownx.superfences
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.tasklist:
custom_checkbox: true
- toc:
permalink: True
separator: "-"
theme:
name: material
custom_dir: .docs-theme
palette:
primary: blue
accent: blue
font: false
features:
- navigation.tabs
- navigation.sections
- toc.autohide
- search.suggest
- search.highlight
logo: images/logo.svg
favicon: images/logo.svg
language: en
include_search_page: false
search_index_only: 'false'
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/ContainerSSH
name: GitHub
- icon: fontawesome/brands/slack
link: https://join.slack.com/t/containerssh/shared_invite/zt-w2ulatkm-hjGHk8OaxQCBX79XKJHAQQ
name: Slack
- icon: fontawesome/brands/twitter
link: https://twitter.com/ContainerSSH
name: Twitter
- icon: fontawesome/brands/youtube
link: https://www.youtube.com/channel/UC0UNgOeDAGTONykuhza9sLA
name: YouTube
- icon: fontawesome/brands/docker
link: https://hub.docker.com/orgs/containerssh
name: Docker Hub
nav:
- Home: index.md
- Use cases:
- Lab: usecases/lab.md
- Debugging a production system: usecases/debugging.md
- Web hosting: usecases/webhosting.md
- Learning environments: usecases/learning.md
- Honeypots: usecases/honeypots.md
- Security: usecases/security.md
- Getting started:
- 'Quick Start': getting-started/index.md
- 'Architecture': getting-started/architecture.md
- 'Installation': getting-started/installation.md
- 'Configuration': getting-started/configuration.md
- 'Authentication Server': getting-started/authserver.md
- 'Container Backends':
- 'Selecting a Backend': getting-started/backends.md
- 'The Docker Backend': getting-started/docker.md
- 'The Kubernetes Backend': getting-started/kubernetes.md
- 'The SSH Proxy Backend': getting-started/sshproxy.md
- 'FAQ': getting-started/faq.md
- 'Getting Help': getting-started/getting-help.md
- Guides:
- Overview: guides/index.md
- Honeypot: guides/honeypot.md
- Logging to the ELK stack with Docker and Fluentd: guides/docker-elk/index.md
- Downloads: downloads/index.md
- Reference manual:
- 'Overview': reference/index.md
- 'Installation': reference/installation.md
- 'SSH':
- 'Configuration': reference/ssh.md
- 'Supported features': reference/features.md
- 'Backends':
- 'Backend selection': reference/backends.md
- 'Docker': reference/docker.md
- 'Kubernetes': reference/kubernetes.md
- 'SSH proxy': reference/sshproxy.md
- 'DockerRun (deprecated)': reference/dockerrun.md
- 'KubeRun (deprecated)': reference/kuberun.md
- Webhooks and APIs:
- 'Authentication': reference/auth.md
- 'Configuration server': reference/configserver.md
- 'API': reference/api/index.md
- Customization:
- 'Creating Guest Images': reference/image.md
- Monitoring:
- 'Logging': reference/logging.md
- 'Audit logging': reference/audit.md
- 'Metrics': reference/metrics.md
- Security:
- 'Restrictions': reference/security.md
- 'Hardening guide': reference/hardening.md
- Troubleshooting:
- Troubleshooting guide: reference/troubleshooting.md
- Message codes: reference/codes.md
- Upcoming and old releases:
- Upcoming:
- 'Overview': reference/upcoming/index.md
- 'Installation': reference/upcoming/installation.md
- 'SSH':
- 'Configuration': reference/upcoming/ssh.md
- 'Supported features': reference/upcoming/features.md
- 'Backends':
- 'Backend selection': reference/upcoming/backends.md
- 'Docker': reference/upcoming/docker.md
- 'Kubernetes': reference/upcoming/kubernetes.md
- 'SSH proxy': reference/upcoming/sshproxy.md
- Authentication:
- 'Overview': reference/upcoming/auth.md
- 'Webhook': reference/upcoming/auth-webhook.md
- 'oAuth2': reference/upcoming/auth-oauth2.md
- 'Kerberos': reference/upcoming/auth-kerberos.md
- Customization:
- 'Configuration server': reference/upcoming/configserver.md
- 'Creating Guest Images': reference/upcoming/image.md
- Monitoring:
- 'Logging': reference/upcoming/logging.md
- 'Audit logging': reference/upcoming/audit.md
- 'Health checks': reference/upcoming/health.md
- 'Metrics': reference/upcoming/metrics.md
- Security:
- 'Restrictions': reference/upcoming/security.md
- 'Hardening guide': reference/upcoming/hardening.md
- 'HTTP client and server': reference/upcoming/http.md
- Troubleshooting:
- Troubleshooting guide: reference/upcoming/troubleshooting.md
- Message codes: reference/upcoming/codes.md
- 0.4.0:
- 'Overview': reference/0.4.0/index.md
- 'Installation': reference/0.4.0/installation.md
- 'SSH':
- 'Configuration': reference/0.4.0/ssh.md
- 'Supported features': reference/0.4.0/features.md
- 'Backends':
- 'Backend selection': reference/0.4.0/backends.md
- 'Docker': reference/0.4.0/docker.md
- 'Kubernetes': reference/0.4.0/kubernetes.md
- 'SSH proxy': reference/0.4.0/sshproxy.md
- 'DockerRun (deprecated)': reference/0.4.0/dockerrun.md
- 'KubeRun (deprecated)': reference/0.4.0/kuberun.md
- Webhooks and APIs:
- 'Authentication': reference/0.4.0/auth.md
- 'Configuration server': reference/0.4.0/configserver.md
- 'API': reference/0.4.0/api/index.md
- Customization:
- 'Creating Guest Images': reference/0.4.0/image.md
- Monitoring:
- 'Logging': reference/0.4.0/logging.md
- 'Audit logging': reference/0.4.0/audit.md
- 'Metrics': reference/0.4.0/metrics.md
- Security:
- 'Restrictions': reference/0.4.0/security.md
- 'Hardening guide': reference/0.4.0/hardening.md
- Troubleshooting:
- Troubleshooting guide: reference/0.4.0/troubleshooting.md
- Message codes: reference/0.4.0/codes.md
- 0.3:
- 'Overview': reference/0.3/index.md
- Installation: reference/0.3/installation.md
- Backends:
- Backend selection: reference/0.3/backends.md
- DockerRun: reference/0.3/dockerrun.md
- KubeRun: reference/0.3/kuberun.md
- Webhooks and APIs:
- 'Authentication': reference/0.3/auth.md
- 'Configuration server': reference/0.3/configserver.md
- 'API': reference/0.3/api/index.md
- Monitoring:
- Logging: reference/0.3/logging.md
- Metrics: reference/0.3/metrics.md
- Security:
- Hardening guide: reference/0.3/hardening.md
- Customization:
- Creating a guest image: reference/0.3/image.md
- Development:
- Overview: development/index.md
- Getting Started: development/getting-started.md
- Dashboard: development/dashboard.md
- Coding Style: development/code-style.md
- Development Environment:
- Overview: development/devenv/index.md
- Installing GPG (optional): development/devenv/gpg.md
- Installing Golang: development/devenv/golang.md
- Installing the QA tools: development/devenv/qa.md
- Installing Docker: development/devenv/docker.md
- Installing Kubernetes: development/devenv/kubernetes.md
- Setting up your IDE: development/devenv/ide.md
- Setting up the website: development/devenv/website.md
- Understanding ContainerSSH:
- 'Overview': development/containerssh/index.md
- 'Understanding SSH': development/containerssh/ssh.md
- 'Writing your first SSH server': development/containerssh/first-ssh-server.md
- 'Internal Architecture': development/containerssh/internal-architecture.md
- Releases:
- Overview: development/releases/index.md
- Libraries: development/releases/libraries.md
- Binaries: development/releases/binaries.md
- External tools:
- Overview: development/tools/index.md
- GitHub: development/tools/github.md
- Terraform: development/tools/terraform.md
- Snyk: development/tools/snyk.md
- Docker: development/tools/docker.md
- Blog:
- "ContainerSSH 0.4.1: Bugfixing Audit & Proxy": blog/2021/05/26/containerssh-0-4-1.md
- "DevLog: SSH authentication via OAuth2": blog/2021/04/13/devlog-oauth2.md
- "ContainerSSH 0.4: Audit & Proxy": blog/2021/04/01/containerssh-0-4.md
- We messed up: blog/2021/03/19/we-messed-up.md
- Announcing the ContainerSSH Guest Agent: blog/2020/12/24/the-agent.md
- The Road to ContainerSSH 0.4: blog/2020/11/25/the-road-to-0-4.md
plugins:
- search
- macros
- blog:
format: ""
- redirects:
redirect_maps:
'security.md': 'about/security.md'
'ssh.md': 'development/containerssh/ssh.md'
'developing.md': 'development/index.md'
'contributing/index.md': 'development/index.md'
'contributing/internal-architecture.md': 'development/containerssh/internal-architecture.md'
'development/internal-architecture.md': 'development/containerssh/internal-architecture.md'
'contributing/libraries.md': 'development/dashboard.md'
'contributing/roadmap.md': 'development/dashboard.md'
'quickstart.md': 'getting-started/index.md'
'installation.md': 'getting-started/installation.md'
'authserver.md': 'getting-started/authserver.md'
'configuration.md': 'getting-started/configuration.md'
'configserver.md': 'reference/configserver.md'
'backends.md': 'getting-started/backends.md'
'dockerrun.md': 'reference/dockerrun.md'
'kuberun.md': 'reference/kuberun.md'
'faq.md': 'getting-started/faq.md'
'audit/index.md': 'reference/audit.md'
'audit/format.md': 'https://github.com/ContainerSSH/auditlog/blob/main/FORMAT.v1.md'
'license.md': 'about/license.md'
'imprint.md': 'about/imprint.md'
'privacy.md': 'about/privacy.md'
'advanced/audit/format.md': 'https://github.com/ContainerSSH/auditlog/blob/main/FORMAT.v1.md'
'advanced/index.md': 'reference/index.md'
'advanced/audit.md': 'reference/audit.md'
'advanced/hardening.md': 'reference/hardening.md'
'advanced/image.md': 'reference/image.md'
'advanced/logging.md': 'reference/logging.md'
'advanced/metrics.md': 'reference/metrics.md'
'getting-started/configserver.md': 'reference/configserver.md'
'getting-started/backends/dockerrun.md': 'getting-started/docker.md'
'getting-started/backends/kuberun.md': 'getting-started/kubernetes.md'
'metrics.md': 'reference/metrics.md'
extra_css:
- css/custom.css?v7
extra_javascript:
- https://cdnjs.cloudflare.com/ajax/libs/tablesort/5.2.1/tablesort.min.js
- javascript/tables.js
copyright: >
Copyright © ContainerSSH Contributors | Creative Commons Attribution 4.0 International License
| <a href="/about/">About Us</a>
| <a href="/about/packages/">Packages</a>
| <a href="/about/security/">Security</a>
| <a href="/deprecations/">Deprecations</a>
| <a href="/about/license/">License</a>
| <a href="https://github.com/ContainerSSH/branding/blob/main/README.md">Brand assets</a>
| <a href="/about/privacy/">Privacy Policy</a>
| <a href="/about/imprint/">Imprint</a><br />
<a href="https://www.linuxfoundation.org/trademark-usage/">Kubernetes and Linux are trademarks of The Linux Foundation.</a> <a href="https://www.docker.com/legal/trademark-guidelines">Docker and the Docker logo are trademarks of Docker, Inc.</a>