-
Notifications
You must be signed in to change notification settings - Fork 54
/
mkdocs.yml
130 lines (126 loc) · 4.38 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
site_name: Perfect Media Server
repo_url: https://github.com/IronicBadger/pms-wiki
repo_name: ironicbadger/pms-wiki
edit_uri: edit/main/docs/
theme:
name: material
custom_dir: overrides
language: en
#logo: images/site/logo.png
favicon: images/assets/favicon.png
icon:
repo: fontawesome/brands/github
logo: fontawesome/regular/folder-open
palette:
- scheme: default
primary: blue
accent: teal
toggle:
icon: material/weather-night
name: Switch to dark mode
- scheme: slate
toggle:
icon: material/weather-sunny
name: Switch to light mode
font:
code: Jet Brains Mono
features:
- navigation.instant
- navigation.sections # prevents collapsible sections
- navigation.indexes # section index pages
- navigation.expand #expands sections by default
# insiders only
# - search.suggest
plugins:
- git-revision-date
- search
- minify:
minify_html: true
markdown_extensions:
- abbr
- admonition # enables coloured blocks mid article
- attr_list # improves image handling
- pymdownx.details # enables collapsible admonitions
- footnotes
- meta # adds support for front matter
- toc:
permalink: true
toc_depth: 4
- pymdownx.highlight: # code highlighting
linenums: true
- pymdownx.tabbed # enables tabs for embedded blocks
- pymdownx.snippets: # enables glossary
auto_append:
- includes/glossary.md
- pymdownx.superfences # allows for the nesting of code blocks inside other blocks
- pymdownx.keys
copyright: 2020 - 2023 © Alex Kretzschmar - Licensed under GPLv3
extra_css:
- extra.css
extra:
social:
- icon: 'fontawesome/brands/github'
link: 'https://github.com/ironicbadger'
name: IronicBadger on GitHub
- icon: 'fontawesome/brands/mastodon'
link: 'https://techhub.social/@ironicbadger'
name: IronicBadger on Mastodon
- icon: 'fontawesome/brands/linkedin'
link: 'https://www.linkedin.com/in/alex-kretzschmar/'
- icon: 'fontawesome/brands/twitter'
link: 'https://twitter.com/ironicbadger'
name: IronicBadger on Twitter
- icon: 'fontawesome/solid/microphone'
link: 'https://selfhosted.show/'
name: IronicBadger's Podcast - selfhosted.show
analytics:
provider: plausible
property: pmswiki
nav:
#- Welcome: 'index.md'
- 1. Overview:
- index.md
- Introduction: '01-overview/overview.md'
- Frequently Asked Questions: '01-overview/faq.md'
- Badgers Stack - May 2022: '01-overview/high-level.md'
- 2. Tech Stack Explained:
- Linux: 'tech-stack/linux.md'
- Containers:
- Docker: 'tech-stack/docker.md'
- docker-compose: 'tech-stack/docker-compose.md'
- MergerFS: 'tech-stack/mergerfs.md'
- SnapRAID: 'tech-stack/snapraid.md'
- ZFS: 'tech-stack/zfs.md'
- Proxmox: 'tech-stack/proxmox.md'
- NAS Software Comparison: 'tech-stack/nas-software-comparison.md'
- 3. Installation:
- Manual Install on Ubuntu: 'installation/manual-install-ubuntu.md'
#- Manual Install on Proxmox: 'installation/manual-install-proxmox.md'
- Manual Install (Video): 'installation/manual-install-on-video.md'
- Automated Install: 'installation/automated-install.md'
- 4. Remote Access:
- remote-access/index.md
- VPNs: 'remote-access/vpns.md'
- Traefik 101 Guide: 'remote-access/traefik101.md'
- SSH (Secure Shell): 'remote-access/ssh.md'
#- WireGuard: 'remote-access/wireguard.md'
- 5. Hardware:
- Intel QuickSync: 'hardware/intel-quicksync.md'
- Cases: 'hardware/cases.md'
- HDD Purchase Methodology: 'hardware/hdd-purchase-methodology.md'
- New Drive Burn-In Rituals: 'hardware/new-drive-burnin.md'
#- Post Install Checklist: 'installation/post-install-checklist.md'
- 6. Day Two (Post Install):
- Top 10 Self-Hosted Apps: 'day-two/top10apps.md'
- Backups: 'day-two/backups.md'
- Quality of Life Tweaks: 'day-two/quality-of-life-tweaks.md'
- 7. Advanced:
- Concepts:
- Infrastructure as Code: 'concepts/infraascode.md'
- Hypervisors: 'concepts/hypervisors.md'
- PCI Passthrough: 'concepts/pci-passthrough.md'
- Configuration:
- Using ZFS with MergerFS: 'advanced/combine-zfs-and-others.md'
- Quick Sync and Proxmox passthrough: 'advanced/passthrough-igpu-gvtg.md'
#- Related Projects:
#- Virtualised OPNsense router: 'related-projects/virtualised-opnsense-proxmox.md'