Skip to the content
Documentation
Help Start
Reading in:
  • German: 9,110 of 9,110 pages
About the help in other languages
All help pages

Site packages in a bundle

How a bundle chooses, carries and installs a site package - what a site package is, the packages the 6.0.15 index offers, how each installer names the package, why a bundle should ship the exact .ezpkg files it tested…

Download as PDF

Address: https://doc.exponential.earth/exphelp/viewer/help/bundlers/site-packages-in-a-bundle.md

On this page

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

  1. What a site package brings
  2. Choosing a package
  3. Naming the package to the installer
  4. Ship the files you tested
  5. Your own site package
  6. 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 packageFor a bundle that ...
sevenx_multisiteshows Exponential with demo content: evaluations, demos, classrooms. It is the default of exp:install --package
sevenx_multisite_cleandelivers the same site empty, for a real site the recipient fills
cjw_multisitewants the CJW starter site with an English and a German site
sevenx_site, sevenx_site_cleanwants a simpler site
ezwebin_site, ezflow_site, ezdemo_site, plain_site (and _clean)must match older sites built on them
your owncarries 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

InstallerHow
exp:install--package=<name>
Kickstarterkickstart.ini, [site_types] Site_package=<name>
Setup wizardthe 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 .ezpkg files 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-run passes in the build.

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.

Something wrong on this page? Report an error

Documentation license

This documentation is free documentation, licensed under the GNU Free Documentation License 1.3 or later.

Exponential Copyright © 1998-2026 Exponential Foundation and 7x