tiny-pilot / tinypilot

Use your Raspberry Pi as a browser-based KVM.
https://tinypilotkvm.com
MIT License
3.01k stars 252 forks source link

Find a new place to document properties in `settings.yml` #1573

Closed jotaen4tinypilot closed 5 months ago

jotaen4tinypilot commented 1 year ago

The properties in settings.yml used to be documented via the Ansible roles. However, the Ansible role for tinypilot is already gone, and the ustreamer role will follow.

Therefore, I think it would be good to have one central place where all known properties are declared and documented. We should also clearly label the properties based on whether they are

https://tinypilotkvm.com/pro/changes#261 provides the most up-to-date overview of supported settings of user-editable settings.

Related https://github.com/tiny-pilot/tinypilot/issues/1524.