Sites¶

The site:* commands create, update and delete the public sites of an Omeka S installation, and manage which users may work on them. They do not manage a site's pages, navigation or item pool; do that in the admin interface.

A command that acts on an existing site takes its ID or slug (1 or collections). A slug may consist of digits only; such a value is tried as both. If it is the ID of one site and the slug of another, the command stops with an error and asks you to name the site another way. Users are given by ID or email address, as with the user:* commands.

Add a site¶

site:add takes the title of the site. Set the slug, the part of the URL after /s/, with --slug; it may contain letters, digits, _ and -.

omeka-s-cli site:add "Digital Collections" --slug collections --theme freedom --default

Without --theme the site uses the default theme that ships with Omeka S. Any other theme must be downloaded first, with theme:download; an unknown theme is refused. --default makes the new site the default site: the site that visitors see at the root URL of the installation.

By default a site is public, its owner is the first active global administrator, and new items are added to it automatically. Each of these can be changed:

omeka-s-cli site:add "Staff Intranet" --slug intranet --private \
    --summary "Internal documentation for the cataloguing team" \
    --owner jane.doe@example.org --no-assign-new-items

--private hides the site from visitors; only its owner, users with a permission on it and users with the global_admin or site_admin role can see it. --owner makes another user the owner and gives that user the admin role on the site, instead of the administrator. --no-assign-new-items stops newly created items from being added to the site.

Add sites in a script that runs more than once¶

site:add refuses a site that already exists. With --slug, that is a site with the same slug. Without it, Omeka S derives the slug from the title (Exhibitions becomes exhibitions), and a site with the same title (ignoring case) counts as existing. --ignore-existing turns the error into a warning with exit code 0:

omeka-s-cli site:add "Exhibitions" --ignore-existing

The existing site is not changed. Use site:update to bring it in line.

List sites¶

omeka-s-cli site:list

Found 3 site(s).
+----+-------------+---------------------+---------+-----------+------------+----------------------+
| Id | Slug        | Title               | Theme   | Is Public | Is Default | Owner                |
+----+-------------+---------------------+---------+-----------+------------+----------------------+
| 1  | collections | Digital Collections | freedom | yes       | yes        | admin@example.org    |
| 2  | intranet    | Staff Intranet      | default | no        | no         | jane.doe@example.org |
| 3  | exhibitions | Exhibitions         | default | yes       | no         | admin@example.org    |
+----+-------------+---------------------+---------+-----------+------------+----------------------+

--csv and --json give the same data in a form other tools can read. For example, the slug of the default site:

omeka-s-cli site:list --json | jq -r '.[] | select(.is_default) | .slug'

Change a site¶

site:update changes only what you pass: here the title and the visibility. The summary, theme, owner, pages, navigation and permissions of the site stay as they are.

omeka-s-cli site:update intranet --title "Cataloguing Handbook" --public

The options are --title, --slug, --summary (an empty value clears it), --theme, --public/--private and --assign-new-items/--stop-assigning-new-items. --default makes the site the default site:

omeka-s-cli site:update exhibitions --slug exhibits --default

Changing the slug changes the URLs of the site and all its pages; links to the old URLs break. Without any option, site:update does nothing. Add --json to print the updated site.

Manage who can work on a site¶

Besides their global role, users can have a role on a site: viewer (may see a private site), editor (may also add, edit and delete its pages) or admin (may also change its settings, navigation and permissions). site:set-permission gives a user a role on a site:

omeka-s-cli site:set-permission collections jane.doe@example.org editor
omeka-s-cli site:set-permission collections john.roe@example.org viewer

site:list-permissions shows who has which role:

omeka-s-cli site:list-permissions collections

Found 3 permission(s).
+---------+----------------------+--------------+--------+
| User Id | Email                | Display Name | Role   |
+---------+----------------------+--------------+--------+
| 1       | admin@example.org    | Admin        | admin  |
| 2       | jane.doe@example.org | Jane Doe     | editor |
| 3       | john.roe@example.org | John Roe     | viewer |
+---------+----------------------+--------------+--------+

For a user who already has a permission, site:set-permission changes the role. Giving a user the role they already have only prints a warning, so the command is safe to re-run.

omeka-s-cli site:set-permission collections jane.doe@example.org admin

site:delete-permission takes a user's permission away:

omeka-s-cli site:delete-permission collections john.roe@example.org

Delete a site¶

site:delete deletes a site with its pages. The items and item sets in it are kept. If it was the default site, the installation no longer has one.

omeka-s-cli site:delete exhibitions
omeka-s-cli site:delete intranet --ignore-not-found

Deleting a site that does not exist is an error; with --ignore-not-found the command prints a note and exits with 0. site:delete-permission and site:update accept the same option.

Reference¶

All commands also accept the global options.

site:add¶

Add a new site

omeka-s-cli site:add [options] <title>

site:list¶

List all sites

omeka-s-cli site:list [options]

site:update¶

Update site details

omeka-s-cli site:update [options] <site>

site:delete¶

Delete a site, with its pages

omeka-s-cli site:delete [options] <site>

site:set-permission¶

Give a user a role on a site (adds the permission or changes its role)

omeka-s-cli site:set-permission <site> <user> <role>

site:list-permissions¶

List the user permissions of a site

omeka-s-cli site:list-permissions [options] <site>

site:delete-permission¶

Remove a user's permission on a site

omeka-s-cli site:delete-permission [options] <site> <user>