2021-10-12 18:45:00 +00:00
|
|
|
# https://squidfunk.github.io/mkdocs-material/getting-started
|
|
|
|
|
# https://squidfunk.github.io/mkdocs-material/reference/admonitions
|
|
|
|
|
# https://github.com/squidfunk/mkdocs-material/blob/master/mkdocs.yml
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
site_name: PiKVM Handbook
|
|
|
|
|
site_description: Open and cheap DIY IP-KVM on Raspberry Pi
|
|
|
|
|
site_author: Maxim Devaev
|
|
|
|
|
site_url: https://pikvm.github.io/pikvm
|
|
|
|
|
|
|
|
|
|
repo_name: pikvm/pikvm
|
|
|
|
|
repo_url: https://github.com/pikvm/pikvm
|
|
|
|
|
edit_uri: ""
|
|
|
|
|
|
2022-01-19 09:17:28 +00:00
|
|
|
copyright: "Copyright © 2018-2022 Maxim Devaev"
|
2021-10-12 18:45:00 +00:00
|
|
|
|
|
|
|
|
docs_dir: docs
|
|
|
|
|
|
|
|
|
|
theme:
|
|
|
|
|
logo: _assets/logo.png
|
|
|
|
|
favicon: _assets/favicon.ico
|
|
|
|
|
name: material
|
|
|
|
|
palette:
|
|
|
|
|
accent: pink
|
2021-10-17 07:07:33 +00:00
|
|
|
font:
|
|
|
|
|
text: "arial, sans-serif"
|
|
|
|
|
code: monospace
|
2021-10-12 18:45:00 +00:00
|
|
|
features:
|
|
|
|
|
- navigation.indexes
|
|
|
|
|
- navigation.sections
|
|
|
|
|
- navigation.top
|
|
|
|
|
- navigation.tracking
|
|
|
|
|
- navigation.expand
|
|
|
|
|
- search.highlight
|
|
|
|
|
- search.share
|
|
|
|
|
- search.suggest
|
|
|
|
|
|
|
|
|
|
extra_css:
|
|
|
|
|
- _assets/user.css
|
|
|
|
|
|
|
|
|
|
markdown_extensions:
|
|
|
|
|
- admonition
|
|
|
|
|
- def_list
|
|
|
|
|
- attr_list
|
|
|
|
|
- pymdownx.tilde
|
|
|
|
|
- pymdownx.details
|
|
|
|
|
- pymdownx.superfences
|
|
|
|
|
- pymdownx.magiclink
|
|
|
|
|
- toc:
|
|
|
|
|
permalink: true
|
|
|
|
|
- codehilite:
|
|
|
|
|
guess_lang: false
|
|
|
|
|
- markdown_include.include:
|
|
|
|
|
base_path: docs
|
|
|
|
|
|
|
|
|
|
plugins:
|
|
|
|
|
- search:
|
|
|
|
|
lang: en
|
|
|
|
|
- mkdocs-video
|
|
|
|
|
|
|
|
|
|
nav:
|
|
|
|
|
- "Getting started":
|
2023-04-14 23:05:04 +00:00
|
|
|
- "PiKVM V4 Mini & Plus guide": v4.md
|
|
|
|
|
- "PiKVM V3 HAT guide": v3.md
|
2021-10-12 18:45:00 +00:00
|
|
|
- "First steps": first_steps.md
|
2023-01-23 12:44:49 +00:00
|
|
|
- "Authentication": auth.md
|
2023-08-18 05:36:09 +00:00
|
|
|
- "FAQ & Troubleshooting": faq.md
|
2021-10-12 18:45:00 +00:00
|
|
|
- "Networking":
|
|
|
|
|
- "Internet access":
|
|
|
|
|
- "Port forwarding": port_forwarding.md
|
|
|
|
|
- "Tailscale VPN": tailscale.md
|
2023-04-22 18:30:09 +00:00
|
|
|
- "Cloudflare Tunnel": cloudflared.md
|
2021-10-12 18:45:00 +00:00
|
|
|
- "Setting up Wi-Fi": wifi.md
|
2022-06-26 14:08:06 +00:00
|
|
|
- "Let's Encrypt certificates": letsencrypt.md
|
2021-10-12 18:45:00 +00:00
|
|
|
- "Video":
|
|
|
|
|
- "H.264 / WebRTC": webrtc.md
|
|
|
|
|
- "Working with video": video.md
|
|
|
|
|
- "Tuning HDMI EDID": edid.md
|
2022-06-19 22:32:32 +00:00
|
|
|
- "HDMI audio": audio.md
|
2021-10-12 18:45:00 +00:00
|
|
|
- "Peripheral devices":
|
|
|
|
|
- "Keyboard & mouse":
|
|
|
|
|
- "Mouse modes": mouse.md
|
|
|
|
|
- "Bluetooth HID": bluetooth_hid.md
|
|
|
|
|
- "Arduino HID (USB, PS/2)": arduino_hid.md
|
|
|
|
|
- "Mass Storage Drive": msd.md
|
|
|
|
|
- "Ethernet-over-USB": usb_ethernet.md
|
|
|
|
|
- "Serial-over-USB": usb_serial.md
|
2023-07-25 16:22:41 +00:00
|
|
|
- "Dynamic USB configuration": usb_dynamic.md
|
2021-10-12 18:45:00 +00:00
|
|
|
- "GPIO (pins, relays, lamps, etc)": gpio.md
|
|
|
|
|
- "Advanced usage":
|
|
|
|
|
- "Using VNC": vnc.md
|
|
|
|
|
- "Multiport KVM-over-IP": multiport.md
|
|
|
|
|
- "Wake-on-LAN the server": wol.md
|
|
|
|
|
- "IPMI & Redfish integration": ipmi.md
|
2022-06-20 01:31:34 +00:00
|
|
|
- "Persistent storage": pst.md
|
2021-10-12 18:45:00 +00:00
|
|
|
- "Prometheus monitoring": prometheus.md
|
|
|
|
|
- "Development":
|
|
|
|
|
- "HTTP API reference": api.md
|
2023-08-18 05:36:09 +00:00
|
|
|
- "Building PiKVM OS": building_os.md
|
|
|
|
|
- "Cases for 3D printing": 3d_printing.md
|
