Skip to content
Omeka & Collection Platforms

To get started with Omeka S you install the application on a LAMP-style server (PHP 8.1+, MySQL/MariaDB, Apache with mod_rewrite), run the browser-based installer to create the admin user and database connection, then build your first item using a resource template before exposing it through a public site. The first-run loop takes about thirty minutes on a prepared host. The key mental shift is that Omeka S separates a shared pool of items from one or many public sites that present them.

What do you need before installing Omeka S?

Confirm your environment first, because most failed installs are environment problems, not software bugs:

  • PHP 7.4 minimum, 8.1 or later recommended, with the pdo_mysql, xml, and mbstring extensions enabled.
  • MySQL 5.7.9+ or MariaDB 10.2.6+, plus a dedicated empty database and a user with full privileges on it.
  • Apache with mod_rewrite (the bundled .htaccess depends on it) or an equivalent Nginx rewrite block.
  • ImageMagick installed and reachable, otherwise large image derivatives silently fail.

Check your PHP version and extensions in one command:

bash
php -v && php -m | grep -E 'pdo_mysql|xml|mbstring'

How do you install Omeka S step by step?

Download the latest release, unpack it into your web root, and set the database credentials before opening the installer.

bash
cd /var/www/html
curl -LO https://github.com/omeka/omeka-s/releases/latest/download/omeka-s.zip
unzip omeka-s.zip && cd omeka-s
cp config/database.ini.dist config/database.ini

Edit config/database.ini with your host, dbname, username and password:

ini
user     = "omeka_user"
password = "your-strong-password"
dbname   = "omeka_s"
host     = "localhost"

Then visit http://your-domain/omeka-s/install in a browser, enter the administrator email, password and a default site title, and submit. The installer writes the schema and logs you in.

How should you set up your first resource template?

Do not catalogue against the raw Dublin Core list. Go to Resource templates → Add new, name it (for example "Photograph"), and add only the properties you genuinely use: Title, Creator, Date, Description, Subject, Rights. Mark Title and Date as required. This keeps the item form short and forces consistency. You can attach a controlled vocabulary later via the Value Suggest or Custom Vocab modules.

How do you create your first item?

Go to Items → Add new, pick your template, and fill the fields. Attach media by URL, by upload, or by IIIF reference. Save, then assign the item to an item set so it is organised from the start rather than floating loose. A common first mistake is creating dozens of items with no item set, which makes later filtering painful.

Why don't my items show on the site yet?

Items belong to the installation pool, not to any site, until a site queries them. Create a site under Sites → Add new, then add a page with an Item showcase or Browse preview block whose query targets your item set. Items also stay hidden if the resource is marked non-public or the install is in maintenance mode under Settings.

Which modules are worth installing on day one?

ModuleWhy install early
CommonDependency for many other modules; install first
CSV ImportBulk-load items instead of hand-keying
Value SuggestLink Subjects/Creators to LCSH, VIAF, Getty
MappingPin items to coordinates for place-based collections
File SideloadIngest large media already on the server

Install modules by unzipping into modules/, then activate them under Modules in the admin.

Key Takeaways

  • Verify PHP, MySQL/MariaDB, mod_rewrite and ImageMagick before touching the installer.
  • Configure config/database.ini first, then run the browser installer at /install.
  • Build a lean resource template exposing only the fields you use; mark Title and Date required.
  • Items live in a shared pool; a site must query them before the public sees anything.
  • Assign items to item sets immediately to avoid an unorganised flat pile later.
  • Install CSV Import and Value Suggest early to save hours of manual entry.

Frequently Asked Questions

What server stack does Omeka S require?

Omeka S needs PHP 7.4 or newer (8.1+ recommended), MySQL 5.7.9+ or MariaDB 10.2.6+, and Apache with mod_rewrite. ImageMagick is strongly recommended so thumbnails generate correctly.

Is Omeka S free?

Yes. Omeka S is open-source software released under the GPLv3, so installation is free. Your only costs are hosting and your own time, or a paid plan if you use the hosted Omeka.net-style service.

What is the difference between a site and an item in Omeka S?

Items live in a single shared pool of resources at the installation level, while sites are public-facing presentations that draw from that pool. One item can appear on many sites without being duplicated.

Which resource template should I start with?

Begin with the built-in Dublin Core properties applied through a custom resource template that exposes only the fields you actually use, rather than the full vocabulary, to keep cataloguing fast and consistent.

How do I make my items appear on the public site?

Create a site, add a browse-preview or item-showcase block, and assign items to the item sets the site queries. Items are not public until a site surfaces them and the install is not in maintenance mode.

Can I migrate later from Omeka S to another platform?

Yes. Omeka S exposes a REST API and supports CSV export through modules, so your descriptive metadata and media references are portable rather than locked in.