# LANrurugi

> A self-hosted library server for manga and comics that also reads PDF, EPUB, MOBI, DjVu, FB2 and TXT books. It started from LANraragi, can open an existing LANraragi library directly, and is rewritten in Rust + React with on-page manga translation, similar-work recommendations and AI plugin generation.

LANrurugi is open source (MIT) and runs from a Docker image or as a native package for Linux, macOS and FreeBSD. This site is the project homepage, in Simplified Chinese (`/`), English (`/en/`) and Japanese (`/ja/`). The documentation, the HTTP API reference and the plugin SDK reference are separate sites, linked below; the documentation site publishes its own llms.txt with the full docs as Markdown.

HTTP API: every endpoint a LANrurugi server serves is described in one OpenAPI 3.1 document, generated from the server's own route registrations, so it lists exactly what the server serves. Endpoints shared with LANraragi keep that project's field-level documentation and stay compatible with its clients. Requests authenticate with an API token created in the instance's settings, sent as `Authorization: Bearer <token>`.

Plugin SDK: plugins are single TypeScript files that the server runs in their own Deno subprocess, with only the network and file permissions they declare. Each exports `pluginInfo()` plus one entry point for its type: `execMetadata` (metadata), `execLogin` (login), `execDownload` (download) or `runScript` (script). The SDK reference is generated by `deno doc` from the TypeScript the plugin runtime loads, and is also published as JSON.

## Documentation

- [Documentation llms.txt](https://docs.lrrg.dev/llms.txt): index of the documentation as Markdown, split by language (English, Simplified Chinese) and by guides versus API reference
- [llms.txt for AI tools](https://docs.lrrg.dev/en/guide/llms-txt/): what each of these files contains and which one to use for what
- [Install with Docker](https://docs.lrrg.dev/en/guide/install/): Docker and NAS setup
- [Native install](https://docs.lrrg.dev/en/guide/install-native/): packages for Linux, macOS and FreeBSD
- [Reverse proxy](https://docs.lrrg.dev/en/guide/reverse-proxy/): HTTPS on your own domain with Nginx, Caddy, Traefik, Apache or Nginx Proxy Manager
- [Quickstart](https://docs.lrrg.dev/en/guide/quickstart/): first login, scanning the library, API tokens, migrating from LANraragi
- [Supported formats](https://docs.lrrg.dev/en/guide/formats/): the archive and e-book formats the library accepts and how each is shown

## HTTP API

- [OpenAPI document](https://docs.lrrg.dev/openapi.json): the complete HTTP API as OpenAPI 3.1 JSON
- [API reference](https://docs.lrrg.dev/en/api/): the same document, one page per endpoint group
- [Swagger UI](https://api.lrrg.dev/en/): browse the schemas and send requests to your own instance
- [Testing the API](https://docs.lrrg.dev/en/guide/api-testing/): sending requests from the browser to your own instance — cross-origin access, HTTPS limits, tokens

## Plugin SDK

- [Writing plugins](https://docs.lrrg.dev/en/plugin/getting-started/): a minimal plugin, the permission model, debugging
- [SDK reference](https://sdk.lrrg.dev/): every type a plugin is written against
- [plugin-sdk.json](https://sdk.lrrg.dev/plugin-sdk.json): the SDK reference as JSON

## Optional

- [Complete documentation](https://docs.lrrg.dev/llms-full.txt): every documentation page in both languages, as one Markdown file
- [Homepage (English)](https://lrrg.dev/en/): features in prose
- [Source code](https://github.com/thelastfantasy/LANrurugi): repository, issues and releases