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.
- 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)
- 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.
- Make sure Node.js and npm are installed
- Clone this repository in your Apache web directory:
$ git clone https://github.com/omeka/omeka-s.git
- Change into the Omeka S directory:
$ cd omeka-s
- Perform first-time setup:
$ npm install$ npx gulp init
- Open
config/database.iniand add your MySQL username, password, database name, and host name. The user and database must be created before this step. - Make sure the
files/directory is writable by Apache. - In your web browser, navigate to the omeka-s directory, where you can complete installation.
- Download the latest release from the release page (download the first asset listed)
- Open
config/database.iniand add your MySQL username, password, database name, and host name. The user and database must be created before this step. - Make sure the
files/directory is writable by Apache. - In your web browser, navigate to the omeka-s directory, where you can complete installation.
You can find Omeka-specific code under application/.
Make a backup copy of your entire site and its database!
git pullas usual. Use themasterbranch for the latest releases.- From the Omeka S root directory, run
npx gulp depsto make sure dependencies are up to date. - Compare changes in
/config/local.config.phpand/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 specific to your server, dev mode settings, etc.) - In your web browser, go to your site and run any migrations that are needed.
- Download the latest release from the release page
- Make a copy of your
/configdirectory. You will need to restore yourlocal.config.phpanddatabase.inifiles from that copy. - Make a copy of your
/modulesand/themesdirectories. - Make a copy of your
/filesdirectory. - Remove all Omeka S files, and replace them with the files from the updated zip file.
- Replace your original
/config/local.config.phpfile, and the/modules,/themes, and/filesdirectories that you copied. - In your web browser, go to your site and run any migrations that are needed.
Run npx gulp zip to create a zipped version of Omeka S and store it in /build. Use the --no-dev flag to omit Composer dev dependencies for a smaller package suitable for end-users. Official releases follow this same process from a new, clean checkout.
Omeka uses the following libraries, among others:
Omeka development adheres to the Laminas Coding Style Guide and uses the git-flow branching model and the Semantic Versioning 2.0.0 version scheme.
See the developer documentation for more information.
Omeka is Copyright © 2015-present Corporation for Digital Scholarship, Vienna, Virginia, USA http://digitalscholar.org
The Corporation for Digital Scholarship distributes the Omeka source code under the GNU General Public License, version 3 (GPLv3). The full text of this license is given in the license file.
The Omeka name is a registered trademark of the Corporation for Digital Scholarship.
Third-party copyright in this distribution is noted where applicable.
All rights not expressly granted are reserved.