Installing

System requirements

In order to install Omeka S, you will need a server running the following:

  • Linux
  • Apache (with AllowOverride set to "All" and mod_rewrite enabled)
  • MySQL, minimum version 5.6.4 (or MariaDB, minimum version 10.0.5)
  • PHP, minumum version 7.2, with PDO, pdo_mysql, and xml extensions installed
  • Optional, to create thumbnails: ImageMagick version 6.7.5 or greater, the PHP imagick extension, or the PHP gd extension.

GD is a basic graphic library installed by default with PHP. It can create thumbnails for common image formats only (jpeg, gif, png). Imagick and ImageMagick are the same library and can create thumbnails for more than 200 formats. For more information, see the Configuration page.

Installation methods

Installing from download

Note

Before you install Omeka S, you need to create a MySQL database and user. Omeka S must have a dedicated database; you cannot use a prefix for a database used by another system or Omeka S or Classic installation. For more information on creating a database and user, please see your hosting's support documentation or talk to your system administrator.

  1. Download the latest release from the release page.
  2. Extract this downloaded zip file to your computer.
  3. Inside the directory, open the config/database.ini file and add your MySQL username, password, database name, and host name. The user and database must be created before this step.
  4. Upload this entire directory to your server, into the folder of your choice. For example, if your server is https://yourwebsite.org/, you may wish to install Omeka S into a folder located at https://yourwebsite.org/myomekas/. Make sure it has your updated database.ini file (do not upload the original zip file you downloaded).
  5. Make sure the files/ directory on the server is writable by Apache.
  6. In your web browser, navigate to the admin page for your Omeka S installation, where you can complete the installation. For example, if you uploaded the directory contents to https://yourwebsite.org/myomekas/, then navigate to https://yourwebsite.org/myomekas/admin.

Installing from GitHub

Basic instructions for installing and updating from GitHub can be found in the ReadMe of the Omeka S GitHub repository.

Then, in your web browser, navigate to the admin page for your Omeka S installation (https://yourwebsite.org/myomekas/admin), where you can complete the installation.

One-click installation

Hosting companies that use Softaculous should offer a one-click install of Omeka Classic and Omeka S. The one-click installation process through Softaculous may allow you to create a database and user at the same time, and will edit the config/database.ini file for you.

Suggestions from our users include:

Initial setup

Once you have successfully installed Omeka S and configured the database.ini file, you must navigate to the admin URL of your Omeka S installation (something like https://yourwebsite.org/myomekas/admin).

The first time you point your browser to the newly installed site, you will need to enter information for the first user, along with basic information for your install. There are two sections on this page: Create the first user and Settings.

In the Create the first user section:

  • Enter an email address, and type again to confirm
  • Confirm the password and type again in the next input to confirm
  • Enter a display name for the user.

Note that you can change all of these later in the User management section of your install.

First user section with fields as described

In the Settings section, enter:

  • An installation title which will display on the admin site
  • The installation's time zone (select from dropdown)
  • select a locale for the language of the admin side of the installation.

Settings section with fields as described

You can changes these at any time in the in the Settings section of your admin dashboard.

Test and set the PHP path

Omeka S uses background jobs for some long-running tasks that operate on many items or just otherwise might take a long time. Omeka S uses the PHP CLI (command-line interface) to run these jobs, the php command. An invalid PHP path can cause a number of problems for your Omeka Classic installation.

Omeka S by default will try to automatically detect the path to the PHP CLI on the server, but for some servers this detection doesn't work, or there are multiple different php commands to choose from.

If you are using Reclaim Hosting, you will have to manually set the PHP path when you install. See their instructions here.

If you begin to see errors once you start working with Omeka, particularly errors with something like "PHP-CLI error: invalid PHP path", you will need to manually set the PHP path. See Configuration Options to learn about modifying thumbnail generation, setting the PHP path manually, and more.

Note

If you have an existing Omeka Classic or S installation, you may wish to look at modules such as the Omeka Classic Importer, the Omeka S Item Importer, or the CSV Import module, which can help you copy other types of data.

Updating

Updating manually

  1. Download the latest release from the release page.
  2. Make a copy of your /config directory. You will need to restore your local.config.php and database.ini files from that copy.
  3. Make a copy of your /modules and /themes directories.
  4. Make a copy of your /files directory.
  5. Remove all Omeka S files, and replace them with the files from the updated zip file.
  6. Replace your original /config/local.config.php and /config/database.ini file, and the /modules, /themes, and /files directories that you copied.
    • For significant version updates, you may also have to install an updated version of your modules and themes. The release notes for the version will indicate whether or not those updates will be likely. Additionally, once you complete your migrations using your browser, the modules and themes that require new versions will be clearly marked on their respective pages.
  7. In your web browser, go to your site's admin page (/myomekas/admin) and run any migrations that are needed.

Updating from GitHub

Basic instructions for installing and updating from GitHub can be found in the ReadMe of the Omeka S GitHub repository.

Install on Windows or Mac OS (development only)

Omeka S does not support proprietary or closed-source operating systems. However, for basic development purposes or for quick training, Omeka can run with WAMP, MAMP, or similar tools.

Follow the standard installation instructions. You will need to make the following configuration changes to the file config/local.config.php to work.

First, the PHP path may need to be set if Omeka S cannot automatically detect the location of your PHP utilities on your local server. Open the local.config.php file and look for line 12:

    'cli' => [
        'phpcli_path' => null,
    ],

Fill out the phpcli_path value with the appropriate path for your operating system. For example, if you are using a MAMP environment, you may find the PHP utilities inside the MAMP installation folder at MAMP\bin\php\php7.

Second, you need to configure Omeka S to use the thumbnail-generating utility available on your local server. Open the local.config.php file and look for the following section:

    'service_manager' => [
        'aliases' => [
            'Omeka\File\Store' => 'Omeka\File\Store\Local',
            'Omeka\File\Thumbnailer' => 'Omeka\File\Thumbnailer\ImageMagick',
        ],
    ],

Edit the Omeka\File\Thumbnailer value to the following, based on what is available for your system:

  • Replace the default thumbnailer with Omeka\File\Thumbnailer\Gd.
  • Replace the default thumbnailer with Omeka\File\Thumbnailer\Imagick, and enable Imagick in the file php.ini of your server via the server admin interface or directly in the file.
  • Keep the default thumbnailer Omeka\File\Thumbnailer\ImageMagick, but install the command line tool imagemagick and change the imagemagick_dir value to its directory. To install imagemagick, see the documentation of your server.

If you see the error no input file specified, you may need to edit the .htaccess file. Comment out line 8, RewriteRule !\.(php[0-9]?|phtml|phps)$ - [NC,C]. You may also need to comment out the lines following the block comment at line 17 ( “The following rewrites”) and replace them with RewriteRule ^(.*)$ index.php.