Docs
The in-app guide
This is the same guide as Admin → Help: usage, each admin screen, themes, tags, environment, and install.
This walks through every admin screen. Each module also has a one-line hint at the top. Start with Getting started; skins are under Themes.
Overview
| Screen | What it does |
|---|---|
| Dashboard | Pending entries, unread inbox, comments to review. Shortcut tiles can be edited on the dashboard. |
| Analytics | Front PV / UV / IP, popular pages, referrers, and spider hits. Admin paths are not counted. |
Content
| Screen | What it does |
|---|---|
| Entries | Write articles. “Publish entries” is required to publish; editors save drafts or pending items. Supports scheduled publish, preview links, and restoring the previous draft. One primary section sets the URL; extra sections are optional. |
| Sections | Channel tree. List, single page, or external link. Bind a model. You can set list/show templates. |
| Tags | Tags on entries; the front aggregates at /tag/slug. Not the same as Help → Tags (template directives). |
| Media | Upload images and files. Body images and block covers are picked here too. Without a public/storage symlink, the site serves /storage itself — php artisan storage:link is optional. To change only the public host, set CDN under Settings → More. To store files on OSS / S3, set CMS_MEDIA_DISK — see Environment. Watermarks run on the local disk only. |
| Inbox | Form submissions. Mark read, add notes, reply by email. |
| Comments | Pending by default; approved comments show under the entry. Switches and notify email are in Settings. |
| Trash | Deleted entries land here. Restore, or delete forever. In the sidebar it sits under Content → More; the entries list also has a button. |
| Flags | Checkboxes on entries (e.g. headline). Filter with @cmsContent(['flag' => 'flag-slug']). |
| Blocks | Home banners and similar. The identifier must match @cmsAdv(['name' => 'home_banner']). Fill items by hand or pull entries by rule. Hand-filled items can pick an image from the media library and preview it before save. Friend links are under Operations → More. |
| Models | Fields for a content type (price, files, …). Copy or export/import JSON without deleting entries. “Allow member posts” lets members write this type. |
| Menus | Header menus. Location such as header must match @cmsMenu. If none exist, sections marked “menu” are used. |
| Forms | Contact form fields. Slug goes to @cmsForm(['slug' => 'contact']). Submissions go to Inbox. |
Operations
| Screen | What it does |
|---|---|
| Members | Front registrants. Can be disabled. Posts and favorites live in the member area. |
| Collectors | Pull public RSS, JSON, or HTML lists into a section. Test first, then enable. Only sources you may use; no intranet crawling. Cron is required for auto runs — see Schedule. |
| Cache | Full-page cache and disk HTML under public/html/. Generating or deleting many files is batched, with a progress bar. Top-right “Clear cache” clears views/config and stored pages. nginx is under Environment. |
| Friend links | Homepage friend links / partners — under Operations → More. Not the nav theme’s URL directory. Stored as the partners block (or friend_links). Themes output them with @cmsAdv(['name' => 'partners']). |
| Sitemap | URL list for search engines — under Operations → More. XML at /sitemap.xml, HTML at /sitemap. Toggle sections / entries / tags, and add extra URLs. Member-gated entries and unused tags are skipped. robots.txt lists every language’s XML. |
| Redirects | 301/302 from old paths. Per site, with hit counts. Disabling keeps the rule but stops jumping. |
| Groups | Member capabilities (e.g. contribute). Disabling a group turns off those front rights; people stay in the list. |
System
| Screen | What it does |
|---|---|
| Sites | One site per domain; content is isolated. Switch in the top bar. New sites copy settings, not content. The default site cannot be deleted; deleting a site deletes its content. |
| Settings | Site name and keywords. Look: logo, color, footer. Comment rules and SMTP. Admins can reset passwords on the login page. More: URL format, extra robots.txt rules, mobile theme, backup, API token, CDN. The object-storage disk is not in this form — see Environment. |
| Themes | Open a skin to configure its phrases, models, and cms_theme() options. “Use on this site” adds missing models and does not edit existing entries. Details in Themes. |
| Languages | Three separate things: content languages (entry fields, /en prefix), admin UI (sidebar EN/ZH), theme phrases (Search, Log in, Comments — cms_ui('search')). Menus and blocks get inputs per language. Coverage only counts titles actually filled. Disabling a language does not delete translations. Saving languages or theme phrases clears page cache and disk HTML. |
| Logs | What admins did: which entry, bulk actions, logins and IP. IPs are labeled local, Docker LAN, or public region. Click an IP to filter. Static-page progress pings are not logged. This is not a revision history. |
| Account | Click your name in the top right. Change display name and password. |
| Admins | Admin accounts, roles, which sites they may edit. Can limit to certain sections. |
| Roles | Module permissions. Super admin can do everything and cannot be deleted. “Publish entries” is separate — without it, publish is blocked. |
| Help | This page. Every account can open it, so it stays at the bottom of System instead of Operations → More. |
A missing sidebar item is a permission gap, not a missing feature. Template tags are under Tags.