Commit Graph

55 Commits

Author SHA1 Message Date
Aleksandr Prokudin 615e36bddf
Fix TOC link (#1598) 2025-10-26 14:26:31 +02:00
Aleksandr Prokudin b627d7b045
Add initial documentation on advanced authentication methods (#1597)
* Add initial documentation on advanced authentication methods

* Incorporate feedback from Max

* A few more fixes
2025-10-24 23:34:54 +03:00
Aleksandr Prokudin 69188d823f
Fix embedded videos (#1573) 2025-08-14 15:29:39 +03:00
Aleksandr Prokudin 02184aaf9d
Add initial docs for automatic snapshots (#1566) 2025-07-25 23:31:51 +03:00
Maxim Devaev 7506384243 update 2025-07-25 21:53:10 +03:00
Aleksandr Prokudin e5497ec2d0
Add a blog, with content from the Discord channel (#1565) 2025-07-25 21:26:17 +03:00
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
Maxim Devaev 430286b2d5 update 2025-06-01 23:29:14 +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
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
Aleksandr Prokudin 12c38d851e
Add initial docs about overriding system defaults (#1516) 2025-05-08 21:04:14 +03:00
yeheshuah b60c9a9160
Collapse/Expand section with paragraphs (#1508) 2025-04-30 06:54:55 +03:00
Maxim Devaev 04e4f90921 update 2025-04-30 04:39:28 +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 a437acc617 update 2025-04-29 22:50:35 +03:00
Aleksandr Prokudin 657db6c3f1
Quickstart guide updates (#1502)
* Skeleton of the rewritten v4 quick start page

* Front matter, what's in the box, config update for material, placeholders

* Separate DIP switches doc into a separate file

* Separate USB 3.0 support doc into a separate file

* Reorganize V4 quick start page a little

* Mention the mirror mode

* Supported on-box controls, placeholder image, doc update

* Cosmetic fixes

* Add F° and Basic Troubleshooting

* Initial V3 docs update

- Applied the same general structure as with V4
- Added front matter
- Explained the HAT vs pre-assembled thing
- Moved assembly bits to the assembly instructions page
- Enhanced the assembly instructions page

TODO:

- The Interface part needs to be V3-specific (copy-pasted from V4)

* Fix the interface part

* Cleanup further steps

* First shot at updating the V2 quickstart guide

* Rename V3 guide's name in the sidebar

* Add HW interface graphics

* Finalize updating the V2 quickstart guide

* Cosmetic fixes to V3 and V4 guides

* Update the V1 quick start guide

* Add wiring illustrations for V4

* Add basic front matter to the V1 quick start guide

* Update First Steps

* Add V3 illustrations

* Vectorize the legends in V3 illustrations
2025-04-29 18:32:33 +03:00
Maxim Devaev 3218d63b32 update 2025-04-03 12:30:37 +03:00
Maxim Devaev f2f85aaf45 update 2025-03-25 21:03:01 +02:00
Maxim Devaev 0ce5dc5f19 update 2025-03-25 03:03:32 +02:00
Maxim Devaev dceeebc2f9 update 2025-02-11 02:36:39 +02:00
Maxim Devaev 8aad0cb007 pikvm/pikvm#1462: reverse proxy doc 2025-02-02 09:14:31 +02:00
Maxim Devaev e0e03fe213 update 2025-01-31 18:11:22 +02:00
Maxim Devaev 755fa706ae fixed redirects 2025-01-31 00:38:19 +02:00
Maxim Devaev 413084d081 moved legacy msd docs about ventoy/rufus/etc to msd_legacy.md 2025-01-24 04:59:43 +02:00
Maxim Devaev e2c6db72f5 mic 2025-01-20 04:18:53 +02:00
Maxim Devaev 9b37274447 update 2024-12-20 23:19:27 +02:00
Maxim Devaev b0d5e5fde3 compliance 2024-12-06 02:28:12 +02:00
Maxim Devaev 0351ba5b5d modem 2024-11-17 23:14:19 +02:00
Maxim Devaev 635b25b6c6 update 2024-10-13 06:07:34 +03:00
Maxim Devaev 702eeed9f8 update 2024-08-28 19:09:53 +03:00
Maxim Devaev 8ab5d91e48 update 2024-07-30 16:35:05 +03:00
Maxim Devaev dd36a3c86c update 2024-04-11 18:57:02 +03:00
Maxim Devaev a5aec1a1bf update 2023-12-02 04:21:24 +02:00
Maxim Devaev cfa897f3a7 update 2023-12-02 01:22:47 +02:00
Maxim Devaev 763b9fb78c update 2023-11-01 15:21:18 +02:00
Maxim Devaev 5cbd85e394 jiggler 2023-10-26 11:01:30 +03:00
Maxim Devaev 9e9d750eb5 update 2023-10-24 05:05:06 +03:00
Maxim Devaev 7a7ca7429c update 2023-10-18 22:58:23 +03:00
Maxim Devaev 260e7ee993 update 2023-08-18 08:36:09 +03:00
Maxim Devaev 88f69c9b75 new 2023-07-25 19:22:41 +03:00
Maxim Devaev f73327b301 fix 2023-04-22 21:30:09 +03:00
Solareon 6e12640434
Added tutorial for using cloudflared (#922)
* Added tutorial for using cloudflared

This provides a remote access solution that doesn't rely on port forwarding or requiring any software to be installed on the remote pc.

* Updated to use latest release sourcecode

Removed the requirement to use git to pull code and streamlined for more automated builds.
2023-04-22 21:20:11 +03:00
Maxim Devaev 45972f5015 update 2023-04-15 02:05:04 +03:00
Maxim Devaev 0f678d0630 v4 2023-04-15 02:01:16 +03:00
Maxim Devaev 55d1c49d3b v4 todo 2023-04-14 03:36:21 +03:00
Maxim Devaev 2c7cf7cc02 2fa 2023-01-23 14:44:49 +02:00
Maxim Devaev 61a878066d letsencrypt 2022-06-26 17:21:02 +03:00