Skip to content

Add-source links

Create an Add to Mankai link so users can preview and install your sources. Users can open the link on a device with Mankai installed, scan a QR code containing it, or paste it into Import Link. See the source guide for the app steps.

mankai://add-plugins?<type>=<base62-url>&<type>=<base62-url>

The scheme is mankai and the host is add-plugins. Keep this host even though the app calls plugins sources. Each query parameter names a source type and contains the Base62 encoding of that source’s complete URL. A link can contain multiple parameters, including repeated types.

Parameter Source URL to encode Optional URL query settings
js JavaScript URL of the JSON manifest Configuration keys declared in the manifest
http Mankai Compatible Base URL of the compatible API, where the server metadata is returned username, password
komga Komga Server Server base URL name, username, password, apiKey
kavita Kavita Server Server base URL name, username, password, apiKey
suwayomi Suwayomi Server Server base URL name, username, password, authMode

Use absolute HTTP or HTTPS URLs. File System sources and file shares such as SMB, SFTP, NFS, WebDAV, and OPDS cannot be installed through this link.

Add optional settings to the source URL before encoding it. Keys such as apiKey and authMode are case-sensitive. For server sources, Mankai extracts the settings and removes the query, URL credentials, and fragment from the server endpoint. For JavaScript sources, Mankai fetches the complete manifest URL and applies query parameters that match its configuration keys.

This example links to the JavaScript manifest at https://example.com/source.json. Replace the example import URL with your own when publishing.

<a href="mankai://add-plugins?js=5zvbbjSoxv0laUE2U4EGdfjbfzO96x7AOifDkg7Jug"
>Add to Mankai</a
>

Use the complete import URL as an anchor’s href or as the text of a QR code. When writing a link with multiple sources directly into HTML, escape query separators as &amp;. Provide a text link alongside the QR code so users can open or paste it on the same device.

Mankai loads each source using its specified type. JavaScript manifests and Mankai Compatible server metadata must be reachable for their previews to load. Successfully loaded sources are selected automatically. Users can deselect any they do not want, then tap Add.

Invalid entries are skipped. If no usable entries remain, the scanner or pasted-link flow reports an invalid link. An unsupported type or a source that cannot load appears as a failed preview and cannot be selected.