public_git
/
pikvm
mirror of https://github.com/pikvm/pikvm.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
pikvm/docs
History
Aleksandr Prokudin d210a09ae9
Major update of the API documentation (#1557) 
* Add initial HID API documentation

The first version has placeholders for responses, to be filled at a later time.

* Add initial Streamer API documentation

Currently missing information about query parameters and a few others things.
To be fixed after the first pass at all APIs.

* Add initial PiKVM Switch API and Redfish API documentation

This covers the basics and requires some testing to finalize the documentation

* Cleanup, part 1 of N

- Write short intro for HID and Streamer sections
- Fix the structure in HI and Streamer
- Standardize descriptions

* Cleanup, part 2 of N: more standardization

* Cleanup, part 3 of N:

- Standardize the markup for code blocks and CLI commands
- Enable the 'copy code' button in the theme

* Cleanup, part 4 of N:

- Actually commit the theme settings change (copy code button)
- Wrap URLs with ampersands in single quotes as requested by @mdevaev
- Clarify a few points as suggested by @mdevaev

* Cleanup, part 5 of N:

- Update MSD and GPIO docs for consistence's sake
- A bunch of FIXMEs to take care of alt a later time

* GPIO API: mention the pulse mode support requirement

* Cleanup Responses subsections, we'll do it differently

* Update API documentation: OCR options and examples, GPIO, and more
 		2025-07-14 22:38:21 +03:00
..
_assets Collapse/Expand section with paragraphs (#1509) 2025-04-30 13:21:54 +03:00
_diy docs: ribbon cable orientation hints & pi 2w (#1323) 2024-05-13 06:01:39 +03:00
arduino_hid docs.pikvm.org 2021-10-12 21:45:00 +03:00
atx_board pikvm/pikvm#1435: Fixed ethernet cable info link 2024-12-06 13:59:00 +02:00
audio mic 2025-01-20 04:18:53 +02:00
compliance update 2024-12-23 19:35:43 +02:00
config id guide 2025-06-01 21:25:54 +03:00
driver/win usb ethernet compatibility and rndis5 driver inf for windows xp to windows 7 (#615) 2022-02-21 10:21:53 +03:00
ezcoo dev info about ezcoo 2021-10-16 08:15:35 +03:00
faq docs.pikvm.org 2021-10-12 21:45:00 +03:00
flashing_os Delete docs/flashing_os/imager-4.jpg (#1167) 2023-11-19 03:38:09 +02:00
gpio docs.pikvm.org 2021-10-12 21:45:00 +03:00
mouse_jiggler jiggler 2023-10-26 11:01:30 +03:00
msd update 2023-08-20 02:09:25 +03:00
pass update 2024-04-07 00:23:25 +03:00
pico_hid update 2023-09-07 15:47:38 +03:00
pico_hid_bridge bridge 2023-10-24 04:21:16 +03:00
stl fix 2022-06-20 02:06:50 +03:00
switch switch docs 2024-12-17 21:56:52 +02:00
tesmart docs.pikvm.org 2021-10-12 21:45:00 +03:00
usb_pass update 2025-05-26 16:14:23 +03:00
v1 update 2023-10-20 09:33:18 +03:00
v2 update 2023-10-20 09:33:18 +03:00
v3 Quickstart guide updates (#1502) 2025-04-29 18:32:33 +03:00
v3_illustrated_install_instructions Add files via upload (#866) 2022-11-14 00:56:23 +03:00
v4 update 2025-04-29 22:50:35 +03:00
video update 2025-01-31 18:11:22 +02:00
vnc tigervnc beta 2022-12-28 04:59:40 +03:00
webui Name change (#1389) 2024-08-24 12:30:53 +03:00
wiring_examples ezcoo wiring example (#586) 2021-12-29 00:27:01 +03:00
xh_hk4401 Improved xh-hk4401 docs (#550) 2021-11-29 01:32:02 +03:00
3d_printing.md 3d_printing.md: Fix link for one DIY case (#1439) 2024-12-12 22:52:31 +02:00
CNAME Update CNAME 2021-10-12 22:04:37 +03:00
_basic_troubleshooting.md Quickstart fixes (#1503) 2025-04-29 19:05:58 +03:00
_config.md update 2025-04-30 04:31:54 +03:00
_device_guides.md update 2025-04-30 06:31:52 +03:00
_diy_parts_atx.md pikvm/pikvm#1517: Added optocouplers alternatives 2025-05-14 00:27:58 +03:00
_diy_setup_video_csi.md update 2025-03-25 03:03:32 +02:00
_diy_setup_video_usb.md update 2025-03-25 03:03:32 +02:00
_diy_wiring_atx.md update 2025-03-25 03:03:32 +02:00
_edidconf_options.md fix 2025-06-01 21:44:11 +03:00
_fahrenheit.md update 2025-04-30 06:31:52 +03:00
_multiport_usb.md update 2025-03-25 03:03:32 +02:00
_passwd.md update 2025-04-30 04:31:54 +03:00
_pico_hid_flashing.md update 2025-06-06 22:08:55 +03:00
_pico_hid_parts.md update 2025-03-25 03:03:32 +02:00
_update_os.md update 2025-04-30 04:31:54 +03:00
_usb_limits.md update 2025-03-25 03:03:32 +02:00
api.md Major update of the API documentation (#1557) 2025-07-14 22:38:21 +03:00
arduino_hid.md update 2024-02-18 01:15:14 +02:00
atx_board.md pikvm/pikvm#1435: Fixed ethernet cable info link 2024-12-06 13:59:00 +02:00
audio.md update 2025-01-31 18:11:22 +02:00
auth.md update 2025-05-24 02:41:03 +03:00
bluetooth_hid.md update 2024-02-18 01:15:14 +02:00
building_os.md update 2023-12-02 03:56:22 +02:00
cheatsheet.md Enhance the SSH section (#1513) 2025-05-02 23:14:24 +03:00
cloudflared.md fix: update cloudflared steps to ensure its persistent between reboots (#1320) 2024-05-06 17:13:27 +03:00
compliance.md update 2024-12-06 18:13:39 +02:00
config.md id guide 2025-06-01 21:25:54 +03:00
edid.md update 2025-06-01 22:08:22 +03:00
ezcoo.md Update ezcoo.md (#1351) 2024-06-18 15:13:31 +03:00
faq.md update 2025-06-06 17:04:17 +03:00
flashing_hid.md update 2025-04-30 06:31:52 +03:00
flashing_os.md update 2025-03-11 23:18:34 +02:00
gpio.md fix 2025-06-23 23:35:46 +03:00
id.md update 2025-06-02 21:50:57 +03:00
index.md update 2025-04-30 06:31:52 +03:00
ipmi.md Update ipmi.md, point to Dan Farmer's page vs dead link (#1545) 2025-06-23 06:41:27 +03:00
letsencrypt.md update 2024-02-18 01:15:14 +02:00
modem.md modem 2024-11-17 23:14:19 +02:00
mouse.md update 2023-12-02 03:56:22 +02:00
mouse_jiggler.md update 2025-01-10 23:48:26 +02:00
msd.md fix 2025-05-24 03:01:18 +03:00
msd_legacy.md moved legacy msd docs about ventoy/rufus/etc to msd_legacy.md 2025-01-24 04:59:43 +02:00
multiport.md Update TESmart links for multiport.md (#1524) 2025-05-19 19:01:08 +03:00
ocr.md fix 2022-03-16 03:42:11 +03:00
on_boot_config.md update 2025-03-03 03:28:05 +02:00
pass.md Crosslinks to USB passthrough and HDMI passthrough (#1533) 2025-05-26 16:47:50 +03:00
pico_hid.md update 2025-01-04 18:54:59 +02:00
pico_hid_bridge.md update 2025-01-04 18:54:59 +02:00
port_forwarding.md update 2023-08-25 23:12:42 +03:00
prometheus.md fix 2022-08-11 12:12:36 +03:00
pst.md Fix typo in pst.md (#1185) 2023-12-06 23:19:01 +02:00
reverse_proxy.md update 2025-02-10 14:09:09 +02:00
switch.md Passthrough (#1529) 2025-05-26 03:54:43 +03:00
tailscale.md Add note on refreshing package repo if not running full `pikvm-update` before installing Tailscale (#1556) 2025-07-10 11:36:21 +03:00
tesmart.md update 2023-09-08 00:02:54 +03:00
usb.md update 2025-06-02 01:49:26 +03:00
usb_ethernet.md update 2025-06-03 21:03:42 +03:00
usb_pass.md Crosslinks to USB passthrough and HDMI passthrough (#1533) 2025-05-26 16:47:50 +03:00
usb_serial.md mic 2025-01-20 04:18:53 +02:00
v1.md id guide 2025-06-01 21:25:54 +03:00
v2.md id guide 2025-06-01 21:25:54 +03:00
v3.md Add a note for 'used - like new' buyers on Amazon (#1538) 2025-06-04 19:33:44 +03:00
v3_illustrated_install_instructions.md Quickstart guide updates (#1502) 2025-04-29 18:32:33 +03:00
v4.md Add a note for 'used - like new' buyers on Amazon (#1538) 2025-06-04 19:33:44 +03:00
video.md update 2025-01-31 18:11:22 +02:00
vnc.md vnc hotkeys 2025-05-24 18:21:48 +03:00
webrtc_config.md update 2025-01-31 18:11:22 +02:00
webui.md Fixed document (#1395) 2024-09-03 21:07:36 +03:00
wifi.md update 2025-06-06 17:04:17 +03:00
wiring_examples.md update 2023-10-18 22:58:23 +03:00
wol.md docs.pikvm.org 2021-10-12 21:45:00 +03:00
xh_hk4401.md Update xh_hk4401.md (#1308) 2024-04-26 03:24:59 +03:00