This repository has been archived by the owner on Nov 3, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy pathmkdocs.yml
232 lines (223 loc) · 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
#
# Copyright (c) 2019-2021 CZ.NIC z.s.p.o. (http://www.nic.cz/)
#
# This is free software, licensed under the GNU General Public License v3.
# See /LICENSE for more information.
#
# Project information
site_name: Turris Documentation
site_url: https://docs.turris.cz/
site_author: CZ.NIC z.s.p.o.
site_description: Official Turris documentation for both hardware and software
# Repository
repo_url: 'https://gitlab.nic.cz/turris/user-docs'
repo_name: 'turris/user-docs'
edit_uri: 'https://gitlab.nic.cz/turris/user-docs/-/tree/master/docs'
# Copyright
copyright: CC-BY-SA-4.0
# Configuration
theme:
name: 'material'
custom_dir: 'docs/theme'
palette:
- media: "(prefers-color-scheme: light)" # automatically set the color palette to the user's system preference
scheme: turris
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/toggle-switch
name: Switch to light mode
language: 'en'
features:
- navigation.instant
font: false
favicon: 'theme/img/favicon.ico'
logo: 'theme/img/turris-logo.svg'
# Extra stylesheets
extra_css:
- 'theme/css/turris.css'
# Plugins
plugins:
- search:
lang: ['en']
prebuild_index: False
- git-revision-date:
modify_md: False
- include-markdown:
- redirects:
redirect_maps:
'basics/collect/collect.md' : 'basics/sentinel/threat-detection.md'
'basics/collect/haas.md' : 'basics/sentinel/haas.md'
'basics/collect/setup.md' : 'basics/sentinel/setup.md'
'basics/collect/setup-shield.md' : 'basics/sentinel/setup-shield.md'
'basics/collect/dynfw/collect-dynfw.md' : 'basics/sentinel/dynfw.md'
'basics/common_errors.md': 'basics/common-errors.md'
'basics/first-setup/mox_cpu_only.md': 'basics/first-setup/mox-cpu-only.md'
'basics/first-setup/mox_first_setup_warning.md': 'basics/first-setup/mox-first-setup-warning.md'
'basics/first-setup/mox_first_setup.md': 'basics/first-setup/mox-first-setup.md'
'basics/first-setup/shield_first_setup.md': 'basics/first-setup/shield-first-setup.md'
'basics/first-setup/simple_setup.md': 'basics/first-setup/simple-setup.md'
'basics/foris/wan/foris_wan.md': 'basics/foris/wan/foris-wan.md'
'basics/luci/static_dhcp/static_dhcp.md': 'basics/luci/static-dhcp/static-dhcp.md'
'basics/luci/vlan/luci_vlan.md': 'basics/luci/vlan/luci-vlan.md'
'basics/tos_versions.md': 'basics/tos-versions.md'
'geek/contributing/pull_request.md': 'geek/contributing/pull-request.md'
'geek/tos3_migration.md': 'geek/tos3-migration.md'
'hw/mox/rescue_modes.md': 'hw/mox/rescue-modes.md'
'hw/mox/sets/feature_list.md': 'hw/mox/sets/feature-list.md'
'hw/mox/sets/generic_mox.md': 'hw/mox/sets/generic-mox.md'
'hw/omnia/rescue_modes.md': 'hw/omnia/rescue-modes.md'
- minify:
minify_html: true
htmlmin_opts:
remove_comments: true
# Customization
extra:
social:
- icon: 'fontawesome/solid/globe'
link: 'https://turris.cz'
- icon: 'fontawesome/brands/gitlab'
link: 'https://gitlab.nic.cz/turris'
- icon: 'fontawesome/brands/github'
link: 'https://github.com/CZ-NIC'
- icon: 'fontawesome/brands/twitter'
link: 'https://twitter.com/turris_cz'
# Extensions
markdown_extensions:
- mdlightbox
- meta
- markdown_include.include:
base_path: docs
- admonition
- cell_row_span
- extra
- pymdownx.details
- pymdownx.superfences
- codehilite
- markdown_jinja:
fs_loader_dir: 'docs'
- smarty
- toc:
permalink: '⚓︎'
- wikilinks
- admonition
- pyembed.markdown
# Page tree
nav:
- Introduction: 'index.md'
- First setup:
- 'MOX': 'basics/first-setup/mox-first-setup.md'
- 'Shield': 'basics/first-setup/shield-first-setup.md'
- 'Turris 1.X and Omnia': 'basics/first-setup/simple-setup.md'
- 'Ethernetless configuration': 'basics/first-setup/ethernetless.md'
- 'First steps after setup': 'basics/first-setup/after-setup.md'
- Software:
- 'Landing page': 'basics/landing-page.md'
- Sentinel:
- Introduction: 'basics/sentinel/intro.md'
- Dynamic Firewall: 'basics/sentinel/dynfw.md'
- Threat Detection: 'basics/sentinel/threat-detection.md'
- Setup: 'basics/sentinel/setup.md'
- Setup on Shield: 'basics/sentinel/setup-shield.md'
- HaaS: 'basics/sentinel/haas.md'
- reForis:
- About: 'basics/reforis/intro.md'
- 'Secure access': 'basics/reforis/https/https.md'
- Network:
- 'Wi-Fi': 'basics/reforis/wifi/reforis-wifi.md'
- WAN: 'basics/reforis/wan/reforis-wan.md'
- LAN: 'basics/reforis/lan/reforis-lan.md'
- DNS: 'basics/reforis/dns/reforis-dns.md'
- Interfaces: 'basics/reforis/interfaces/interfaces.md'
- 'Guest Network': 'basics/reforis/guest-network/guest-network.md'
- Administration:
- Notifications: 'basics/reforis/notifications/reforis-notifications.md'
- Hostname: 'basics/reforis/hostname/hostname.md'
- Updates: 'basics/reforis/updates/reforis-updates.md'
- 'Factory reset': 'basics/reforis/factory-reset/factory-reset.md'
- Storage: 'basics/reforis/storage-plugin/storage-plugin.md'
- LuCI:
- Introduction: 'basics/luci/luci.md'
- Static IP: 'basics/luci/static-dhcp/static-dhcp.md'
- VLAN: 'basics/luci/vlan/luci-vlan.md'
- Applications:
- 'NetMetr': 'basics/apps/netmetr.md'
- 'Nextcloud': 'geek/nextcloud/nextcloud.md'
- 'OpenVPN server': 'basics/apps/openvpn-server/openvpn.md'
- 'OpenVPN client': 'basics/apps/openvpn-client/openvpn.md'
- 'PaKon': 'basics/apps/pakon.md'
- 'Sentinel': 'basics/apps/sentinel.md'
- 'Atlas probe': 'basics/apps/atlas.md'
- Advanced:
- 'LXC': 'geek/lxc/lxc.md'
- 'Netboot': 'basics/apps/netboot.md'
- 'Schnapps': 'geek/schnapps/schnapps.md'
- 'Btrfs migration': 'geek/btrfs_turris1x.md'
- 'Netdata': 'geek/netdata/netdata.md'
- Legacy:
- Foris:
- About: 'basics/foris/intro.md'
- 'Secure access': 'basics/foris/https/https.md'
- WAN: 'basics/foris/wan/foris-wan.md'
- LAN: 'basics/foris/lan/foris-lan.md'
- DNS: 'basics/foris/dns/foris-dns.md'
- 'Guest network': 'basics/foris/guest-network/guest-network.md'
- 'Storage': 'basics/foris/storage-plugin/storage-plugin.md'
- 'OS versions':
- Versions: 'basics/tos-versions.md'
- Changelog: 'basics/changelog.md'
- 'Early access': 'geek/testing.md'
- '3.x migration': 'geek/tos3-migration.md'
- 'Security':
- 'Passwords': 'security/passwords.md'
- 'Password filter': 'security/common-passwords.md'
- Contributing:
- Overview: 'geek/contributing/overview.md'
- Translation: 'geek/contributing/translation.md'
- Issues: 'geek/contributing/issues.md'
- "Pull requests": 'geek/contributing/pull-request.md'
- "Coding style": 'geek/contributing/style.md'
- Hardware:
- Models: 'basics/models.md'
- MOX:
- About: 'hw/mox/intro.md'
- Sets:
- 'Start': 'hw/mox/sets/start.md'
- 'Pocket Wi-Fi': 'hw/mox/sets/pocketwifi.md'
- 'Power Wi-Fi': 'hw/mox/sets/powerwifi.md'
- 'Classic': 'hw/mox/sets/classic.md'
- Modules:
- 'MOX A (Basic)': 'hw/mox/modules/a.md'
- 'MOX B (Extension)': 'hw/mox/modules/b.md'
- 'MOX C (Ethernet)': 'hw/mox/modules/c.md'
- 'MOX D (SFP)': 'hw/mox/modules/d.md'
- 'MOX E (Super Ethernet)': 'hw/mox/modules/e.md'
- 'MOX F (USB)': 'hw/mox/modules/f.md'
- 'MOX G (Super Extension)': 'hw/mox/modules/g.md'
- Add-ons: 'hw/mox/addons.md'
- Hardware details: 'hw/mox/hw.md'
- Omnia:
- About: 'hw/omnia/omnia.md'
- Revisions: 'hw/omnia/revisions.md'
- 'Boot from SSD': 'hw/omnia/ssd-boot.md'
- Shield:
- About: 'hw/shield/shield.md'
- Screenshots: 'hw/shield/screenshots.md'
- Turris 1.X: 'hw/turris-1x/turris-1x.md'
- 'Wi-Fi coverage': 'hw/wifi.md'
- Troubleshooting:
- 'Common errors': 'basics/common-errors.md'
- Rescue modes:
- 'MOX': 'hw/mox/rescue-modes.md'
- 'Omnia': 'hw/omnia/rescue-modes.md'
- 'Shield': 'hw/shield/rescue-modes.md'
- 'Turris 1.X': 'hw/turris-1x/factory-reset.md'
- MOX MicroSD: 'hw/mox/microsd.md'
- 'Serial connection': 'hw/serial.md'
- 'Serial boot':
- 'MOX': 'hw/mox/serial-boot.md'
- 'Omnia': 'hw/omnia/serial-boot.md'
- Support: 'basics/support.md'