-
Notifications
You must be signed in to change notification settings - Fork 18
/
Copy pathmkdocs.yml
228 lines (228 loc) · 10.3 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
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:material.extensions.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:
version:
provider: mike
social:
- icon: fontawesome/brands/github
link: https://github.com/ContainerSSH
name: GitHub
- icon: fontawesome/brands/slack
link: https://communityinviter.com/apps/cloud-native/cncf
name: CNCF Slack
- 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
- 'Connection Forwarding': reference/forwarding.md
- 'Backends':
- 'Backend Selection': reference/backends.md
- 'Docker': reference/docker.md
- 'Kubernetes': reference/kubernetes.md
- 'SSH proxy': reference/sshproxy.md
- Authentication:
- 'Authentication Overview': reference/auth.md
- 'Kerberos': reference/auth-kerberos.md
- 'Webhook': reference/auth-webhook.md
- 'OAuth2/OIDC & Github': reference/auth-oauth2.md
- Customization:
- 'Configuration Server': reference/configserver.md
- 'Creating Guest Images': reference/image.md
- 'API': reference/api/index.md
- Monitoring:
- 'Logging': reference/logging.md
- 'Audit Logging': reference/audit.md
- 'Metrics': reference/metrics.md
- 'Health Check': reference/health.md
- Security:
- 'Restrictions': reference/security.md
- 'HTTP Client and Server': reference/http.md
- 'Hardening Guide': reference/hardening.md
- Troubleshooting:
- Troubleshooting guide: reference/troubleshooting.md
- Message codes: reference/codes.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:
- blog/index.md
plugins:
- blog
- search
- macros
- 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'
# Redirect old upcoming section
'reference/upcoming/index.md': 'reference/index.md'
'reference/upcoming/installation.md': 'reference/installation.md'
'reference/upcoming/ssh.md': 'reference/ssh.md'
'reference/upcoming/features.md': 'reference/features.md'
'reference/upcoming/forwarding.md': 'reference/forwarding.md'
'reference/upcoming/backends.md': 'reference/backends.md'
'reference/upcoming/docker.md': 'reference/docker.md'
'reference/upcoming/kubernetes.md': 'reference/kubernetes.md'
'reference/upcoming/sshproxy.md': 'reference/sshproxy.md'
'reference/upcoming/auth.md': 'reference/auth.md'
'reference/upcoming/auth-webhook.md': 'reference/auth-webhook.md'
'reference/upcoming/auth-oauth2.md': 'reference/auth-oauth2.md'
'reference/upcoming/auth-kerberos.md': 'reference/auth-kerberos.md'
'reference/upcoming/configserver.md': 'reference/configserver.md'
'reference/upcoming/image.md': 'reference/image.md'
'reference/upcoming/logging.md': 'reference/logging.md'
'reference/upcoming/audit.md': 'reference/audit.md'
'reference/upcoming/health.md': 'reference/health.md'
'reference/upcoming/metrics.md': 'reference/metrics.md'
'reference/upcoming/security.md': 'reference/security.md'
'reference/upcoming/hardening.md': 'reference/hardening.md'
'reference/upcoming/http.md': 'reference/http.md'
'reference/upcoming/troubleshooting.md': 'reference/troubleshooting.md'
'reference/upcoming/codes.md': 'reference/codes.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 © The ContainerSSH Contributors
| <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 /><br />
<img src="/images/logos/cncf-white.svg" alt="Cloud Native Computing Foundation" /><br />
We are a Cloud Native Computing Foundation sandbox project.<br /><br />
The Linux Foundation® (TLF) has registered trademarks and uses trademarks. For a list of TLF trademarks, see <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage</a>. <a href="https://www.docker.com/legal/trademark-guidelines">Docker and the Docker logo are trademarks of Docker, Inc.</a>