tailscale / tailscale

The easiest, most secure way to use WireGuard and 2FA.
https://tailscale.com
BSD 3-Clause "New" or "Revised" License
18.61k stars 1.43k forks source link

Clean up release/dist/synology/files/config #8232

Open danderson opened 1 year ago

danderson commented 1 year ago

release/dist/synology/files/config is the file that becomes ui/config in our Synology packages, and whose content describes our icon in the program list on the DSM UI, afaict.

This file is partly documented in the developer guide (https://help.synology.com/developer-guide/integrate_dsm/config.html), but we're setting some fields that don't seem to exist, and some undocumented fields also seem to exist:

I think I would like to convert this config file to hujson in git, and have cmd/dist translate it back to plain JSON. In particular, I want to be able to add comments that link to the developer guide, and explain the undocumented field we're using.

Additionally, I think we should remove the version field unless we have evidence that it's used. Empirically we've not updated it for several years and nobody's noticed or complained, which strongly suggests the field is not read at all by DSM.

cc @DentonGentry who I think currently knows the most about the synology app, and cc @crawshaw who added the config originally and may have found something I didn't re: version.

DentonGentry commented 1 year ago

cc @DentonGentry who I think currently knows the most about the synology app

I believe you're correct about the version field not being used. It was never in our build instructions to increment it, so we never did, and nobody has noticed.

I think I would like to convert this config file to hujson in git, and have cmd/dist translate it back to plain JSON

Sure, that would be fine.