# yaml-language-server: $schema=https://schema.zeabur.app/template.json apiVersion: zeabur.com/v1 kind: Template metadata: name: Reader 在线小说阅读器 spec: description: | Reader is a self-hosted online reading service powered by imported book sources. It is suitable for Pixiv-style novel feeds, Japanese light novel sites, and classic literature sources. coverImage: https://raw.githubusercontent.com/hectorqin/reader/master/imgs/1.jpg icon: https://raw.githubusercontent.com/hectorqin/reader/master/web/public/img/icons/android-chrome-512x512.png variables: - key: PUBLIC_DOMAIN type: DOMAIN name: Domain description: Domain for your Reader web app. - key: ADMIN_PASSWORD type: PASSWORD name: Admin Password description: Password used as Reader admin secure key. - key: INVITE_CODE type: STRING name: Invite Code description: Optional invite code for user registration. Leave empty to disable. tags: - Reader - Novel - Self-hosted - Light Novel - Literature readme: | # Reader (Self-hosted Online Novel Reader) Reader is a self-hosted web reader that works with imported community book sources. This template is suitable for users who want one web app to browse Pixiv-related novels, Japanese light novels, and classic literature sources. ## Important notice about Pixiv Reader does **not** include a built-in official Pixiv connector. Pixiv content is available only through external book sources and depends on source quality and availability. ## Features - Multi-user mode with admin password and optional invite code - Persistent storage for `/logs` and `/storage` - Web UI optimized for desktop and mobile - Source import workflow for many novel websites ## Deploy and access 1. Deploy this template in Zeabur. 2. Open `${ZEABUR_WEB_URL}/#/`. 3. Sign in with the admin password you set in `ADMIN_PASSWORD`. ## Import book sources 1. Go to Reader settings after login. 2. Import source files or paste source URLs. 3. Recommended source entry page: `https://legado.aoaostar.com/`. Example source categories you can look for from community sets: - Japanese web novel platforms (for example: Kakuyomu, Hameln) - Light novel sources - Classic literature sources ## Environment variables | Variable | Purpose | | --- | --- | | `PUBLIC_DOMAIN` | Domain bound to the Reader web service | | `ADMIN_PASSWORD` | Admin secure key used by Reader | | `INVITE_CODE` | Optional invite code, empty means open registration | ## FAQ ### How do I disable invite-only registration? Leave `INVITE_CODE` empty when deploying. ### Does this template include remote-webview? No. This template deploys only the `reader` service for stability and simpler maintenance. services: - name: reader icon: https://raw.githubusercontent.com/hectorqin/reader/master/web/public/img/icons/android-chrome-512x512.png template: PREBUILT_V2 spec: id: reader source: image: hectorqin/reader ports: - id: web port: 8080 type: HTTP volumes: - id: logs dir: /logs - id: storage dir: /storage instructions: - title: Access URL content: ${ZEABUR_WEB_URL}/#/ - title: Admin Password content: ${ADMIN_PASSWORD} env: READER_APP_CACHECHAPTERCONTENT: default: "true" READER_APP_INVITECODE: default: ${INVITE_CODE} READER_APP_SECURE: default: "true" READER_APP_SECUREKEY: default: ${ADMIN_PASSWORD} READER_APP_USERBOOKLIMIT: default: "200" READER_APP_USERLIMIT: default: "50" SPRING_PROFILES_ACTIVE: default: prod domainKey: PUBLIC_DOMAIN localization: es-ES: description: | Reader es un lector en línea autoalojado que funciona con fuentes externas importadas. Es útil para leer novelas relacionadas con Pixiv, novelas ligeras japonesas y literatura clásica. variables: - key: PUBLIC_DOMAIN type: DOMAIN name: Dominio description: Dominio para tu servicio Reader. - key: ADMIN_PASSWORD type: PASSWORD name: Contrasena de administrador description: Clave de seguridad del administrador de Reader. - key: INVITE_CODE type: STRING name: Codigo de invitacion description: Codigo opcional para registro de usuarios. Vacio para desactivar. readme: | # Reader (lector de novelas autoalojado) Reader es una aplicacion web autoalojada que usa fuentes comunitarias importadas. Sirve para escenarios de lectura de novelas tipo Pixiv, light novels japonesas y literatura clasica. ## Aviso sobre Pixiv Reader no incluye un conector oficial integrado para Pixiv. El acceso depende de fuentes externas y de su disponibilidad. ## Uso rapido 1. Despliega esta plantilla en Zeabur. 2. Abre `${ZEABUR_WEB_URL}/#/`. 3. Inicia sesion con `ADMIN_PASSWORD`. ## Importar fuentes - Entrada recomendada: `https://legado.aoaostar.com/` - Ejemplos de categorias: Kakuyomu, Hameln, fuentes de light novel y de literatura clasica. id-ID: description: | Reader adalah layanan baca online self-hosted yang bekerja dengan sumber buku eksternal. Cocok untuk novel terkait Pixiv, light novel Jepang, dan literatur klasik. variables: - key: PUBLIC_DOMAIN type: DOMAIN name: Domain description: Domain untuk layanan Reader kamu. - key: ADMIN_PASSWORD type: PASSWORD name: Kata sandi admin description: Kunci keamanan admin untuk Reader. - key: INVITE_CODE type: STRING name: Kode undangan description: Kode undangan opsional untuk registrasi pengguna. Kosongkan untuk nonaktif. readme: | # Reader (pembaca novel self-hosted) Reader adalah aplikasi web self-hosted yang memakai sumber komunitas yang diimpor. Cocok untuk membaca konten gaya Pixiv, light novel Jepang, dan sastra klasik. ## Catatan Pixiv Reader tidak memiliki konektor resmi Pixiv bawaan. Konten Pixiv hanya tersedia melalui sumber eksternal dan bergantung pada kualitas sumber. ## Langkah cepat 1. Deploy template ini di Zeabur. 2. Buka `${ZEABUR_WEB_URL}/#/`. 3. Login dengan kata sandi dari `ADMIN_PASSWORD`. ## Impor sumber - Gunakan halaman masuk sumber: `https://legado.aoaostar.com/` - Contoh kategori: Kakuyomu, Hameln, light novel, dan literatur klasik. ja-JP: description: | Reader は外部ブックソースを取り込んで使うセルフホスト型オンラインリーダーです。 Pixiv 関連小説、日本ライトノベル、古典文学の閲覧用途に向いています。 variables: - key: PUBLIC_DOMAIN type: DOMAIN name: ドメイン description: Reader サービスに割り当てるドメイン。 - key: ADMIN_PASSWORD type: PASSWORD name: 管理者パスワード description: Reader の管理者セキュアキー。 - key: INVITE_CODE type: STRING name: 招待コード description: ユーザー登録用の招待コード。空欄で招待制を無効化。 readme: | # Reader（セルフホスト小説リーダー） Reader はコミュニティのブックソースをインポートして使う Web リーダーです。 Pixiv 関連小説、日本ライトノベル、古典文学をまとめて読む用途に適しています。 ## Pixiv について Reader には公式 Pixiv コネクタは内蔵されていません。 Pixiv コンテンツは外部ソース経由でのみ利用でき、可用性はソースに依存します。 ## セットアップ 1. Zeabur にこのテンプレートをデプロイします。 2. `${ZEABUR_WEB_URL}/#/` を開きます。 3. `ADMIN_PASSWORD` で設定したパスワードでログインします。 ## ブックソースの導入 1. ログイン後、Reader の設定画面を開きます。 2. ソースファイルをインポートするか、URL を貼り付けます。 3. 入口として `https://legado.aoaostar.com/` を利用できます。 例として、Kakuyomu・Hameln・ライトノベル系・古典文学系のカテゴリを探せます。 zh-CN: description: | Reader 是一个通过外部书源运行的自部署在线阅读服务。 适合 Pixiv 相关小说、日本轻小说和经典文学阅读场景。 variables: - key: PUBLIC_DOMAIN type: DOMAIN name: 域名 description: Reader 网站绑定的域名。 - key: ADMIN_PASSWORD type: PASSWORD name: 管理员密码 description: Reader 管理员安全密码。 - key: INVITE_CODE type: STRING name: 邀请码 description: 用户注册邀请码，可留空以关闭邀请制。 readme: | # Reader（自部署小说阅读器） Reader 是可自部署的网页阅读器，通过导入社区书源来阅读内容。 这份模板适合希望集中阅读 Pixiv 相关小说、日本轻小说和经典文学的用户。 ## Pixiv 说明 Reader **不内置** 官方 Pixiv 连接器。 Pixiv 内容需要依赖外部书源，实际可用性取决于书源质量和维护状态。 ## 功能 - 多用户模式（管理员密码 + 可选邀请码） - `/logs` 与 `/storage` 持久化存储 - 支持桌面和移动端 - 支持导入多种小说站点书源 ## 部署后使用 1. 在 Zeabur 部署此模板。 2. 打开 `${ZEABUR_WEB_URL}/#/`。 3. 使用 `ADMIN_PASSWORD` 设置的密码登录。 ## 导入书源 1. 登录后进入 Reader 设置。 2. 导入书源文件或粘贴书源链接。 3. 可先使用 `https://legado.aoaostar.com/` 作为入口。 社区常见分类示例：Kakuyomu、Hameln、轻小说来源、名著来源。 ## 常见问题 - 关闭邀请制：部署时将 `INVITE_CODE` 置空。 - 本模板不包含 remote-webview，默认仅部署 `reader` 服务。 zh-TW: description: | Reader 是一個透過外部書源運作的自部署線上閱讀服務。 適合用於 Pixiv 相關小說、日本輕小說與經典文學閱讀場景。 variables: - key: PUBLIC_DOMAIN type: DOMAIN name: 網域 description: Reader 網站要綁定的網域。 - key: ADMIN_PASSWORD type: PASSWORD name: 管理員密碼 description: Reader 管理員安全密碼。 - key: INVITE_CODE type: STRING name: 邀請碼 description: 使用者註冊邀請碼，可留空關閉邀請制。 readme: | # Reader（自部署小說閱讀器） Reader 是可自部署的網頁閱讀器，透過匯入社群書源來閱讀內容。 這份模板適合想集中閱讀 Pixiv 相關小說、日本輕小說與經典文學的使用者。 ## Pixiv 說明 Reader **不包含** 官方 Pixiv 內建連接器。 Pixiv 內容需依賴外部書源，實際可用性取決於書源品質與維護狀態。 ## 功能 - 多使用者模式（管理員密碼 + 可選邀請碼） - `/logs` 與 `/storage` 持久化儲存 - 桌機與行動裝置皆可使用 - 支援匯入多種小說站點書源 ## 部署後使用 1. 在 Zeabur 部署此模板。 2. 開啟 `${ZEABUR_WEB_URL}/#/`。 3. 使用 `ADMIN_PASSWORD` 設定的密碼登入。 ## 匯入書源 1. 登入後進入 Reader 設定頁。 2. 匯入書源檔案或貼上書源連結。 3. 可先從 `https://legado.aoaostar.com/` 取得入口。 社群常見分類示例：Kakuyomu、Hameln、輕小說來源、名著來源。