Easy CMS v0.47
esc
    GitHub
    เนื้อหา › การตั้งค่า
    เริ่มต้น
    เนื้อหา
    การใช้เนื้อหา
    Plugins
    การดูแลระบบ
    สูตรสำเร็จ
    อ้างอิง
    เอกสาร/เนื้อหา/การตั้งค่า

    การตั้งค่า

    หน้านี้สอนอะไร

    ตัวเลือกทั้งหมดของ easy-cms.config.ts: ค่าระดับบนสุด collection, global, แบรนด์ และ plugin

    ควรอ่านก่อน: เริ่มใช้งาน

    ทุกอย่างเกี่ยวกับเนื้อหาของคุณอยู่ใน easy-cms.config.ts ที่ root ของโปรเจกต์:

    import { defineConfig, isAdmin } from '@easy-cms/core'
import { sqlite } from '@easy-cms/db-sqlite'
 
export default defineConfig({
  secret: process.env.EASY_CMS_SECRET ?? '',
  db: sqlite({ url: 'file:./cms.db' }),
  admin: { locale: 'th' },
  collections: [
    {
      slug: 'posts',
      drafts: true,
      useAsTitle: 'title',
      access: { read: () => true, update: isAdmin },
      fields: [
        { name: 'title', type: 'text', required: true },
        { name: 'body', type: 'richText' },
      ],
    },
  ],
  globals: [{ slug: 'site', fields: [{ name: 'siteName', type: 'text' }] }],
})

    defineConfig คืนค่า config เดิมโดยไม่เปลี่ยนแปลง และคง literal type ไว้เพื่อให้กำหนด type ของเอกสาร จาก config ได้ config จะถูกตรวจสอบตอนเริ่มทำงาน ปัญหาทั้งหมดจะถูกรายงานพร้อมกันในครั้งเดียว พร้อมบอกตำแหน่งและวิธีแก้ไข

    ตัวเลือกระดับบนสุด

    ตัวเลือกค่าเริ่มต้น
    secret—จำเป็น อย่างน้อย 32 ตัวอักษร ใช้ลงนาม session ควรอ่านค่าจาก env var
    db—จำเป็น database adapter: sqlite() หรือ postgres() ดู ฐานข้อมูล
    serverURL—origin สาธารณะ เช่น https://example.com ทำให้ URL ของ media เป็นแบบ absolute และเป็นที่ที่ลิงก์ตั้งรหัสผ่านชี้ไป (production ต้องตั้งถ้าจะใช้ลิงก์นี้)
    webhooks[]endpoint ที่จะได้รับแจ้งเมื่อเนื้อหาเปลี่ยนแปลง ดู Webhooks
    cronSecretCRON_SECRETให้ cron รันงานที่ตั้งเวลาไว้ที่ <api>/jobs/run ได้
    localization—{ locales, defaultLocale?, fallback? }: เนื้อหาหลายภาษา ดู หลายภาษา
    cors[]origin ที่โค้ดฝั่งเบราว์เซอร์เรียก REST API ได้ หรือ '*' สำหรับทุก origin (คำขอแบบไม่ระบุตัวตน) origin ใน auth.trustedOrigins ได้รับอนุญาตเสมอ พร้อม cookie
    routes.api/api/cmsตำแหน่งที่ให้บริการ REST API
    admin.path/adminตำแหน่งที่ให้บริการหน้า admin
    admin.localeenภาษาเริ่มต้นของหน้า admin: en หรือ th
    admin.siteUrl/ (Nuxt, Next.js)เว็บไซต์สาธารณะ สำหรับปุ่ม "ดูเว็บไซต์" ในหน้า admin: path หรือ URL แบบ https://
    admin.menuตามลำดับใน configลำดับ collection ในเมนูของหน้า admin ตาม slug เช่น ['posts', 'categories', 'media'] ที่ไม่ได้ระบุจะตามมา และคลังสื่ออยู่ท้ายสุด ส่วนผู้ใช้อยู่ในหมวดตั้งค่า
    admin.brand—{ name, logo, color }: แบรนด์ของคุณหรือลูกค้าในหน้า admin ดูใส่แบรนด์ให้หน้า admin
    admin.modules[]ไฟล์ JavaScript ที่มี Web Components สำหรับหน้า admin ระบุเป็น export ของแพ็กเกจหรือ path ส่วนใหญ่ plugin เป็นคนเพิ่มให้
    authดู ผู้ใช้และการยืนยันตัวตน
    uploadดู การอัปโหลดและ media
    collections[]ดูด้านล่าง
    globals[]ดูด้านล่าง
    endpoints[]REST endpoint ของคุณเอง: { path, method, handler } ดู Plugins
    plugins[]ฟังก์ชัน (config) => config ทำงานตามลำดับก่อนการตรวจสอบ ดู Plugins

    Collections

    collection คือประเภทของเนื้อหาที่มีเอกสารได้หลายรายการ เช่น โพสต์ สินค้า หน้าเว็บ

    ตัวเลือก
    slugชื่อ URL และชื่อตาราง: อักษรตัวพิมพ์เล็ก ตัวเลข - _
    fieldsfield ทั้งหมด
    labels{ singular, plural } แต่ละค่าเป็น string หรือ { en, th }
    useAsTitlefield ระดับบนสุดที่แสดงเป็นชื่อเอกสารในหน้า admin
    editIn'drawer': สร้างและแก้ไขในแผงเลื่อนทับหน้ารายการ เหมาะกับ collection เล็กอย่างหมวดหมู่ และช่อง relationship ที่ชี้มาจะมีปุ่ม "สร้าง" ที่เปิดแผงเดียวกัน ส่วน collection ที่มี drafts, versions หรือ preview จะใช้หน้าเต็มเสมอ
    admin{ group: 'settings' } แสดง collection ใต้ตั้งค่าในเมนู (คู่กับ Users และ API keys) แทนที่จะอยู่กับเนื้อหา ส่วน { sidebar } เพิ่มadmin components และ { list: { tree: 'parent', sort: 'title' } } แสดงรายการเป็นต้นไม้ตาม relationship ไปหา collection เดียวกัน พร้อมกำหนดลำดับเริ่มต้น
    iconไอคอนในเมนูของหน้า admin (ค่าเริ่มต้น file-text) เลือกจากรายชื่อในใส่แบรนด์ให้หน้า admin
    draftsเพิ่ม status (draft | published) ดู ฉบับร่าง (draft)
    versionstrue หรือ { max }: เก็บเวอร์ชันของการบันทึกทุกครั้ง พร้อมประวัติและการกู้คืน ถ้ามี drafts ด้วย ฉบับร่างของเอกสารที่เผยแพร่แล้วจะถูกเก็บแยก ดู เวอร์ชัน
    preview({ doc }) => url: หน้าที่แสดงเอกสาร สำหรับ ตัวอย่างสด
    admin.sidebarกล่องจาก admin components ในแถบข้างของหน้าแก้ไข
    scheduleเผยแพร่และยกเลิกการเผยแพร่ตามเวลาที่ตั้งไว้ (ต้องมี drafts) ดู การตั้งเวลาเผยแพร่
    access{ read, create, update, delete } ดู การควบคุมสิทธิ์
    hooksดู Hooks

    เอกสารทุกรายการมี id (integer), createdAt และ updatedAt ด้วย

    มี collection ในตัวสองรายการ: users และ media ประกาศ collection ที่ใช้ slug เดียวกันเพื่อเพิ่ม field กฎสิทธิ์ หรือ hook ให้กับ collection เหล่านี้

    slug ที่สงวนไว้: admin, globals, jobs, sessions, login-attempts, document-versions, scheduled-jobs, migrations, access

    Globals

    global มีเอกสารเพียงรายการเดียวเท่านั้น เช่น การตั้งค่าเว็บไซต์ เมนูนำทาง footer

    globals: [
  {
    slug: 'site',
    label: { en: 'Site settings', th: 'ตั้งค่าเว็บไซต์' },
    access: { read: () => true },
    fields: [
      { name: 'siteName', type: 'text', defaultValue: 'My site' },
      { name: 'menu', type: 'array', fields: [{ name: 'label', type: 'text' }, { name: 'url', type: 'text' }] },
    ],
  },
],

    global รองรับ fields, label, icon, drafts, versions, preview, admin, access (read, update) และ hooks (beforeChange, afterChange, afterRead)

    ใส่แบรนด์ให้หน้า admin

    agency แสดงแบรนด์ของลูกค้าแทน Easy CMS ได้:

    admin: {
  brand: {
    name: 'Acme Coffee',     // เมนู หน้าเข้าสู่ระบบ และแท็บของเบราว์เซอร์
    logo: '/acme-logo.svg',  // path บนเว็บของคุณ หรือ URL แบบ https://
    color: '#b45309',        // สีหลัก เฉดสว่างและเข้มจะคำนวณให้เอง
  },
},
collections: [
  { slug: 'posts', icon: 'newspaper', fields: [/* … */] },
  { slug: 'menu', icon: 'utensils', fields: [/* … */] },
],
globals: [{ slug: 'site', icon: 'house', fields: [/* … */] }],

    ตัวอักษรบนสีแบรนด์จะเปลี่ยนเป็นสีเข้มเมื่อสีขาวอ่านยาก ผู้ใช้แต่ละคนเลือกธีมสว่าง มืด หรือตามระบบได้จากเมนู

    ไอคอน (Lucide): file-text, newspaper, book-open, notebook, folder, tag, tags, image, images, video, music, file, users, user, building, store, shopping-bag, shopping-cart, package, box, calendar, calendar-days, map-pin, globe, house, layout-grid, layers, star, heart, message-square, mail, phone, briefcase, graduation-cap, utensils, car, settings, sliders-horizontal, palette, megaphone, bell, link, quote, circle-help, award, ticket, camera, key, chart-column, chart-line

    Plugins

    plugin รับ config เข้ามาและคืนค่า config ใหม่ จึงเพิ่ม field, collection, endpoint และ admin components ได้:

    import { seoPlugin } from '@easy-cms/plugin-seo'
 
export default defineConfig({ /* … */ plugins: [seoPlugin({ collections: ['posts'] })] })

    ดู plugin ทางการและวิธีเขียน plugin เองได้ที่ Plugins

    ขั้นต่อไป

    แก้ไขหน้านี้บน GitHubEasy CMS v0.47