Core¶

The core:* commands download, install, update and inspect Omeka S itself. Together with config:create-db-ini they take a server from an empty directory to a working Omeka S installation.

Download Omeka S¶

core:download fetches an Omeka S release from GitHub, verifies it, and unpacks it into the destination directory. Without a version it downloads the latest release.

omeka-s-cli core:download /var/www/omeka-s

The destination must be empty, unless you pass --force. Add --create-destination to create a directory that does not exist yet. To pin a release, give its version number:

omeka-s-cli core:download /opt/omeka-s-4.1.1 4.1.1 --create-destination

Install the core from a release ZIP¶

Use a release ZIP you already have (a path or a URL) instead of downloading one:

omeka-s-cli core:download "$SCRATCH_DIR/omeka-s" --source "$CORE_ZIP" --create-destination

Configure the database connection¶

Omeka S reads its database credentials from config/database.ini. config:create-db-ini writes that file for the installation in the current directory:

cd /var/www/omeka-s
omeka-s-cli config:create-db-ini --host db --dbname omeka --username omeka --password "$DB_PASSWORD"

The database must exist and the user must be allowed to create tables in it. Pass the password from an environment variable or a secret store, so it does not end up in your shell history.

Install Omeka S¶

core:install runs the Omeka S installer: it creates the database tables, the administrator account, and the basic settings.

omeka-s-cli core:install \
    --title "Digital Collections" \
    --admin-name "Site Admin" \
    --admin-email admin@example.org \
    --admin-password "$ADMIN_PASSWORD" \
    --time-zone Europe/Brussels \
    --locale en_US

Check the status¶

core:status reports not_installed, needs_migration or installed. core:version prints the version of the code on disk (add --installed for the version recorded in the database).

omeka-s-cli core:status
omeka-s-cli core:version

installed
4.2.1

For scripts, the --is-installed, --needs-migration and --is-ready flags print nothing and answer through the exit code (0 for yes, 1 for no). That makes an installation step safe to re-run:

if ! omeka-s-cli core:status --is-installed; then
    omeka-s-cli core:install --admin-email admin@example.org --admin-password "$ADMIN_PASSWORD"
fi

--json gives the full status as an object:

omeka-s-cli core:status --json | jq -r '.needsMigration'

Update Omeka S¶

core:update replaces the Omeka S code with a newer release (the latest, unless you name a version) It replaces application/, vendor/ and the files in the root directory, and leaves config/, files/, logs/, modules/ and themes/ alone. A new release can change the database schema; core:migrate applies those changes, like the Update database button in the admin interface.

omeka-s-cli core:update
omeka-s-cli core:migrate

Work outside the Omeka S directory¶

Every command that operates on an installation finds it by looking at the current directory and its parents. From anywhere else, point to it with --base-path:

cd /tmp
omeka-s-cli core:version --base-path /var/www/omeka-s

Reference¶

All commands also accept the global options.

core:download¶

Download Omeka S core

omeka-s-cli core:download [options] <destination-path> [version-number]

config:create-db-ini¶

Create Omeka S database.ini configuration file

omeka-s-cli config:create-db-ini [options]

core:install¶

Install Omeka S

omeka-s-cli core:install [options]

core:status¶

Get Omeka S core status

omeka-s-cli core:status [options]

core:version¶

Get the downloaded Omeka S version

omeka-s-cli core:version [options]

core:update¶

Update Omeka S core

omeka-s-cli core:update [options] [version-number]

core:migrate¶

Upgrade Omeka S database if needed

omeka-s-cli core:migrate