Getting Started
Install SveltyCMS — the open-source Svelte CMS and headless CMS for SvelteKit. Set up the wizard, choose SQLite, PostgreSQL, MariaDB or MongoDB, and publish your first content.
On this page
Install SveltyCMS, then finish first-run setup in the wizard. The next page is the setup walkthrough. Every blueprint and validation rule is the setup wizard guide.
New to the product model? Read Concepts first — one page, six ideas — then come back and install.
SQLite is the default. It needs no separate database server. PostgreSQL, MariaDB, and MongoDB are available in the wizard when you want them.
Install
Scaffold
npx create-sveltycms@latest my-cms
cd my-cms
bun run dev
Templates match the wizard blueprints: website, blog, agency, saas, corporate, ecommerce. The default database is sqlite.
Clone
git clone https://github.com/SveltyCMS/SveltyCMS.git
cd SveltyCMS
bun install
bun run dev
Docker
docker run -d -p 4173:4173 -v svelty_data:/app/config ghcr.io/sveltycms/sveltycms:latest
Open http://localhost:4173. The image uses SQLite and writes the database and secrets to the svelty_data volume.
For the scaffold and the clone, open http://localhost:5173. A missing config/private.ts opens the wizard at /setup. Let the wizard create that file.
Production build and start commands are in Production deployment.
Open the wizard
The walkthrough is the setup wizard walkthrough. The six steps are:
- Database. SQLite, or host, port, name, and credentials for PostgreSQL, MariaDB, or MongoDB. Test the connection. Optionally enable Redis caching (and test it), and add regional read-replica connection strings under the advanced options.
- Admin account. Username, email, and a password of at least 8 characters, using upper case, lower case, a number, and a symbol.
- Project blueprint. Pick one blueprint; Website Starter is the recommended default. Country and prices appears only when you pick the E-commerce blueprint — the country starts on Germany and fills currency, shop language, and a suggested tax rate you can edit.
- System. Site name, production URL, timezone, languages, media storage, the collapsible Cloudflare CDN purge fields, then infrastructure mode (multi-tenant, demo).
- Email. Optional. You can set SMTP later.
- Review and complete. The wizard writes the admin user, the collections for that blueprint, and
config/private.ts, then signs you in.
After that, /setup sends you to /login, and /api/setup answers 403.
What you have
With Website Starter:
http://localhost:5173/(or port4173in Docker) shows the seeded homepage.- Pages contains Home, a legal page, and Privacy. The legal page title follows the country you picked. Replace that text and the privacy text before a public launch.
- Editing a page in the form is included. Inline editing on the live page is the Editable Website plugin (14-day trial). See Site starter.
The other blueprints are Blog, Agency, SaaS, Corporate, E-commerce, and Blank. What each card creates is the setup wizard guide. A card does not turn on the media library, the audit log, or multi-tenant mode — those exist on every install.
A store is the E-commerce blueprint, then the Commerce plugin in Extensions. Prices, the order button, and withdrawal are in E-commerce.
Next
- Setup wizard walkthrough — the six steps, short
- Setup wizard guide — fields, blueprints, and recovery
- Roles and permissions
- E-commerce