# yaml-language-server: $schema=https://schema.zeabur.app/template.json
apiVersion: zeabur.com/v1
kind: Template
metadata:
    name: BookStack
spec:
    description: |
        BookStack is a self-hosted wiki platform for organizing and storing information. Uses a simple structure of shelves, books, chapters, and pages. Features WYSIWYG and Markdown editors, full-text search, role-based permissions, and multi-language support.
    coverImage: https://avatars.githubusercontent.com/u/20912696?v=4
    icon: https://avatars.githubusercontent.com/u/20912696?v=4
    variables:
        - key: PUBLIC_DOMAIN
          type: DOMAIN
          name: Domain
          description: The domain to access BookStack
    tags:
        - Tool
        - Document
    readme: |
        # BookStack

        A self-hosted wiki platform for organizing and storing information. Uses an intuitive structure of shelves, books, chapters, and pages to keep your documentation organized.

        ## What You Can Do After Deployment

        Visit your domain and log in with the default credentials: **admin@admin.com** / **password**. Change these immediately after first login.

        **Content organization:** Create shelves to group related books, books to hold chapters and pages, and use chapters for logical grouping. Drag and drop to reorder content.

        **Editing:** Choose between a WYSIWYG editor, Markdown editor, or plain HTML editor. Embed images, attachments, code blocks, and diagrams. Supports drawing with the built-in draw.io integration.

        **Search:** Full-text search across all content with filters for tags, creation date, and content type. Search results show context snippets.

        **Permissions:** Granular role-based access control at every level — shelves, books, chapters, and pages. Create custom roles with specific permissions.

        **API:** RESTful API for programmatic access to all content. Generate personal API tokens from your profile.

        **Export:** Export pages and books as PDF, HTML, Markdown, or plain text.

        ## First-Time Setup

        1. Log in with **admin@admin.com** / **password**
        2. Go to Settings > Users and change the admin email and password
        3. Configure your application name and settings under Settings > Application

        ## Configuration

        - **App URL:** Set automatically from your Zeabur domain
        - **Database:** Uses SQLite by default via the linuxserver image — no external database required

        ## License

        MIT — [GitHub](https://github.com/BookStackApp/BookStack)
    services:
        - name: bookstack
          icon: https://avatars.githubusercontent.com/u/20912696?v=4
          template: PREBUILT_V2
          spec:
            source:
                image: linuxserver/bookstack:26.03.2
            ports:
                - id: web
                  port: 80
                  type: HTTP
            volumes:
                - id: config
                  dir: /config
            env:
                APP_KEY:
                    default: ${PASSWORD}
                APP_URL:
                    default: https://${ZEABUR_WEB_URL}
                DB_CONNECTION:
                    default: sqlite
                PGID:
                    default: "1000"
                PUID:
                    default: "1000"
          domainKey: PUBLIC_DOMAIN
localization:
    es-ES:
        description: |
            BookStack es una plataforma wiki autoalojada para organizar y almacenar información. Usa una estructura simple de estantes, libros, capítulos y páginas. Incluye editores WYSIWYG y Markdown, búsqueda de texto completo y permisos basados en roles.
        variables:
            - key: PUBLIC_DOMAIN
              type: STRING
              name: Dominio
              description: El dominio para acceder a BookStack
        readme: |
            # BookStack

            Plataforma wiki autoalojada para organizar y almacenar información. Estructura intuitiva de estantes, libros, capítulos y páginas.

            ## Qué puedes hacer después del despliegue

            Visita tu dominio e inicia sesión con las credenciales por defecto: **admin@admin.com** / **password**. Cámbialas inmediatamente.

            **Organización de contenido:** Crea estantes, libros, capítulos y páginas. Arrastra y suelta para reordenar.

            **Edición:** Editores WYSIWYG, Markdown o HTML. Soporte para imágenes, adjuntos, bloques de código y diagramas draw.io.

            **Búsqueda:** Búsqueda de texto completo con filtros por etiquetas y fechas.

            **Permisos:** Control de acceso granular basado en roles en cada nivel.

            **Exportación:** Exporta páginas y libros como PDF, HTML, Markdown o texto plano.

            ## Configuración inicial

            1. Inicia sesión con **admin@admin.com** / **password**
            2. Ve a Configuración > Usuarios y cambia el correo y contraseña del administrador

            ## Licencia

            MIT — [GitHub](https://github.com/BookStackApp/BookStack)
    id-ID:
        description: |
            BookStack adalah platform wiki self-hosted untuk mengatur dan menyimpan informasi. Menggunakan struktur sederhana rak, buku, bab, dan halaman. Dilengkapi editor WYSIWYG dan Markdown, pencarian teks lengkap, dan izin berbasis peran.
        variables:
            - key: PUBLIC_DOMAIN
              type: STRING
              name: Domain
              description: Domain untuk mengakses BookStack
        readme: |
            # BookStack

            Platform wiki self-hosted untuk mengatur dan menyimpan informasi. Struktur intuitif rak, buku, bab, dan halaman.

            ## Apa yang bisa dilakukan setelah deploy

            Buka domain Anda dan login dengan kredensial default: **admin@admin.com** / **password**. Segera ubah setelah login pertama.

            **Organisasi konten:** Buat rak, buku, bab, dan halaman. Drag and drop untuk mengurutkan ulang.

            **Editing:** Editor WYSIWYG, Markdown, atau HTML. Mendukung gambar, lampiran, blok kode, dan diagram draw.io.

            **Pencarian:** Pencarian teks lengkap dengan filter tag dan tanggal.

            **Izin akses:** Kontrol akses berbasis peran yang detail di setiap tingkat.

            **Ekspor:** Ekspor halaman dan buku sebagai PDF, HTML, Markdown, atau teks biasa.

            ## Pengaturan awal

            1. Login dengan **admin@admin.com** / **password**
            2. Buka Pengaturan > Pengguna dan ubah email serta kata sandi admin

            ## Lisensi

            MIT — [GitHub](https://github.com/BookStackApp/BookStack)
    ja-JP:
        description: |
            BookStackはセルフホストのWikiプラットフォームで、情報の整理と保管に使用します。棚、本、章、ページのシンプルな構造を採用。WYSIWYGとMarkdownエディタ、全文検索、ロールベースの権限を搭載。
        variables:
            - key: PUBLIC_DOMAIN
              type: STRING
              name: ドメイン
              description: BookStackにアクセスするためのドメイン
        readme: |
            # BookStack

            セルフホストのWikiプラットフォーム。棚、本、章、ページの直感的な構造でドキュメントを整理。

            ## デプロイ後にできること

            ドメインにアクセスし、デフォルトの認証情報でログイン：**admin@admin.com** / **password**。初回ログイン後すぐに変更してください。

            **コンテンツ整理：** 棚で関連する本をグループ化し、章とページで論理的に整理。ドラッグ&ドロップで並べ替え。

            **編集：** WYSIWYG、Markdown、HTMLエディタから選択。画像、添付ファイル、コードブロック、draw.io図表をサポート。

            **検索：** すべてのコンテンツを横断した全文検索。

            **権限：** 棚、本、章、ページの各レベルで細かいロールベースのアクセス制御。

            **エクスポート：** PDF、HTML、Markdown、プレーンテキストでエクスポート。

            ## 初期設定

            1. **admin@admin.com** / **password** でログイン
            2. 設定 > ユーザーで管理者のメールアドレスとパスワードを変更

            ## ライセンス

            MIT — [GitHub](https://github.com/BookStackApp/BookStack)
    ko-KR:
        description: |
            BookStack은 셀프호스팅 위키 플랫폼으로, 정보를 체계적으로 정리하고 저장합니다. 선반, 책, 챕터, 페이지의 간단한 구조를 사용합니다. WYSIWYG 및 Markdown 에디터, 전문 검색, 역할 기반 권한을 지원합니다.
        variables:
            - key: PUBLIC_DOMAIN
              type: STRING
              name: 도메인
              description: BookStack에 접속할 도메인
        readme: |
            # BookStack

            셀프호스팅 위키 플랫폼. 선반, 책, 챕터, 페이지의 직관적인 구조로 문서를 정리합니다.

            ## 배포 후 할 수 있는 것

            도메인에 접속하여 기본 인증 정보로 로그인: **admin@admin.com** / **password**. 첫 로그인 후 즉시 변경하세요.

            **콘텐츠 정리:** 선반으로 관련 책을 그룹화하고 챕터와 페이지로 논리적 정리. 드래그 앤 드롭으로 재정렬.

            **편집:** WYSIWYG, Markdown, HTML 에디터 중 선택. 이미지, 첨부 파일, 코드 블록, draw.io 다이어그램 지원.

            **검색:** 모든 콘텐츠를 아우르는 전문 검색.

            **권한:** 선반, 책, 챕터, 페이지 각 수준에서 세밀한 역할 기반 접근 제어.

            **내보내기:** PDF, HTML, Markdown, 일반 텍스트로 내보내기.

            ## 초기 설정

            1. **admin@admin.com** / **password**로 로그인
            2. 설정 > 사용자에서 관리자 이메일과 비밀번호 변경

            ## 라이선스

            MIT — [GitHub](https://github.com/BookStackApp/BookStack)
    th-TH:
        description: |
            BookStack คือแพลตฟอร์มวิกิแบบ self-hosted สำหรับจัดระเบียบและจัดเก็บข้อมูล ใช้โครงสร้างง่ายๆ ของชั้นวาง หนังสือ บท และหน้า รองรับเอดิเตอร์ WYSIWYG และ Markdown การค้นหาข้อความเต็ม และสิทธิ์ตามบทบาท
        variables:
            - key: PUBLIC_DOMAIN
              type: STRING
              name: โดเมน
              description: โดเมนสำหรับเข้าถึง BookStack
        readme: |
            # BookStack

            แพลตฟอร์มวิกิแบบ self-hosted สำหรับจัดระเบียบและจัดเก็บข้อมูล โครงสร้างที่ใช้งานง่ายของชั้นวาง หนังสือ บท และหน้า

            ## สิ่งที่ทำได้หลังจากติดตั้ง

            เข้าสู่โดเมนของคุณและล็อกอินด้วยข้อมูลเริ่มต้น: **admin@admin.com** / **password** เปลี่ยนทันทีหลังล็อกอินครั้งแรก

            **จัดระเบียบเนื้อหา:** สร้างชั้นวาง หนังสือ บท และหน้า ลากและวางเพื่อจัดลำดับใหม่

            **แก้ไข:** เอดิเตอร์ WYSIWYG, Markdown หรือ HTML รองรับรูปภาพ ไฟล์แนบ บล็อกโค้ด และไดอะแกรม draw.io

            **ค้นหา:** ค้นหาข้อความเต็มรูปแบบข้ามเนื้อหาทั้งหมด

            **สิทธิ์:** ควบคุมการเข้าถึงตามบทบาทอย่างละเอียดในทุกระดับ

            **ส่งออก:** ส่งออกหน้าและหนังสือเป็น PDF, HTML, Markdown หรือข้อความธรรมดา

            ## การตั้งค่าเริ่มต้น

            1. ล็อกอินด้วย **admin@admin.com** / **password**
            2. ไปที่ตั้งค่า > ผู้ใช้ แล้วเปลี่ยนอีเมลและรหัสผ่านของผู้ดูแลระบบ

            ## สัญญาอนุญาต

            MIT — [GitHub](https://github.com/BookStackApp/BookStack)
    zh-CN:
        description: |
            BookStack 是自托管的维基平台，用于组织和存储信息。使用书架、书本、章节和页面的简单结构。支持所见即所得和 Markdown 编辑器、全文搜索、角色权限和多语言。
        variables:
            - key: PUBLIC_DOMAIN
              type: STRING
              name: 域名
              description: 访问 BookStack 的域名
        readme: |
            # BookStack

            自托管的维基平台，用于组织和存储信息。

            ## 部署后可以做什么

            打开域名并使用默认账密登录：**admin@admin.com** / **password**。首次登录后请立即更改。

            **内容组织：** 创建书架分组相关书本，使用章节和页面做逻辑分组。支持拖放重新排序。

            **编辑：** 所见即所得编辑器、Markdown 编辑器或 HTML 编辑器。支持嵌入图片、附件、代码块和 draw.io 绘图。

            **搜索：** 跨所有内容的全文搜索，支持标签和日期筛选。

            **权限：** 每个层级的精细角色权限控制。

            **导出：** 将页面和书本导出为 PDF、HTML、Markdown 或纯文本。

            ## 首次设置

            1. 使用 **admin@admin.com** / **password** 登录
            2. 进入设置 > 用户，更改管理员邮箱和密码

            ## 授权

            MIT — [GitHub](https://github.com/BookStackApp/BookStack)
    zh-TW:
        description: |
            BookStack 是自架的維基平台，用於組織和儲存資訊。使用書架、書本、章節和頁面的簡單結構。支援所見即所得和 Markdown 編輯器、全文搜尋、角色權限和多語言。
        variables:
            - key: PUBLIC_DOMAIN
              type: STRING
              name: 網域
              description: 存取 BookStack 的網域
        readme: |
            # BookStack

            自架的維基平台，用於組織和儲存資訊。使用書架、書本、章節和頁面的直覺結構來管理文件。

            ## 部署後可以做什麼

            開啟網域並使用預設帳密登入：**admin@admin.com** / **password**。首次登入後請立即更改。

            **內容組織：** 建立書架分組相關書本，使用章節和頁面做邏輯分組。支援拖放重新排序。

            **編輯：** 可選擇所見即所得編輯器、Markdown 編輯器或純 HTML 編輯器。支援嵌入圖片、附件、程式碼區塊，以及內建 draw.io 繪圖。

            **搜尋：** 跨所有內容的全文搜尋，支援標籤、日期和內容類型篩選。

            **權限：** 每個層級的精細角色權限控制——書架、書本、章節和頁面。

            **API：** RESTful API 用於程式化存取所有內容。

            **匯出：** 將頁面和書本匯出為 PDF、HTML、Markdown 或純文字。

            ## 首次設定

            1. 使用 **admin@admin.com** / **password** 登入
            2. 進入設定 > 使用者，更改管理員的電子郵件和密碼

            ## 授權

            MIT — [GitHub](https://github.com/BookStackApp/BookStack)
