Is there any plugin development documentation?

[mjsf12]

I am developing a Tailscale plugin to create an HTTP proxy. The purpose of this proxy is to connect KOReader to an ODPS server on my local network via VPN. This development is quite challenging (perhaps because I'm not a Lua developer) without comprehensive documentation. I have already looked at the /koreader/plugins and koreader/contrib plugins. I also have the code loaded into an AI, which provides responses based on it.

Is there any official plugin documentation available?

P.S. Example of the problem: I need to put a plugin button on the network tab, similar to the SSH and Wi-Fi buttons. I was stuck on this for a day until I found the AirPlane Mode plugin and saw it uses sorting_hint = "network".

(Please excuse me if my English isn't perfect, it's not my first language.)

[pazos]

IIRC tailscale is a frontend for wireguard, which is a kernel module.

In order for your plugin to use that feature you will need kernel support, which makes your plugin unable to work on most devices (kindles, kobos, pocketbooks...)

It should work on the desktop if you interface with userspace tools (ie: wg-quick) but there're better ways to use a vpn there.

[pazos]

Is there any plugin development documentation?

There's no specific plugin documentation as there is no API or any boundaries.
You can develop plugins like you would develop a core feature.

General "developer documentation" is rather sparse. It is autogenerated by `luadoc` based on comments. Only a subset of functions are docummented.

tl;dr: you'll need to read the source code of the widgets you're using.

[mjsf12]

Originally Posted by pazos

IIRC tailscale is a frontend for wireguard, which is a kernel module.

In order for your plugin to use that feature you will need kernel support, which makes your plugin unable to work on most devices (kindles, kobos, pocketbooks...)

It should work on the desktop if you interface with userspace tools (ie: wg-quick) but there're better ways to use a vpn there.

From the time I asked until today, I already have the plugin working here. For it to work 100%, I just need to do the login part (which I do via SSH with auth-keys).
If you're curious about how I did the Tailscale part, there's a way for me to generate an HTTP proxy that the plugin automatically adds to KOReader's proxy when active (I had insurmountable bugs, like the header it can't send via this proxy, for example).

P.S.: It works well, I tested it with Calibre Web and Komga; I haven't tested Kavita, but it should work. I still need to find out if KOReader Sync works; overall, it's working well.

Originally Posted by pazos

There's no specific plugin documentation as there is no API or any boundaries.
You can develop plugins like you would develop a core feature.

General "developer documentation" is rather sparse. It is autogenerated by `luadoc` based on comments. Only a subset of functions are docummented.

tl;dr: you'll need to read the source code of the widgets you're using.

Yeah, I found it and others out there on the internet, and along with the plugin codes I found on GitHub/GitLab. I took everything and put it into NotebookLM (it's not perfect, I don't even know if it's ethical, but it sped things up) and I'm managing like this.

[pazos]

Ahh, socks5. That makes sense. Thanks for the follow up!