Adminer Database Manager (module for Omeka S)

New versions of this module and support for Omeka S version 3.0 and above are available on GitLab, which seems to respect users and privacy better than the previous repository.

Adminer Database Manager is a module for Omeka S that allows to view and manage a MySQL database. It uses Adminer, formerly phpMinAdmin, a one file full-featured database management tool written in PHP.

It is highly recommended to create a read-only user to use it, because it’s very easy to break a database, even for people who know the Omeka code perfectly. Anyway, see the warning below: always save your files and your database automatically and regularly, and before risky and non-risky commands.

Installation

See general end user documentation for installing a module.

The module uses a pre-compiled version of Adminer to access the database. The compiled files are downloaded automatically via the Composer plugin sempia/external-assets.

• Via composer (recommended)

When installed via composer (either directly or from the Omeka S root), the pre-compiled Adminer files are downloaded automatically into asset/vendor/ during composer install or composer update.

• From the zip

Download the last release [Adminer.zip] from the list of releases and uncompress it in the modules directory.

• From the source and for development

If the module was installed from the source, rename the name of the folder of the module to Adminer, go to the root of the module, and run:

composer install --no-dev

The module includes a comprehensive test suite with unit and functional tests. Run them from the root of Omeka:

vendor/bin/phpunit -c modules/Adminer/phpunit.xml --testdox

• Recompiling Adminer

When upgrading to a new version of Adminer, the compiled files must be rebuilt and published as a release archive. A build script is provided:

cd modules/Adminer
bash data/scripts/compile-adminer.sh --archive

The script fetches the latest Adminer version automatically, clones the Adminer repository with its submodules (JsShrink, jush, PhpShrink), patches the source for Omeka compatibility, compiles self-contained php files, and packages plugins, designs, and css theme into a distributable tar.gz in build/. A fixed version can be set instead by uncommenting ADMINER_VERSION at the top of the script. Upload the archive as a release asset and update the url in composer.json (extra.external-assets).

• Specific plugins and theme

To install specific plugins, copy them in asset/vendor/adminer/adminer-plugins/. Note that they may be removed if assets are re-downloaded.

To change the default theme, copy a CSS file as asset/vendor/adminer/adminer.css. Note that it may be overwritten if assets are re-downloaded.

Usage

Just fill the config and create a read only user.

If the omeka database user has the rights to create a user and to specify privileges, the read only user will be automatically created.

Else, you can run this query in the database, modifying the user name ("readonly" here), the host (generally "localhost" or "127.0.0.1"), the password, and the database name ("omeka" here).

CREATE USER 'readonly'@'localhost' IDENTIFIED BY 'a very long password';
GRANT SELECT ON `omeka`.* TO 'readonly'@'localhost';
GRANT SHOW VIEW ON `omeka`.* TO 'readonly'@'localhost';
FLUSH PRIVILEGES;

TODO

• [x] Remove the login page (login directly).
• [x] Use composer package vrana/adminer (to minify and remove from vendor for security). Now uses pre-compiled archive via sempia/external-assets.
• [x] Allow to use any adminer.css theme simply by putting it in a directory.
• [x] Give the choice to use the simplified version "adminer editor" (finalize theme).
• [x] Fix the warning when changing theme on the first page. The issue is related to the load of the minified js. It is related to the auth process (with or without login form, that may reset token. See adminer/include/auth.inc.php).
• [ ] Remove access to column password of users and api credentials.

Warning

Use it at your own risk.

It’s always recommended to backup your files and your databases and to check your archives regularly so you can roll back if needed.

Troubleshooting

See online issues on the module issues page on GitLab.

License

• Module

This module is published under the CeCILL v2.1 license, compatible with GNU/GPL and approved by FSF and OSI.

This software is governed by the CeCILL license under French law and abiding by the rules of distribution of free software. You can use, modify and/ or redistribute the software under the terms of the CeCILL license as circulated by CEA, CNRS and INRIA at the following URL "http://www.cecill.info".

As a counterpart to the access to the source code and rights to copy, modify and redistribute granted by the license, users are provided only with a limited warranty and the software’s author, the holder of the economic rights, and the successive licensors have only limited liability.

In this respect, the user’s attention is drawn to the risks associated with loading, using, modifying and/or developing or reproducing the software by the user in light of its specific status of free software, that may mean that it is complicated to manipulate, and that also therefore means that it is reserved for developers and experienced professionals having in-depth computer knowledge. Users are therefore encouraged to load and test the software’s suitability as regards their requirements in conditions enabling the security of their systems and/or data to be ensured and, more generally, to use and operate it in the same conditions as regards security.

The fact that you are presently reading this means that you have had knowledge of the CeCILL license and that you accept its terms.

• Library Vrana/Adminer

The library Adminer is released under Apache or GPL v2. Adminer themes are released the same.

Copyright

• Copyright Daniel Berthereau, 2019-2026 (see Daniel-KM on GitLab)

Adminer: Copyright 2007-, Jakub Vrana Copyright 2016-, Aleksey M. (theme)