Not released yet. PeltyCMS is under development and not released yet; these docs describe the upcoming release and may change.
PeltyCMS User docs
User docsDevelopers
v0.1.0

User docs/Administrator guide

Admin area map

Every page of the admin area, read from the navigation registry of the frontend (frontend/src/lib/navRegistry.ts) with the labels and descriptions you see in the app. Most categories also have a hub page that shows all of their pages as cards.

#Dashboard

PagePathWhat it is for
Dashboard/adminOverview, widgets and key numbers

#Clients

PagePathWhat it is for
Customers/admin/customersClient accounts and profiles
Users/admin/usersLogin users and access
Client groups/admin/client-groupsGroups, discounts and rules
Client fields/admin/client-fieldsCustom client fields
CSV import/admin/csv-importImport clients from CSV

#Billing

PagePathWhat it is for
Invoices/admin/invoicesInvoices, payments and PDFs
Transactions/admin/transactionsPayments and refunds log
Quotes/admin/quotesQuotes and proposals
Billing tools/admin/billing-toolsMass pay, merge, split and more
Overdue/admin/overdueReminders and late fees
Gift cards/admin/gift-cardsGift cards and balances
Billable items/admin/billable-itemsOne-off and recurring charges
Payment gateways/admin/gatewaysPayment gateways and fees
Taxes/admin/taxTax rules, VAT and OSS
Currencies/admin/currenciesCurrencies and exchange rates
Legal entities/admin/legal-entitiesIssuing companies

#Products & services

PagePathWhat it is for
Products/admin/productsCatalog, pricing and options
Services/admin/servicesActive client services
Orders/admin/ordersOrders and fraud review
Servers/admin/serversServers, groups and health
Marketplace/admin/marketplaceResell vendor products: sync catalogs, set markups, sell through the normal order flow.
Bundles/admin/bundlesProduct bundles
Order forms/admin/order-formsOrder form templates
Cancellations/admin/cancellationsCancellation requests
Usage metrics/admin/usage-metricsUsage-based billing metrics
Module queue/admin/module-queuePending module actions
Module log/admin/module-logModule call log

#Domains

PagePathWhat it is for
Domains/admin/domainsRegistrations, transfers and DNS

#Support

PagePathWhat it is for
Support tickets/admin/ticketsSupport tickets
Live chat/admin/live-chatLive chat with visitors
Content/admin/contentKnowledge base and announcements
Downloads/admin/downloadsDownloadable files
Email log/admin/email-logEvery email sent to clients, with content and resend
Network status/admin/network-statusNetwork status and incidents
Support settings/admin/support-settingsDepartments, piping and SLA
Calendar/admin/calendarRenewals, due dates and events
To-do/admin/todosStaff to-do list
Projects/admin/projectsClient projects with tasks, time tracking and billing
Verification/admin/kycReview customer identity documents (KYC)
Getting started/admin/getting-startedFirst-run setup checklist
My notes/admin/my-notesYour private notes
Noticeboard/admin/noticeboardNotices for all staff

#Marketing

PagePathWhat it is for
Mass mail/admin/campaignsMass mail and campaigns
Promo codes/admin/couponsPromo codes
Link tracking/admin/tracked-linksShort links that count clicks
Affiliates/admin/affiliatesAffiliates and commissions

#Website & content

PagePathWhat it is for
Website/admin/websitePublic pages, menu and footer
Themes/admin/themesThemes and branding

#Addons & integrations

PagePathWhat it is for
Addons/admin/addonsInstall modules and gateways
Plugins/admin/pluginsPlugins and hooks
API keys/admin/api-keysTokens for scripts and integrations to call the admin API
Developer docs/admin/developer-docsGenerated reference for the API, events and plugins
OAuth apps/admin/oauth-clientsOAuth / OIDC applications
SAML SSO/admin/samlSAML 2.0 identity providers

#Security

PagePathWhat it is for
Security/admin/securityCaptcha, SSO, IP rules, passwords
Staff & roles/admin/staffStaff and roles
Fraud/admin/fraudFraud checks
GDPR/admin/gdprGDPR exports and erasure
Login history/admin/login-historyLogin history
Sessions/admin/sessionsYour active sessions

#System & settings

PagePathWhat it is for
General settings/admin/general-settingsCompany, URLs, maintenance, locale
Mail (SMTP)/admin/mail-settingsSMTP and mail delivery
Email templates/admin/email-templatesEdit the wording of every automated email, per language
Translations/admin/translationsEdit any text per language
Notifications/admin/notificationsSlack, Discord and webhooks
Reports/admin/reportsReports and exports
System health/admin/system-healthSystem health checks
Jobs/admin/jobsBackground jobs and automation
Audit log/admin/auditWho changed what and when, across staff and clients
Backups/admin/backupsDatabase backups