// Knowledge base
Guides for SmashPanel
Install, DNS, the client portal, mail, files, staging, GitHub deploy and cPanel migration. Examples use example.com.
Getting started
- What SmashPanel is
Who the panel is for, and the three areas you sign in to.
- System requirements
The server, the domain and the ports you need before install.
- Install SmashPanel
The installer wizard, its flags, and how to resume a failed step.
- DNS records before you install
The names to create so the panel, mail and certificates can work.
- First login and two-factor authentication
Sign in as admin, enrol two-factor authentication, and optionally limit admin by IP.
- Post-install checklist
What to check after the installer finishes.
- Packages and limits
How plans limit domains, databases, mail and optional features.
Sites
- Add a hosting account
Create an account and see the containers, DNS zone and mail domain it gets.
- Client portal guide
A tour of the client area, and what has a separate login.
- Domains and SSL
Add a domain, prove you control it, and get a certificate.
- DNS hosting and nameservers
Delegate a domain, or keep DNS elsewhere and point an A record here.
- PHP version and web server
Which PHP versions ship with the panel, and NGINX versus Apache.
- Cron jobs
Five-field schedules that call your site over HTTP.
Mail, data and files
- Email with Mailcow
Mailboxes, webmail, client settings and deliverability records.
- Databases and Adminer
A MariaDB 11 server for the account, users, and Adminer.
- File manager and SFTP
The unique file-manager login and the account SFTP port.
Deploy
- Staging and GitHub deploy
Staging copies files only. GitHub deploys from a connected repository.
- Docker Compose for an account
Change the account stack from the client area, with safety checks.
Migration
- Migrate from cPanel
Backup upload, live SSH, the command-line import, and what does not move.
Resellers
- Resellers and white-label
Run your own packages and clients, with your name and logo in the client portal.
- Reseller API
Bearer keys, scopes, and the resources the API can change.
Security and help
- Security model
How accounts are separated, and the sign-in controls on the panel.
- VPN for customers
Give an account a VPN peer when the plan allows it.
- Troubleshooting
The usual reasons a certificate, login, cron job or install step fails.