Install & requirements
Check the runtime, point the document root at public/, run the installer and secure the result.
ShopKeeprr Documentation
Build it. Run it.
Make it yours.
The canonical documentation home for ShopKeeprr — the self-hosted commerce platform you install, own and extend. Start with the essentials, then go as deep as your store needs.
Start here
Four places to begin.
ShopKeeprr is a self-hosted platform: the storefront, admin and extension system run on your server. The Store handles purchases, account access and release downloads.
Account, licenses & downloads
One ShopKeeprr Store account holds your orders, license keys and release downloads.
Understand your accountUpdates & releases
Signed manifests, one-click updates and the release history for your licensed installation.
How updates workBuild for ShopKeeprr
Package modules, themes and storefront components with the public developer reference.
Explore the extension modelInstallation
Give it a clean home.
ShopKeeprr is a Laravel application. Serve it from its own document root, with HTTPS and a database you control, and keep the application files outside anything a visitor can browse.
Before you begin
- PHP 8.3 or newer with OpenSSL, PDO, ZIP, mbstring, fileinfo, tokenizer, DOM and cURL.
- MySQL or MariaDB for a production store; SQLite is useful for a local demo.
- A writable
storage/directory and writablebootstrap/cache/. - A domain and TLS certificate. Run checkout and account pages over HTTPS.
The short version
Upload the release, point the host at the public/ directory, create the database, then open the browser installer. The installer writes the environment file, creates the administrator, seeds the storefront and generates the license keypair. When it finishes, remove the public installer.
Keep the license signing key. Back it up with the rest of your deployment secrets. Losing it invalidates tokens already issued to licensed installations.
Full packaging and release notes are included with your ShopKeeprr download. The Store account area is the canonical place to retrieve the current release.
Identity, licenses and downloads
One account. The whole shop.
ShopKeeprr Store is the customer identity for the platform. Your account holds orders, license keys, activation limits and release downloads. The official site and this documentation do not create separate customer accounts.
Licensing, without holding your store hostage
Licensing gates updates and downloads only. If the license service is temporarily unavailable, an installed store keeps running. A previously issued signed token covers a short grace window while the service recovers.
- Activate a license against the domain and installation where it will run.
- Use the account area to review activations, licenses and available downloads.
- Deactivate an old domain before moving the installation to a new one.
Updates and releases
Move forward with a way back.
ShopKeeprr updates are delivered as signed releases from the Store. The update flow verifies the manifest before it changes the installation, takes a backup and can roll back if the new release cannot complete.
| What | Where | Why it matters |
|---|---|---|
| Current release | Your Store account → Downloads | Always retrieve the licensed package, not a forwarded copy. |
| Release notes | Store product and release pages | Check compatibility and changes before updating. |
| Checksum | Release metadata | Verify the package is exactly the one that was published. |
The ShopKeeprr 1.0.0 release is unaffected by the marketplace launch. Existing 1.0 stores keep their current code, catalog and customer history; updates are a separate, deliberate action.
Extend the platform
Build once. Extend everything.
ShopKeeprr has three extension surfaces: modules for real store capabilities, themes for complete storefront presentations, and components that add sections to the visual storefront builder.
Modules
A module lives in modules/{slug} and is described by module.json. It runs with the same privileges as the store, so keep it small, auditable and free of unrelated dependencies. Declare the ShopKeeprr and PHP versions you support.
Themes and components
Themes change presentation without taking over checkout logic. Components are modules of type component that register a new section for the builder. Both are packaged, scanned and released through the Store.
Support
Need a hand?
Include your domain, ShopKeeprr version and, where relevant, your license key suffix and the release you are using. Never send a private signing key or full license key by email.