Omeka S

Omeka S is a web publication system for universities, galleries, libraries, archives, and museums. It consists of a local network of independently curated exhibits sharing a collaboratively built pool of items, media, and their metadata.

See the user manual for more information.

Installation

Requirements

• Linux
• Apache (with AllowOverride set to "All" and mod_rewrite enabled)
• MySQL 5.7.9+ (or MariaDB 10.2.6+)
• PHP 7.4+ (latest stable version preferred, with PDO, pdo_mysql, and xml extensions installed)

Generating thumbnails

• The default library for generating thumbnails is ImageMagick, at least version 6.7.5. Older versions will not correctly produce thumbnails. For alternative thumbnail options, see the user manual.

Installing from GitHub

1. Make sure Node.js and npm are installed
2. Clone this repository in your Apache web directory:
   • $ git clone https://github.com/omeka/omeka-s.git
3. Change into the Omeka S directory:
   • $ cd omeka-s
4. Perform first-time setup:
   • $ npm install
   • $ npx gulp init
5. Open config/database.ini and add your MySQL username, password, database name, and host name. The user and database must be created before this step.
6. Make sure the files/ directory is writable by Apache.
7. In your web browser, navigate to the omeka-s directory, where you can complete installation.

Installing from released zip file

1. Download the latest release from the release page (download the first asset listed)
2. Open config/database.ini and add your MySQL username, password, database name, and host name. The user and database must be created before this step.
3. Make sure the files/ directory is writable by Apache.
4. In your web browser, navigate to the omeka-s directory, where you can complete installation.

You can find Omeka-specific code under application/.

Updating

Make a backup copy of your entire site and its database!

Updating from GitHub

1. git pull as usual. Use the master branch for the latest releases.
2. From the Omeka S root directory, run npx gulp deps to make sure dependencies are up to date.
3. Compare changes in /config/local.config.php and /config/local.config.php.dist. Some default configurations might have changed, so you might need to reconcile changes to the distributed configuration with your local configuration (e.g., a path to PHP speci