Site packages in a bundle
This page is for bundlers whose bundle installs a site, which is almost every bundle. The site an installer creates is built from a site package. The full reference is the Site packages section; this page is the bundler's view of it.
Contents
- What a site package brings
- Choosing a package
- Naming the package to the installer
- Ship the files you tested
- Your own site package
- Checklist
What a site package brings
"A package is a folder with a package.xml and the files it names, shipped as one gzip compressed tar file ending
in .ezpkg. A site package is a package of type site; it requires other packages (content classes, content) and
can carry install scripts that set up siteaccesses, extensions, roles and preferences"
(Site packages: start here).
The install scripts run inside CreateSites, whichever installer started the run; the "multi-site installer" of
sevenx_multisite "is therefore not a fourth install method: it is the site package's part of every install"
(4.3).
Choosing a package
The 6.0.15 package index offers twelve site packages (4.3):
| Site package | For a bundle that ... |
|---|---|
sevenx_multisite | shows Exponential with demo content: evaluations, demos, classrooms. It is the default of exp:install --package |
sevenx_multisite_clean | delivers the same site empty, for a real site the recipient fills |
cjw_multisite | wants the CJW starter site with an English and a German site |
sevenx_site, sevenx_site_clean | wants a simpler site |
ezwebin_site, ezflow_site, ezdemo_site, plain_site (and _clean) | must match older sites built on them |
| your own | carries your design and content model (Your own site package) |
"A _clean package installs the same structure without the demo articles and images: choose it for a real site you
will fill yourself, and the full one to evaluate Exponential."
Naming the package to the installer
| Installer | How |
|---|---|
exp:install | --package=<name> |
| Kickstarter | kickstart.ini, [site_types] Site_package=<name> |
| Setup wizard | the Site package page; it can be preselected by kickstart.ini |
Source: Pointing a site at your package server.
Ship the files you tested
By default the installers download the site package and its requirements from the package server named in
settings/package.ini [RepositorySettings] RemotePackagesIndexURL. For a bundle that is a moving part:
- "Packages in a release folder are fixed in place on the public server: the file name stays, the content changes" (Offline installs and mirrors). A bundle that downloads at install time can therefore install a newer package than the one you tested.
- "When a package exists in the installation, the site type step uses it instead of downloading it" (Kickstarter).
So a bundle that must install the same site every time ships the .ezpkg files it tested and imports them before the
install (Offline bundles), or points at a mirror it controls
(Your own package server). Record the checksum of every .ezpkg you ship.
Your own site package
The steps are in Making your own site package: fork a package, change classes,
content and the installer script, rebuild the .ezpkg, version it, test it in a sandbox. Before you ship it, meet the
documentation requirements: required package.xml fields, license,
changelog, versions, thumbnails, dependencies, validation.
7x and the Exponential Foundation "strongly encourage you to submit it by pull request to the repository behind the package server, so every installation can offer it" (Contribute your site package).
Checklist
- To do: The site package and every package it requires are chosen and their versions recorded.
- To do: The
.ezpkgfiles the bundle installs are the ones you tested (shipped, mirrored, or checked by checksum). - To do: Demo content is only in bundles meant for demonstration.
- To do: The package's license and the licenses of its images are known (Third-party components).
- To do: The package carries no user accounts with known passwords (Default credentials).
- To do:
exp:install --package=<name> --dry-runpasses in the build.
Related pages
- Site packages: start here
- Site packages for hosts
- Your own package server, Offline bundles
- Free documentation: this page is free to copy, translate and improve under the GNU FDL 1.3.
Become an Exponential Partner
Partners share their information, provide funding, contribute back and develop the products with us, and that is how Exponential grows. A partner website and dashboard are planned for mid-2027: please become a partner today to speed up our growth rate and land new features faster.