Skip to content

Chek Docs

Run your own Chek server, build a client on its API, and find out how the pieces of Chek fit together.

Self-host

Run Chek server in Docker. Point it at your folders, a Komga server, or a Kavita server, and read from the app on every device. Start with Install.

Build on the API

Sign in, list libraries, fetch pages, and sync reading positions over HTTP. Start with the API overview.

Write extensions

A source extension is a WebAssembly component that the server runs in a sandbox. Until its guides are on this site, read the extension README.

Embed Chek Reader

Chek Reader is the Swift package that reads EPUB, PDF, and comics in the app. Until its guides are on this site, read the Chek Reader README.