Commit Graph

1906 Commits

Author SHA1 Message Date
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
dragon788 1d8135fae5
Add note on refreshing package repo if not running full `pikvm-update` before installing Tailscale (#1556)
* Add notes for if a full is not possible

* Fix auto incremented values
2025-07-10 11:36:21 +03:00
Maxim Devaev e5ecbd57ea fix 2025-06-23 23:35:46 +03:00
HD Moore cdc424f030
Update ipmi.md, point to Dan Farmer's page vs dead link (#1545) 2025-06-23 06:41:27 +03:00
Maxim Devaev 9b3b5cbf37 update 2025-06-06 22:08:55 +03:00
Maxim Devaev 72135ce531 update 2025-06-06 17:04:17 +03:00
Aleksandr Prokudin 87099a797f
Add a note for 'used - like new' buyers on Amazon (#1538) 2025-06-04 19:33:44 +03:00
Maxim Devaev 24aa6f2730 update 2025-06-03 21:03:42 +03:00
Maxim Devaev dbfeea9013 update 2025-06-02 22:12:19 +03:00
Maxim Devaev e0ec9e07d7 udpate 2025-06-02 22:00:04 +03:00
Maxim Devaev d47065b2b4 update 2025-06-02 21:55:12 +03:00
Maxim Devaev 132601b340 update 2025-06-02 21:50:57 +03:00
Maxim Devaev c61ad4795e update 2025-06-02 02:01:23 +03:00
Maxim Devaev 6e717395d6 update 2025-06-02 01:49:26 +03:00
Maxim Devaev 430286b2d5 update 2025-06-01 23:29:14 +03:00
Maxim Devaev fd1ee5dec8 update 2025-06-01 22:08:22 +03:00
Maxim Devaev 725a2f9c7a update 2025-06-01 22:02:57 +03:00
Maxim Devaev e6d360fae6 update 2025-06-01 21:49:33 +03:00
Maxim Devaev dfaeeb50cb fix 2025-06-01 21:44:11 +03:00
Maxim Devaev d224a69616 id guide 2025-06-01 21:25:54 +03:00
Aleksandr Prokudin b1bce4ca4e
Fix grammar (#1535) 2025-05-31 12:18:24 +03:00
Maxim Devaev f8a7280de4 fix 2025-05-27 18:55:05 +03:00
Aleksandr Prokudin 5c046a4ebf
Crosslinks to USB passthrough and HDMI passthrough (#1533)
* Crosslinks to USB passthrough and HDMI passthrough

* Fix a formatting error
2025-05-26 16:47:50 +03:00
Maxim Devaev e4cc7911e2 update 2025-05-26 16:14:23 +03:00
Aleksandr Prokudin 9d961bc948
Passthrough (#1529)
* Add USB passthrough documentation

* Add front matter to HDMI passthrough

* Add front matter and Materialize some formatting in Switch docs
2025-05-26 03:54:43 +03:00
Maxim Devaev b3abd62bdf vnc hotkeys 2025-05-24 18:21:48 +03:00
Maxim Devaev 142b13d893 fix 2025-05-24 03:01:18 +03:00
Maxim Devaev 04b0d52e1c update 2025-05-24 02:41:03 +03:00
Aleksandr Prokudin f78daf7aaa
Quick fixes for teh override doc (#1527) 2025-05-21 22:44:16 +03:00
dragon788 d082f69604
Update TESmart links for multiport.md (#1524)
I have several of the TESmart switches both 8 and 16 port and 4k30/4k60 models that all work great with the v4mini and v4plus and DIY models.
2025-05-19 19:01:08 +03:00
Aleksandr Prokudin 35a9fe1836
Re-add quick wifi antenna how-to (#1523)
* Re-add quick wifi antenna how-to

* Embed a video about the antenna
2025-05-19 14:43:11 +03:00
Jason White 8a7c3eb432
Update v1.md (#1521)
Corrected page title below title/description block to read “V1” instead of “V2”.
2025-05-18 19:11:05 +03:00
Baptiste Grenier 66b57d7394
style: rephrase sentence that was a bit reading weird (#1520) 2025-05-16 21:30:21 +03:00
Maxim Devaev 45beb7a42b pikvm/pikvm#1517: Added optocouplers alternatives 2025-05-14 00:27:58 +03:00
Aleksandr Prokudin 12c38d851e
Add initial docs about overriding system defaults (#1516) 2025-05-08 21:04:14 +03:00
Aleksandr Prokudin e5e1bf832b
Enhance the SSH section (#1513) 2025-05-02 23:14:24 +03:00
Aleksandr Prokudin 3cabcd97aa
Update for serial console docs in the cheatsheet (#1512)
* Enhance the serial port docs

* Mention the blank screen and pressing Enter

* Replace screen with picocom in the cheatsheet / serial console docs

* Link to Homebrew and MacPorts for picocom
2025-05-02 20:53:23 +03:00
yeheshuah 8a05f88d2d
Collapse/Expand section with paragraphs (#1509) 2025-04-30 13:21:54 +03:00
Maxim Devaev c3bec6f888 update 2025-04-30 06:55:17 +03:00
yeheshuah b60c9a9160
Collapse/Expand section with paragraphs (#1508) 2025-04-30 06:54:55 +03:00
Maxim Devaev 957c8073d8 update 2025-04-30 06:31:52 +03:00
Maxim Devaev 8232eebffe update 2025-04-30 05:21:51 +03:00
Maxim Devaev 875127b704 fix 2025-04-30 05:10:46 +03:00
Maxim Devaev 5a004c3c1b update 2025-04-30 05:08:15 +03:00
yeheshuah 4016b9b9e4
Updated .gitignore; Collapse/Expand section with text (#1507) 2025-04-30 05:06:28 +03:00
Maxim Devaev 04e4f90921 update 2025-04-30 04:39:28 +03:00
Maxim Devaev d29d910cc6 update 2025-04-30 04:35:55 +03:00
Maxim Devaev 5c91134ae7 update 2025-04-30 04:32:26 +03:00
Maxim Devaev b396ff1a99 update 2025-04-30 04:31:54 +03:00
Maxim Devaev c9b93ba95c update 2025-04-30 02:36:01 +03:00